BuildRangeFromScript

Build a range on a worksheet from the results of a script.

The following overloads are available:

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.
SQLPassthroughDataSet Build a range on the sheet based on a Dodeca SQLPassthroughDataSet.
SQLScript Build a range on the sheet from the results of a SQL query.
URL Loop values returned in XML format from a URL.\n\rNodes named "value" will be used in the loop.

CartesianList

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.
This option is limited one of the following values: <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
ScriptText The text of the script that will be run.\n\r\n\rThe 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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
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> Suppress SuppressAndCenter
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
OutputRangeName The range where the script output is put will be given the specified name.

DataCache

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.
This option is limited one of the following values: <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
DataCacheName The name of the data-cache to build the range from.
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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
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> Suppress SuppressAndCenter
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
OutputRangeName The range where the script output is put will be given the specified name.

DelimitedString

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.
This option is limited one of the following values: <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
ScriptText The text of the script that will be run.\n\r\n\rThe 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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
OutputRangeName The range where the script output is put will be given the specified name.

EssbaseMdxQuery

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.
This option is limited one of the following values: <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
EssbaseScriptID The ID of the Essbase Script that represents the script to run.
ScriptText The text of the script that will be run.
EssbaseConnectionID The Essbase connection ID.
Username The username to use.
Password The password to use.
Dataless 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> FALSE TRUE
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> FALSE TRUE
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.
This option is limited one of the following values: <blank> Name Alias UniqueName
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> FALSE TRUE
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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
OutputRangeName The range where the script output is put will be given the specified name.
OutputMap A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

EssbaseMemberQuery

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.
This option is limited one of the following values: <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
EssbaseScriptID The ID of the Essbase Script that represents the script to run.
ScriptText The text of the script that will be run.
EssbaseConnectionID The Essbase connection ID.
Username The username to use.
Password The password 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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
OutputRangeName The range where the script output is put will be given the specified name.
OutputMap A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

EssbaseReportScript

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.
This option is limited one of the following values: <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
EssbaseScriptID The ID of the Essbase Script that represents the script to run.
ScriptText The text of the script that will be run.
EssbaseConnectionID The Essbase connection ID.
Username The username to use.
Password The password 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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
OutputRangeName The range where the script output is put will be given the specified name.
OutputMap A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

SQLPassthroughDataSet

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.
This option is limited one of the following values: <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
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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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> FALSE TRUE

SQLScript

Build a range on the sheet from the results of a SQL query.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
This option is limited one of the following values: <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
ScriptText The text of the script that will be run.
Username The username to use.
Password The password to use.
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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
OutputRangeName The range where the script output is put will be given the specified name.
OutputMap A string of rows or cols that the columns of the script results are going to be written to. If BuildRowsOrColumns is Rows, then the script result's columns will be written to the specified columns. If BuildRowsOrColumns is Columns, then the result's columns will be written to the specified rows.

URL

Loop values returned in XML format from a URL.\n\rNodes 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.
This option is limited one of the following values: <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
ScriptText The text of the script that will be run.\n\r\n\rThe 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.
This option is limited one of the following values: <blank> Rows Columns
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> FALSE TRUE
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> FALSE TRUE
CopyFromRange The specified range will be copied for each row of output from the script.
CopyToRange Specifies where the CopyFromRange will be copied to.
Insert Whether to insert the value or simply put it in the next cell.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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.