Export the view to an Excel file.
Overload Name | Description |
---|---|
General |
Export the view to an Excel file. The exported file retains the point-of-view, which is used to restore the selected items when the file is imported, using the Import View from Excel tool. For an Essbase Excel view, the cell values within defined send ranges (i.e. Ess.Send.Range.x) are also restored when the file is imported. |
Export the view to an Excel file.
The exported file retains the point-of-view, which is used to restore the selected items when the file is imported, using the Import View from Excel tool.
For an Essbase Excel view, the cell values within defined send ranges (i.e. Ess.Send.Range.x) are also restored when the file is imported.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Filename |
Specify the name of the Excel file. When UseDialog is TRUE, the file name is used as the default file name presented in the Save File dialog. When UseDialog is FALSE, the file name is used as the exported Excel file name. |
Folder |
Specify the folder to save the Excel file to. When UseDialog is TRUE, the folder is used as the default folder presented in the Save File dialog. When UseDialog is FALSE, the folder is used as the location of the exported Excel file. |
IncrementFilename |
Whether to add a subscript, such as (2), to the filename if the specified file already exists. If not set to TRUE, an existing file with the same name will be overwritten. This argument is only applicable when UseDialog is FALSE.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
UseDialog |
Whether to show the Save File dialog to allow the user to select the folder and filename.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
DialogResultPropertyName (7.7) | The name of the script property to hold the FileDialog form result. |
FullFilePathPropertyName (7.7) | The full path of the files that is saved. |
Password |
Each protected worksheet is password protected with the specified value in order to prevent a user from unprotecting the worksheet in the exported Excel file. If no password is specified, the view's ExportToExcelProtectedWorksheetPassword is used as the password. |