Build a range on a worksheet from the results of a script.
| Overload Name | Description |
|---|---|
| CartesianList | Build a range on the sheet based on the cartesian product of values from two or more delimited string lists. |
| DataCache | Build a range on the sheet based on a DataCache created using the AddDataCache method. |
| DelimitedString | Loop a list of values specified by a delimited string. |
| EssbaseMdxQuery | Build a range on the sheet from the results of an Essbase MDX query. |
| EssbaseMemberQuery | Build a range on the sheet from an Essbase member query. |
| EssbaseReportScript | Build a range on the sheet from an Essbase report script. |
| ImportRange (7.7) | Copy a specified range from a BinaryArtifact into the current view. |
| SQLPassthroughDataSet | Build a range on the sheet based on a Dodeca SQLPassthroughDataSet. |
| SQLScript (Hidden in: 8.0.0) |
Build a range on the sheet from the results of a SQL query.
BuildRangeFromScript.SQLScript is no longer supported. |
| URL |
Loop values returned in XML format from a URL. Nodes named "value" will be used in the loop. |
Build a range on the sheet based on the cartesian product of values from two or more delimited string lists.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
| ListDelimiter | The delimiter to use to define the end of each List. |
| Delimiter | The delimiter to use to define the end of each value. |
| StartCell | The address of the cell that the first row of script output goes into. |
| ScriptResultColumnCount | The number of columns that will be in each row of the script result. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| HandleDuplicates |
Whether to suppress a value if it is the same as the value in the row above.
Specify one of the following values or an arbitrary value:
<blank>SuppressSuppressAndCenter
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
Build a range on the sheet based on a DataCache created using the AddDataCache method.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| DataCacheName | The name of the data-cache to build the range from. |
| SortOrder (7.7) |
Specifies one or more columns of the DataCache to sort by. Example: Col1 Example: Col1, Col3 Example: "Col2 DESC, Col1 ASC" |
| StartCell | The address of the cell that the first row of script output goes into. |
| ScriptResultColumnCount | The number of columns that will be in each row of the script result. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| HandleDuplicates |
Whether to suppress a value if it is the same as the value in the row above.
Specify one of the following values or an arbitrary value:
<blank>SuppressSuppressAndCenter
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
Loop a list of values specified by a delimited string.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
| Delimiter | The delimiter to use to define the end of each value. |
| StartCell | The address of the cell that the first row of script output goes into. |
| ScriptResultColumnCount | The number of columns that will be in each row of the script result. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
Build a range on the sheet from the results of an Essbase MDX query.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| EssbaseScriptID (7.3) | The ID of the Essbase Script that represents the script to run. |
| ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
| EssbaseConnectionID | The Essbase connection ID. |
| Username | The username to use. |
| Password | The password of the BinaryArtifact workbook. |
| Dataless (7.2) |
Controls whether the MDX query returns data values along with the members, or members only. By default, Dataless is FALSE; Data values are returned.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| HideRestrictedData |
Controls whether data to which the user has no access is suppressed. By default, HideRestrictedData is TRUE; Restricted data is not returned.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| IdentifierType |
Controls whether member names, aliases, or unique names are returned by the query. The UniqueNames option is applicable when the outline contains duplicate member names. By default, IdentifierType is Name; Member names are returned.
Specify one of the following values or an arbitrary value:
<blank>NameAliasUniqueName
|
| AliasTableName | The name of the alias table from which aliases are obtained. |
| RepeatRowMemberLabels |
Controls whether member names are repeated for each row returned by the query. By default, RepeatMemberLabels is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| StartCell | The address of the cell that the first row of script output goes into. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |
Build a range on the sheet from an Essbase member query.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| EssbaseScriptID (7.3) | The ID of the Essbase Script that represents the script to run. |
| ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
| EssbaseConnectionID | The Essbase connection ID. |
| Username | The username to use. |
| Password | The password of the BinaryArtifact workbook. |
| StartCell | The address of the cell that the first row of script output goes into. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |
Build a range on the sheet from an Essbase report script.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| EssbaseScriptID (7.3) | The ID of the Essbase Script that represents the script to run. |
| ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
| EssbaseConnectionID | The Essbase connection ID. |
| Username | The username to use. |
| Password | The password of the BinaryArtifact workbook. |
| StartCell | The address of the cell that the first row of script output goes into. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |
Copy a specified range from a BinaryArtifact into the current view.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| ID | Specify the ID of the binary artifact. (Required) |
| VersionPolicy |
Determines the Version of the BinaryArtifact to be used. If not specified and the SpecificVersion argument has no value then Latest will be used. Latest = latest version of the Binary Artifact. Specific = specified by the SpecificVersion argument.
Specify one of the following values or an arbitrary value:
LatestNewSpecific
|
| SpecificVersion | The specific version to use for the BinaryArtifact. (ignored if the VersionPolicy argument is not blank or set to Specific) |
| CopyRange | The range from the specified BinaryArtifact that will be copied into the current workbook. |
| PasteRange | The address in the current workbook to copy the CopyRange's cells to. |
| OutputRangeName (8.0) | The range where the script output is put will be given the specified name. |
| InsertPolicy |
Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. Rows = Insert the number of rows in the from-range at the first row of the paste range. Columns = Insert the number of columns in the from-range at the first column of the paste range. RowsAndColumns = Insert both rows and columns. ShiftCellsRight = Shift the cells in the paste range to the right. ShiftCellsDown = Shift the cells in the paste range to down.
Specify one of the following values or an arbitrary value:
<blank>RowsColumnsRowsAndColumnsShiftCellsRightShiftCellsDown
|
| PasteType |
Specifies the type of paste to perform.
Specify one of the following values or an arbitrary value:
<blank>AllColumnWidthsCommentsFormatsFormulasFormulasAndNumberFormatsValidationValuesValuesAndNumberFormats
|
| PasteOperation |
Specifies an operation to perform on the numbers of the copied data (Add, Subtract, Multiply, or Divide).
Specify one of the following values or an arbitrary value:
<blank>NoneAddSubtractMultiplyDivide
|
| CopyColumnWidths |
Whether to copy the column widths of the copy range. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyRowHeights |
Whether to copy the row heights of the copy range. The default is FALSE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SkipBlanks |
If cells in the copy range are empty, then the corresponding cells in the paste range are left unchanged. Defaults to FALSE if left blank. For consistency with the standard paste tool, this value should be set to TRUE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Transpose |
Rows become columns. Columns become rows.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Password | The password of the BinaryArtifact workbook. |
Build a range on the sheet based on a Dodeca SQLPassthroughDataSet.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| DataSetID | The QueryName of the SQLPassthroughDataSet to run. |
| StartCell | The address of the cell that the first row of script output goes into. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |
| ExecuteQueryAsynchronous |
Whether the query is executed asynchronously on a background thread.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
Build a range on the sheet from the results of a SQL query.
BuildRangeFromScript.SQLScript is no longer supported.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
| Username | The username to use. |
| Password | The password of the BinaryArtifact workbook. |
| ServletPath | The servlet-path to use. |
| Driver | The driver to use. |
| SQLConnectString | The SQL connect-string to use. |
| StartCell | The address of the cell that the first row of script output goes into. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |
Loop values returned in XML format from a URL.
Nodes named "value" will be used in the loop.
| 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>SheetNameSheetNumberAllSheets
|
| 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>FALSETRUE
|
| 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>FALSETRUE
|
| ScriptText |
The text of the script that will be run. The script will receive token replacement before being run. |
| StartCell | The address of the cell that the first row of script output goes into. |
| BuildRowsOrColumns |
Whether to build rows or columns from the script results.
Specify one of the following values or an arbitrary value:
<blank>RowsColumns
|
| EnterDatesAsText |
Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnterNumbersAsText |
Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CopyFromRange | The specified range will be copied for each row of output from the script. |
| CopyToRange | Specifies where the CopyFromRange will be copied to. |
| DoInsert (7.7) |
Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Insert (Hidden in: 8.0.0) |
Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value:
The Insert argument has faulty logic. Use the DoInsert argument for correct insert results.
<blank>FALSETRUE
|
| OutputRangeName | The range where the script output is put will be given the specified name. |
| OutputMap |
A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows. |