Add additional dbg info, Doc complete.

Changed variable name in example code, added additional info to Data structure explanation. Final proofread for punctuation and style. Document complete.
This commit is contained in:
Davis Henckel
2021-11-26 14:53:21 -08:00
committed by GitHub
parent 0d4a32e266
commit 5657659331

View File

@@ -1,19 +1,19 @@
# Write to an Existing Excel File
### Enumerate the Excel File
```powershell
$ExcelPkgFile = Open-ExcelPackage -Path "C:\Test\file.xlsx"
$ExcelPkg = Open-ExcelPackage -Path "C:\Test\file.xlsx"
```
Contents of file.xlsx:
![ExcelFileContents](/images/FAQ_Images/ExcelFileContents.png)
### Enumerate the Worksheet to View or Modify the Data
```powershell
$WorkSheet = $ExcelPkgFile.Workbook.Worksheets["sheet1"].Cells #open excel worksheet cells from worksheet "sheet1"
$WorkSheet = $ExcelPkg.Workbook.Worksheets["sheet1"].Cells #open excel worksheet cells from worksheet "sheet1"
```
Visual of Data Structure:
![DataStructureExcelPkg](/images/FAQ_Images/DataStructureExcelPkg.png)
Visual of data structure:
![DataStructureExcelPkg](/images/FAQ_Images/DataStructureExcelPkg.png)
A1 contains "someHeader", A2 contains "data1" etc.
### Modify a Specific Value in a File
Values can be accessed by row, col. Similar to a 2D array.
Values can be accessed by row, column. Similar to a 2D array.
```powershell
$WorkSheet[1,4].Value = "New Column Header" #Starts at index 1 not 0
```
@@ -27,7 +27,7 @@ $ValueAtIndex = $WorkSheet[2,1].Value #Loads the value at row 2, column A
### Save File After Modifying
The changes will not display in the Excel file until Close-ExcelPackage is called.
```powershell
Close-ExcelPackage $ExcelPkgFile #close and save changes made to the Excel file.
Close-ExcelPackage $ExcelPkg #close and save changes made to the Excel file.
```
**Note**: If the file is currently in use, Close-ExcelPackage will return an error and will not save the information.