WBS Documentation, Dodeca 8.2

Methods

AddDataCache

Build a DataCache from the results of a script.

Overloads

Overload Name Description

CartesianList

Build a DataCache based on the cartesian product of values from two or more delimited string lists.

DelimitedString

Build a DataCache from a list of values specified by a delimited string.

EssbaseAncestorsOfMember

Add information about a list of Essbase members, determined by whether they are ancestors of a specified member, to a DataCache.

EssbaseDynamicTimeSeriesMembers

Add information about Essbase dynamic-time-series members to a DataCache.

EssbaseMDXScript

Add the results of an Essbase MDX script to a DataCache.

EssbaseMemberQuery

Add the results of an Essbase member query to a DataCache.

EssbaseMembersFromMemberQueries

Add the results of multiple Essbase member-queries to a DataCache.

EssbaseMembersFromReport

Add information about a list of Essbase members, generated from an Essbase report script, to a DataCache.

EssbaseMembersPerGeneration

Add information about Essbase members of a specified generation to a DataCache.

EssbaseMembersPerLevel

Add information about Essbase members of a specified level to a DataCache.

EssbaseMembersPerRelationship

Add information about a list of Essbase members, determined by their relationship to a specified member, to a DataCache.

EssbaseMembersPerSearch

Add information about a list of Essbase members, determined by a search of the outline, to a DataCache.

EssbaseMembersPerUDA

Add information about a list of Essbase members, determined by whether they have a specified UDA, to a DataCache.

EssbaseMembersSpecified

Add information about a specified list of Essbase members to a DataCache.

EssbaseReportScript

Add the results of an Essbase report script to a DataCache.

SQLPassthroughDataSet

Build a DataCache from a Dodeca SQLPassthroughDataSet.

SQLScript

Add the results of a SQL query to a DataCache.

URL

Build a DataCache from the values returned in XML format from a URL. Specify the URL in the ScriptText argument. The list values will be taken from any nodes named "value" like Single-column: <root><value>Value 1</value><value>Value 2</value><value>Value 3</value></root> Multi-column: <root><value><value>Value 1</value><value>Value 2</value><value>Value 3</value><value>Value 4</value><value>Value 5</value><value>Value 6</value><value>Value 7</value></value><value><value>Value 1</value><value>Value 2</value><value>Value 3</value><value>Value 4</value><value>Value 5</value><value>Value 6</value><value>Value 7</value></value></root>

CartesianList

Build a DataCache 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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe script will receive token replacement before being run.

Shared

Whether to carry the DataCache forward when opening one view from another.

ListDelimiter

The delimiter to use to define the end of each List. The default is ",".

Delimiter

The delimiter to use to define the end of each value. The default is ";".

ScriptResultColumnCount

The number of columns that will be in each row of the script result.

DelimitedString

Build a DataCache from 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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

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. The default is ";".

RowDelimiter

The delimiter to use to determine the end of each row of data.

EssbaseAncestorsOfMember

Add information about a list of Essbase members, determined by whether they are ancestors of a specified member, to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

BaseMember

Member used as the root of the search. Typically, this will be a dimension, but may be any member in the hierarchy.

Descendant

Member name or alias for which to search (including wildcards).

AliasTableName

The Alias table from which alias names are returned.

ReturnType

Specifies what information is retrieved for each member.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseDynamicTimeSeriesMembers

Add information about Essbase dynamic-time-series members to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

AliasTableName

The Alias table from which alias names are returned.

ReturnType

Specifies what information is retrieved for each member.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseMDXScript

Add the results of an Essbase MDX script to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the table will be used to lookup values from it.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

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.

AliasTableName

The Alias table from which alias names are returned.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe script will receive token replacement before being run.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

EssbaseMemberQuery

Add the results of an Essbase member query to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe script will receive token replacement before being run.

EssbaseMembersFromMemberQueries

Add the results of multiple Essbase member-queries to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

Queries

Query strings used to retrieve member information.

AliasTableName

The Alias table from which alias names are returned.

EssbaseMembersFromReport

Add information about a list of Essbase members, generated from an Essbase report script, to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe script will receive token replacement before being run.

AliasTableName

The Alias table from which alias names are returned.

ReturnType

Specifies what information is retrieved for each member.

MaxReturnCount

Override default maximum of 64000.

EssbaseMembersPerGeneration

Add information about Essbase members of a specified generation to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

Dimension

Dimension to search.

GenerationName

Generation name from which to collect members.

GenerationNumber

Generation number from which to collect members.

ReturnType

Specifies what information is retrieved for each member.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseMembersPerLevel

Add information about Essbase members of a specified level to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

Dimension

Dimension to search.

LevelName

Level name from which to collect members.

LevelNumber

Level number from which to collect members.

ReturnType

Specifies what information is retrieved for each member.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseMembersPerRelationship

Add information about a list of Essbase members, determined by their relationship to a specified member, to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

BaseMember

Member used as the root of the search. Typically, this will be a dimension, but may be any member in the hierarchy.

Relationship

Relationship to base member to determine related members.

SearchDimension

Dimension to search - if restricting to a single dimension.

ReturnType

Specifies what information is retrieved for each member.

IncludeMember

Flag indicating whether to include the base member in the returned array.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseMembersPerSearch

Add information about a list of Essbase members, determined by a search of the outline, to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

SearchString

Member name to search for. [ex: "new*" will find "new york", "new hampshire", and "new mexico"]

SearchScope

Indicates whether member and/or alias names are searched.

SearchDimension

Dimension to search - if restricting to a single dimension.

SearchAliasTable

If scope includes alias names, alias table to search.

ReturnType

Specifies what information is retrieved for each member.

ReturnAliasTable

Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseMembersPerUDA

Add information about a list of Essbase members, determined by whether they have a specified UDA, to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

Dimension

Dimension to search.

UDA

Finds members with this user-defined attribute.

UDAValue

Finds members with this value assigned to the user-defined attribute.

ReturnType

Specifies what information is retrieved for each member.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseMembersSpecified

Add information about a specified list of Essbase members to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

Members

Member names used as search criteria, delimited by semicolon.

ReturnType

Specifies what information is retrieved for each member.

AliasTableName

The Alias table from which alias names are returned.

MaxReturnCount

Override default maximum of 64000.

UseXMLCache

Whether to use the cache instead of querying Essbase.

EssbaseReportScript

Add the results of an Essbase report script to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe script will receive token replacement before being run.

SQLPassthroughDataSet

Build a DataCache from a Dodeca SQLPassthroughDataSet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

DataSetID

The QueryName of the SQLPassthroughDataSet to run.

SQLScript

Add the results of a SQL query to a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe script will receive token replacement before being 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.

URL

Build a DataCache from the values returned in XML format from a URL. Specify the URL in the ScriptText argument. The list values will be taken from any nodes named "value" like Single-column: <root><value>Value 1</value><value>Value 2</value><value>Value 3</value></root> Multi-column: <root><value><value>Value 1</value><value>Value 2</value><value>Value 3</value><value>Value 4</value><value>Value 5</value><value>Value 6</value><value>Value 7</value></value><value><value>Value 1</value><value>Value 2</value><value>Value 3</value><value>Value 4</value><value>Value 5</value><value>Value 6</value><value>Value 7</value></value></root>

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the table will be used to lookup values from it.

Initialize

Whether to initiaze the DataCache.

AllowDuplicates

Whether the value of the first column in each row must be unique. If left blank then FALSE will be used.

TrimLeft

Whether to trim whitespace from the left of all values. If blank FALSE will be used.

TrimRight

Whether to trim whitespace from the right of all values. If blank FALSE will be used.

Shared

Whether to carry the DataCache forward when opening one view from another.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe script will receive token replacement before being run.

AddDataTableRangeRows

Adds rows to a DataTableRange’s sheet range.

Overloads

Overload Name Description

RangeAddress

Adds rows to a DataTableRange’s sheet range. The rows are added to the DataTableRange’s sheet range that contains the specified range’s row and column.

RangeName

Adds rows to a DataTableRange’s sheet range.

RangeAddress

Adds rows to a DataTableRange’s sheet range. The rows are added to the DataTableRange’s sheet range that contains the specified range’s row and column.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataTableRangeAddress

The address that is used to identify the DataTableRange whose sheet range the rows are added to. For example, the address of the active cell can be used to identify the selected DataTableRange.

RowCount

The number of rows to add.

RangeName

Adds rows to a DataTableRange’s sheet range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataSetRangeName

The name of the view’s SQLPassthroughDataSetRange that contains the DataTableRange definition.

DataTableRangeName

The name of the DataTableRange whose sheet range the rows are added to.

GroupSheetRangeName

For a DataTableRange that is configured to sort and/or group the DataTable rows, the name of the group’s sheet range to which the rows are added.

RowCount

The number of rows to add.

AddDefinedName

Add a defined name.

Overloads

Overload Name Description

WorkbookRange

Add a defined name to the workbook for a literal (specified string).

WorkbookValue

Add a defined name to the workbook for a value.

WorksheetRange

Add a defined name for a range.

WorksheetValue

Add a defined name for a value.

WorkbookRange

Add a defined name to the workbook for a literal (specified string).

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DefinedName

The new defined name.

RangeAddress

The range to associate with the defined name.

WorkbookValue

Add a defined name to the workbook for a value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DefinedName

The new defined name.

Value

This option allows for a defined name for a value, as opposed to a defined name for a range.

WorksheetRange

Add a defined name for a range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DefinedName

The new defined name.

RangeAddress

The range to associate with the defined name.

WorksheetValue

Add a defined name for a value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DefinedName

The new defined name.

Value

This option allows for a defined name for a value, as opposed to a defined name for a range.

AddProperty

Add a property to the workbook script.

Overloads

Overload Name Description

Boolean

Add a boolean property to the workbook script.

Double

Add a double property to the workbook script.

Integer

Add a integer property to the workbook script.

SpecifyDataType

Add a property of specified data-type to the workbook script.

String

Add a string property to the workbook script.

Boolean

Add a boolean property to the workbook script.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Initialize

Whether to initialize the property. If Initialize is not specified TRUE will be used. If the Property already exists, an Initialize value of TRUE will cause the value of the property to be set to an empty string before the method is executed.

PropertyName

The name of the new property.

Value

The value of the new property.

Shared

Whether to carry the property forward when opening one view from another.

Double

Add a double property to the workbook script.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Initialize

Whether to initialize the property. If Initialize is not specified TRUE will be used. If the Property already exists, an Initialize value of TRUE will cause the value of the property to be set to an empty string before the method is executed.

PropertyName

The name of the new property.

Value

The value of the new property.

Shared

Whether to carry the property forward when opening one view from another.

Integer

Add a integer property to the workbook script.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Initialize

Whether to initialize the property. If Initialize is not specified TRUE will be used. If the Property already exists, an Initialize value of TRUE will cause the value of the property to be set to an empty string before the method is executed.

PropertyName

The name of the new property.

Value

The value of the new property.

Shared

Whether to carry the property forward when opening one view from another.

SpecifyDataType

Add a property of specified data-type to the workbook script.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Initialize

Whether to initialize the property. If Initialize is not specified TRUE will be used. If the Property already exists, an Initialize value of TRUE will cause the value of the property to be set to an empty string before the method is executed.

PropertyName

The name of the new property.

DataType

The data-type of the new property.

Value

The value of the new property.

AppendToValue

For a string property, controls whether to append the Value to the existing property value.

Shared

Whether to carry the property forward when opening one view from another.

String

Add a string property to the workbook script.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Initialize

Whether to initialize the property. If Initialize is not specified TRUE will be used. If the Property already exists, an Initialize value of TRUE will cause the value of the property to be set to an empty string before the method is executed.

PropertyName

The name of the new property.

Value

The value of the new property.

AppendToValue

For a string property, controls whether to append the Value to the existing property value.

Delimiter

When AppendToValue is True, an optional delimiter to use to delimit each appended value.

Shared

Whether to carry the property forward when opening one view from another.

AddToken

Add a token to the workbook script.

Overloads

Overload Name Description

Application

Add an application token to the Dodeca application.

General

Add a temporary token to the Dodeca view.

TargetView

Add a view token to the target view.

View

Add a view token to the Dodeca view.

Application

Add an application token to the Dodeca application.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

TokenName

The name of the new token.

Value

The value of the new token.

SyncTokens

Whether to sync the token table after adding the token. If not specified TRUE will be used.

General

Add a temporary token to the Dodeca view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

TokenName

The name of the new token.

Value

The value of the new token.

TargetView

Add a view token to the target view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

TokenName

The name of the new token.

Value

The value of the new token.

SyncTokens

Whether to sync the token table after adding the token. If not specified TRUE will be used.

View

Add a view token to the Dodeca view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

TokenName

The name of the new token.

Value

The value of the new token.

SyncTokens

Whether to sync the token table after adding the token. If not specified TRUE will be used.

AddTokensForSubstVars

Add tokens for Essbase substitution variables.

Overloads

Overload Name Description

General

Add a token for one or more Essbase substitution variables.

General

Add a token for one or more Essbase substitution variables.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

Username

The username to use.

Password

The password to use.

MatchType

Specify how to match the value entered for SubstitutionVariable.

SubstitutionVariable

The substitution variable name, or a regular expression, depending on the value of MatchType.

Scope

Specifies the scope of the substitution variables for which tokens are added. The default scope is Any, which queries for the most locally scoped variables.

TokenName

The name of the token to create, like [T.Product]. If TokenName contains "<VarName>", like "[T.<VarName>]" then it will be replaced with the name of the substitution variable.

TokenType

Specify whether to create an application or view token.

SyncTokens

Whether to sync the token table after adding the tokens. If not specified TRUE will be used.

AddWorksheet

Add a worksheet to the workbook.

Overloads

Overload Name Description

InPositionByName

Insert a new worksheet at a position specified by sheet name.

InPositionByNumber

Insert a new worksheet at a position specified by sheet number.

ToBeginning

Insert a new worksheet in the position of first sheet.

ToEnd

Add a new worksheet as the last sheet.

InPositionByName

Insert a new worksheet at a position specified by sheet name.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

NewSheetName

The new name of the new sheet.

SheetName

The name of the sheet that is in the position to insert the sheet at.

InPositionByNumber

Insert a new worksheet at a position specified by sheet number.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

NewSheetName

The new name of the new sheet.

SheetNumber

The number position to insert the sheet at.

ToBeginning

Insert a new worksheet in the position of first sheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

NewSheetName

The new name of the new sheet.

ToEnd

Add a new worksheet as the last sheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

NewSheetName

The new name of the new sheet.

AttachmentOperations (8.2)

Operations related to Dodeca Attachments.

Overloads

Overload Name Description

AttachFile

Attaches the specified file.

AttachFileShortcut

Creates a shortcut to the specified file and attaches the shortcut. This would typically be a file on a network drive.

AttachUrlShortcut

Creates a shortcut to the specified Url and attaches the shortcut.

Delete

Deletes one or more attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be deleted. KeyItems will be ignored. If KeyItems is specified more than one attachments may be deleted depending on the number of items that are attached to the intersection specified by the KeyItems. If Name is specified with KeyItems then all attachments at the intersection specified by the KeyItems having the specified name will be deleted.

Export

Exports one or more attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be exported. KeyItems will be ignored. If KeyItems is specified more than one attachments may be exported depending on the number of items that are attached to the intersection specified by the KeyItems. If Name is specified with KeyItems then all attachments at the intersection specified by the KeyItems having the specified name will be exported.

Open

Opens one attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be opened. KeyItems will be ignored. If KeyItems is specified the first attachment that is attached to the intersection specified by the KeyItems will be opened. If Name is specified with KeyItems the first attachment that is attached to the intersection specified by the KeyItems and has the specified name will be opened.

AttachFile

Attaches the specified file.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

The name of the file to attach.

Folder

The path to the folder that contains the specified file.

Description

The description of the new attachment.

IncrementName

Whether to add a subscript, such as (2), to the name of the attachment if the comment being attached to already has an attachment with the same name. If blank TRUE will be used. If FALSE attachments with the same name will be overwritten.

KeyItems

A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as <key>=<value>, where neither <key> nor <value> are blank. The @KeyItems(<Address>) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.

AllowedFileTypes

A semicolon delimited string of file types. ex: ".xlsx;.txt;.docx". Only attachments of the file types specified will be allowed to be attached. If not specified then all types are allowed except for restricted types.

MaximumFileSize

The maximum allowed file size of attachments in KB. If left blank the MaximumFileSize property of the associated CommentRange will be used.

MaximumAttachments

The maximum number of files that can be attached to a comment. If left blank the MaximumAttachments property of the associated CommentRange will be used.

UseDialog

Whether to use a file dialog to specify the file. If left blank FALSE will be used.

DialogTitle

A caption to use at the title of the file dialog.

DialogResultPropertyName

If specified a script property with the specified name will be created with result of the file dialog. The @PVal(<prpoperty-name>) function can be used to get the value.

IdPropertyName

If specified a script property with the specified name will be created with the exported attachmentId. The @PVal(<prpoperty-name>) function can be used to get the value.

FullFilePathPropertyName

If specified a script property with the specified name will be created with full path of the attached file. The @PVal(<prpoperty-name>) function can be used to get the value.

AttachFileShortcut

Creates a shortcut to the specified file and attaches the shortcut. This would typically be a file on a network drive.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

The name of the file to attach.

Folder

The path to the folder that contains the specified file.

Description

The description of the new attachment.

IncrementName

Whether to add a subscript, such as (2), to the name of the attachment if the comment being attached to already has an attachment with the same name. If blank TRUE will be used. If FALSE attachments with the same name will be overwritten.

KeyItems

A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as <key>=<value>, where neither <key> nor <value> are blank. The @KeyItems(<Address>) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.

AllowedFileTypes

A semicolon delimited string of file types. ex: ".xlsx;.txt;.docx". Only attachments of the file types specified will be allowed to be attached. If not specified then all types are allowed except for restricted types.

MaximumAttachments

The maximum number of files that can be attached to a comment. If left blank the MaximumAttachments property of the associated CommentRange will be used.

UseDialog

Whether to use a file dialog to specify the file. If left blank FALSE will be used.

DialogTitle

A caption to use at the title of the file dialog.

DialogResultPropertyName

If specified a script property with the specified name will be created with result of the file dialog. The @PVal(<prpoperty-name>) function can be used to get the value.

IdPropertyName

If specified a script property with the specified name will be created with the exported attachmentId. The @PVal(<prpoperty-name>) function can be used to get the value.

FullFilePathPropertyName

If specified a script property with the specified name will be created with full path of the attached file. The @PVal(<prpoperty-name>) function can be used to get the value.

AttachUrlShortcut

Creates a shortcut to the specified Url and attaches the shortcut.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

URL

The URL to create the shortcut for.

Name

The name of the attachment.

Description

The description of the new attachment.

IncrementName

Whether to add a subscript, such as (2), to the name of the attachment if the comment being attached to already has an attachment with the same name. If blank TRUE will be used. If FALSE attachments with the same name will be overwritten.

KeyItems

A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as <key>=<value>, where neither <key> nor <value> are blank. The @KeyItems(<Address>) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.

MaximumAttachments

The maximum number of files that can be attached to a comment. If left blank the MaximumAttachments property of the associated CommentRange will be used.

UseDialog

Whether to use a file dialog to specify the file. If left blank FALSE will be used.

DialogTitle

A caption to use at the title of the file dialog.

DialogResultPropertyName

If specified a script property with the specified name will be created with result of the file dialog. The @PVal(<prpoperty-name>) function can be used to get the value.

UrlPropertyName

If specified a script property with the specified name will be created with a value of the new attachment’s URL. The @PVal(<prpoperty-name>) function can be used to get the value.

NamePropertyName

If specified a script property with the specified name will be created with a value of the name of the attachment that was opened. The @PVal(<prpoperty-name>) function can be used to get the value.

DescriptionPropertyName

If specified a script property with the specified name will be created with a value of the new attachment’s Description. The @PVal(<prpoperty-name>) function can be used to get the value.

IdPropertyName

If specified a script property with the specified name will be created with the exported attachmentId. The @PVal(<prpoperty-name>) function can be used to get the value.

Delete

Deletes one or more attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be deleted. KeyItems will be ignored. If KeyItems is specified more than one attachments may be deleted depending on the number of items that are attached to the intersection specified by the KeyItems. If Name is specified with KeyItems then all attachments at the intersection specified by the KeyItems having the specified name will be deleted.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

AttachmentID

The AttachmentID.

Name

The name of the attachment.

KeyItems

A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as <key>=<value>, where neither <key> nor <value> are blank. The @KeyItems(<Address>) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.

CountPropertyName

If specified a script property with the specified name will be created with count of the exported attachments. The @PVal(<prpoperty-name>) function can be used to get the value.

IdListPropertyName

If specified a script property with the specified name will be created with a semicolon delimited list of the effected attachment IDs.

Export

Exports one or more attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be exported. KeyItems will be ignored. If KeyItems is specified more than one attachments may be exported depending on the number of items that are attached to the intersection specified by the KeyItems. If Name is specified with KeyItems then all attachments at the intersection specified by the KeyItems having the specified name will be exported.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

AttachmentID

The AttachmentID.

Name

The name of the attachment.

KeyItems

A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as <key>=<value>, where neither <key> nor <value> are blank. The @KeyItems(<Address>) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.

Folder

The path to the folder that contains the specified file.

FileExistsPolicy

Determines what to do if there is an existing file with the same name. If not specified Increment will be used. Increment = Add a sequence number to the file name like "FileName(1).txt". Overwrite = Overwrite the existing file. PromptForName = Prompt the user for a unique name. PromptForOverwrite = Prompt the user for whether to overwrite the file. SkipSilent = Do not export. SkipWithMessage = Prompt user with message that file was not exported.

UseDialog

Whether to use a file dialog to specify the file. If left blank FALSE will be used.

DialogTitle

A caption to use at the title of the file dialog.

DialogResultPropertyName

If specified a script property with the specified name will be created with result of the file dialog. The @PVal(<prpoperty-name>) function can be used to get the value.

CountPropertyName

If specified a script property with the specified name will be created with count of the exported attachments. The @PVal(<prpoperty-name>) function can be used to get the value.

FolderPropertyName

If specified a script property with the specified name will be created with the path of the output folder.

FilePathsListPropertyName

If specified a script property with the specified name will be created with a semicolon delimited list of the full paths of each exported file. The @PVal(<prpoperty-name>) function can be used to get the value.

IdListPropertyName

If specified a script property with the specified name will be created with a semicolon delimited list of the effected attachment IDs.

NamesListPropertyName

If specified a script property with the specified name will be created with a semicolon delimited list of the exported attachment names. The @PVal(<prpoperty-name>) function can be used to get the value.

Open

Opens one attachments. AttachmentID or KeyItems must be specified. If AttachmentID is specified one attachment may be opened. KeyItems will be ignored. If KeyItems is specified the first attachment that is attached to the intersection specified by the KeyItems will be opened. If Name is specified with KeyItems the first attachment that is attached to the intersection specified by the KeyItems and has the specified name will be opened.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

AttachmentID

The AttachmentID.

Name

The name of the attachment.

KeyItems

A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as <key>=<value>, where neither <key> nor <value> are blank. The @KeyItems(<Address>) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.

Folder

The path to the folder that contains the specified file.

FileExistsPolicy

Determines what to do if there is an existing file with the same name. If not specified Increment will be used. Increment = Add a sequence number to the file name like "FileName(1).txt". Overwrite = Overwrite the existing file. PromptForName = Prompt the user for a unique name. PromptForOverwrite = Prompt the user for whether to overwrite the file. SkipSilent = Do not export. SkipWithMessage = Prompt user with message that file was not exported.

UseDialog

Whether to use a file dialog to specify the file. If left blank FALSE will be used.

DialogTitle

A caption to use at the title of the file dialog.

DialogResultPropertyName

If specified a script property with the specified name will be created with result of the file dialog. The @PVal(<prpoperty-name>) function can be used to get the value.

FolderPropertyName

If specified a script property with the specified name will be created with the path of the output folder.

FullFilePathPropertyName

If specified a script property with the specified name will be created with full path of the attached file. The @PVal(<prpoperty-name>) function can be used to get the value.

NamePropertyName

If specified a script property with the specified name will be created with a value of the name of the attachment that was opened. The @PVal(<prpoperty-name>) function can be used to get the value.

IdPropertyName

If specified a script property with the specified name will be created with the exported attachmentId. The @PVal(<prpoperty-name>) function can be used to get the value.

BinaryArtifactOperations (7.7)

Use this method to Create, Update, Delete, Import from binary artifacts

Overloads

Overload Name Description

AddSheet

Add a worksheet from the current view to a specified BinaryArtifact.

AddWorkbook

Add all worksheets from the current view to a specified BinaryArtifact

CreateFromFile

Create a BinaryArtifact from a file.

CreateFromSheet

Create a BinaryArtifact from a specified worksheet of the current view.

CreateFromWorkbook

Create a BinaryArtifact from the workbook of the current view.

Delete

Delete a specified BinaryArtifact.

ImportRange

Copy a specified range from a BinaryArtifact into the current view.

ImportSheet

Import a specified worksheet from a BinaryArtifact into the current view.

ImportWorkbook

Import all sheets from a specified BinaryArtifact into the current view.

AddSheet

Add a worksheet from the current view to a specified BinaryArtifact.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SheetName

Specify the binary artifact sheet-name.

NewSheetName

If not blank the loaded sheet will be named per the specified NewSheetName.

ID

Specify the ID of the binary artifact. (Required)

VersionPolicy

Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.

SpecificVersion

The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific)

ValuesOnly

Whether to replace cell formulas with cell values. Default is FALSE.

ToPositionPolicy

Select how to specify where to copy the worksheet to. If left blank "Last" will be used.

ToPosition

If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number.

Password

The password assigned to the saved workbook.

AddWorkbook

Add all worksheets from the current view to a specified BinaryArtifact

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ID

Specify the ID of the binary artifact. (Required)

VersionPolicy

Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.

SpecificVersion

The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific)

ValuesOnly

Whether to replace cell formulas with cell values. Default is FALSE.

ToPositionPolicy

Select how to specify where to copy the worksheet to. If left blank "Last" will be used.

ToPosition

If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number.

Password

The password assigned to the saved workbook.

CreateFromFile

Create a BinaryArtifact from a file.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Type

Specify the BinaryArtifact type. If left blank Excel will be used for Excel file types. Otherwise Other will be used.

Other: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension.

ID

Specify the ID of the binary artifact. (Required)

Name

Specify the name of the binary artifact.

Description

Specify the description for the binary artifact.

VersionPolicy

Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.

SpecificVersion

The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific)

Filename

Specify the Filename of the binary artifact. When creating a BinaryArtifact, if Filename is left blank the BinaryArtifact’s ID will be used.

Folder

Specify the full path to the folder that contains the file.

ValuesOnly

Whether to replace cell formulas with cell values. Default is FALSE.

Password

The password assigned to the saved workbook.

CreateFromSheet

Create a BinaryArtifact from a specified worksheet of the current view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SheetName

Specify the binary artifact sheet-name.

Type

Specify the BinaryArtifact type. If left blank Excel will be used for Excel file types. Otherwise Other will be used.

Other: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension.

ID

Specify the ID of the binary artifact. (Required)

Name

Specify the name of the binary artifact.

Description

Specify the description for the binary artifact.

VersionPolicy

Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.

SpecificVersion

The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific)

ValuesOnly

Whether to replace cell formulas with cell values. Default is FALSE.

Filename

Specify the Filename of the binary artifact. When creating a BinaryArtifact, if Filename is left blank the BinaryArtifact’s ID will be used.

FileType

Specify the file type of saved workbook. Defaults to the current view’s file type if not specified.

CSV: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel8: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension. OpenXMLWorkbook: Specifies the Excel 2007-2016 Open XML file format. Typically saved with the .xlsx filename extension. OpenXMLWorkbookMacroEnabled: Specifies the Excel 2007-2016 macro enabled Open XML file format. Typically saved with the .xlsm filename extension. UnicodeText: Specifies a tab-delimited Unicode text file encoded as UTF-8. Typically saved with the .txt filename extension.

Password

The password assigned to the saved workbook.

CreateFromWorkbook

Create a BinaryArtifact from the workbook of the current view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Type

Specify the BinaryArtifact type. If left blank Excel will be used for Excel file types. Otherwise Other will be used.

Other: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension.

ID

Specify the ID of the binary artifact. (Required)

Name

Specify the name of the binary artifact.

Description

Specify the description for the binary artifact.

VersionPolicy

Determines the Version to be used in saving the BinaryArtifact. If not specified and the SpecificVersion argument has no value then New will be used. Latest = latest version of the Binary Artifact. New = latest version of the Binary Artifact + 1. Specific = specified by the SpecificVersion argument.

SpecificVersion

The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific)

ValuesOnly

Whether to replace cell formulas with cell values. Default is FALSE.

Filename

Specify the Filename of the binary artifact. When creating a BinaryArtifact, if Filename is left blank the BinaryArtifact’s ID will be used.

FileType

Specify the file type of saved workbook. Defaults to the current view’s file type if not specified.

CSV: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel8: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension. OpenXMLWorkbook: Specifies the Excel 2007-2016 Open XML file format. Typically saved with the .xlsx filename extension. OpenXMLWorkbookMacroEnabled: Specifies the Excel 2007-2016 macro enabled Open XML file format. Typically saved with the .xlsm filename extension. UnicodeText: Specifies a tab-delimited Unicode text file encoded as UTF-8. Typically saved with the .txt filename extension.

Password

The password assigned to the saved workbook.

Delete

Delete a specified BinaryArtifact.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ID

Specify the ID of the binary artifact. (Required)

DeleteVersionPolicy

Determines the Version of the BinaryArtifact to be deleted. If not specified and the SpecificVersion argument has no value then Latest will be used. All = all versions of the Binary Artifact. Latest = latest version of the Binary Artifact. Specific = specified by the SpecificVersion argument.

SpecificVersion

The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific)

ImportRange

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ID

Specify the ID of the binary artifact. (Required)

ImportVersionPolicy

Determines the BinaryArtifact version to be imported from. 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.

SpecificVersion

The specific version to use for the Binary Artifact. (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

The range where the range is imported to 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. <blank> = 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.

PasteType

Specifies the type of paste to perform.

PasteOperation

Specifies an operation to perform on the numbers of the copied data (Add, Subtract, Multiply, or Divide).

CopyColumnWidths

Whether to copy the column widths of the copy range.

CopyRowHeights

Whether to copy the row heights of the copy range.

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.

Transpose

Rows become columns. Columns become rows.

Password

The password assigned to the saved workbook.

ImportSheet

Import a specified worksheet from a BinaryArtifact into the current view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ID

Specify the ID of the binary artifact. (Required)

ImportVersionPolicy

Determines the BinaryArtifact version to be imported from. 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.

SpecificVersion

The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific)

ValuesOnly

Whether to replace cell formulas with cell values. Default is FALSE.

SheetName

Specify the binary artifact sheet-name.

NewSheetName

If not blank the loaded sheet will be named per the specified NewSheetName.

ToPositionPolicy

Select how to specify where to copy the worksheet to. If left blank "Last" will be used.

ToPosition

If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number.

Password

The password assigned to the saved workbook.

ImportWorkbook

Import all sheets from a specified BinaryArtifact into the current view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ID

Specify the ID of the binary artifact. (Required)

ImportVersionPolicy

Determines the BinaryArtifact version to be imported from. 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.

SpecificVersion

The specific version to use for the Binary Artifact. (ignored if the VersionPolicy argument is not blank or set to Specific)

ToPositionPolicy

Select how to specify where to copy the worksheet to. If left blank "Last" will be used.

ToPosition

If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number.

Password

The password assigned to the saved workbook.

BuildDataSetRange

Builds a SQLPassthroughDataSetRange.

Overloads

Overload Name Description

General

Builds a SQLPassthroughDataSetRange.

General

Builds a SQLPassthroughDataSetRange.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataSetRangeName

The name of the view’s SQLPassthroughDataSetRange to build.

CoverDuringBuild

Controls whether the view is covered while the build is running.

BuildRangeFromScript

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

Overloads

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

Copy a specified range from a BinaryArtifact into the current view.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

HandleDuplicates

Whether to suppress a value if it is the same as the value in the row above.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the data-cache to build the range from.

SortOrder

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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

HandleDuplicates

Whether to suppress a value if it is the same as the value in the row above.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe 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

Controls whether the MDX query returns data values along with the members, or members only. By default, Dataless is FALSE; Data values are returned.

HideRestrictedData

Controls whether data to which the user has no access is suppressed. By default, HideRestrictedData is TRUE; Restricted data is not returned.

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.

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.

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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe 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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseScriptID

The ID of the Essbase Script that represents the script to run.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe 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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

ImportRange

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

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.

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

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. <blank> = 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.

PasteType

Specifies the type of paste to perform.

PasteOperation

Specifies an operation to perform on the numbers of the copied data (Add, Subtract, Multiply, or Divide).

CopyColumnWidths

Whether to copy the column widths of the copy range. The default is FALSE.

CopyRowHeights

Whether to copy the row heights of the copy range. The default is FALSE.

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.

Transpose

Rows become columns. Columns become rows.

Password

The password of the BinaryArtifact workbook.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ScriptText

The text of the script that will be run.\\n\\r\\n\\rThe 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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

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.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

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.

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.

EnterNumbersAsText

Whether to put a quote on numeric values so that the grid interprets them as text. By default, EnterNumbersAsText is False.

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

Whether to insert the value or simply put it in the next cell. ---DoInsert overrides the Insert Argument.---

Insert

Whether to insert the value or simply put it in the next cell.

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.

BuildView

Build the view.

Overloads

Overload Name Description

General

Build the view.

General

Build the view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CoverDuringBuild

Controls whether the view is covered during the build.

Calculate

Calculates Excel formulas in the workbook.

Overloads

Overload Name Description

AllWorkbooksAsNeeded

Calculates formulas in all workbooks as needed. Volatile formulas and formulas involved in circular references are always calculated.

AllWorkbooksFull

Calculates all formulas in all workbooks.

AllWorkbooksAsNeeded

Calculates formulas in all workbooks as needed. Volatile formulas and formulas involved in circular references are always calculated.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

AllWorkbooksFull

Calculates all formulas in all workbooks.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CallWebService

Makes an HTTP web request.

Overloads

Overload Name Description

General

RESTRequest

Makes an HTTP web request to a REST web service.

General

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CredentialsPolicy

Controls the credentials used for authentication. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified UserName, Password, and Domain.

UserName

The user name associated with the credentials to be used for authentication."

Password

The password associated with the credentials to be used for authentication.

Domain

If needed, the domain associated with the credentials to be used for authentication.

EndPoint

The URI to which the request is posted.

SOAPAction

If required by the web service, the SOAPAction HTTP request header field value.

RequestXml

The XML posted to the web service.

RequestTimeout

The number of milliseconds allowed to elapse before the request is timed out. The default value of 0 indicates that no timeout is enforced.

ResponseXmlPropertyName

(Optional) The name of the workbook script property that receives the response XML returned by the web service.

ErrorMessagePropertyName

(Optional) The name of the workbook script property that receives the error message if the request fails.

BackgroundExecute

Controls whether the request is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the request is processed. By default, the view is not covered.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the web service is called. If no value is specified, "CallWebService started" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the response is received. If no value is specified, "CallWebService completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the request failed. If no value is specified, "CallWebService failed" is displayed as the progress text.

SaveRequestXmlToFilename

(Optional) The name of the file, including the path, to which the request XML is saved on the client. The argument is intended for use during development for debugging purposes.

SaveResponseXmlToFilename

(Optional) The name of the file, including the path, to which the response XML is saved on the client. The argument is intended for use during development for debugging purposes.

RESTRequest

Makes an HTTP web request to a REST web service.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

RequestMethod

The method of the request to the REST web service.

RequestHeaders

(Optional) A new-line delimited list of custom headers to send with the specified request. This property can be left blank to use the default request headers.

RequestPostData

The data posted by the request when using the POST, PUT, or PATCH RequestMethod.

RequestPostDataContentType

(Optional) The content-type of the data posted by the request when using the POST, PUT, or PATCH RequestMethod. This property can be left blank to leave the content-type unspecified.

RequestURL

The URL of the REST web service.

RequestTimeout

The number of milliseconds allowed to elapse before the request is timed out. The default value of 0 indicates that no timeout is enforced.

ResponsePropertyName

(Optional) The name of the workbook script property that receives the response returned by the REST web service.

ResponseHeadersPropertyName

(Optional) The name of the workbook script property that receives the response headers returned by the REST web service.

ResponseCodePropertyName

(Optional) The name of the workbook script property that receives the response status code returned by the REST web service.

ErrorMessagePropertyName

(Optional) The name of the workbook script property that receives the error message if the request fails.

CookieCollectionPropertyName

(Optional) The name of the workbook script property that sets and receives the cookies used by the web service.

FollowRedirects

(Optional) Specifies whether to follow redirects issued by the web service. The default value is TRUE.

BackgroundExecute

Controls whether the request is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the request is processed. By default, the view is not covered.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the web service is called. If no value is specified, "CallWebService started" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the response is received. If no value is specified, "CallWebService completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the request failed. If no value is specified, "CallWebService failed" is displayed as the progress text.

SaveResponseToFilename

(Optional) The name of the file, including the path, to which the response is saved on the client. The argument is intended for use during development for debugging purposes.

CancelEvent

Set the value of the event that is running the procedure.

Overloads

Overload Name Description

General

Set the Cancel property of the event that called the procedure. Not all events are cancelable.

General

Set the Cancel property of the event that called the procedure. Not all events are cancelable.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Cancel

A value of true will cancel the event that called the procedure. It will not stop the execution of the procedure.

OnCancelProcedure

The name of the procedure to execute if Cancel gets set to True.

ClearRange

Clear a specified range in the workbook.

Overloads

Overload Name Description

General

Clear All, Excel Comments, Contents, or Formats from a specified range.

General

Clear All, Excel Comments, Contents, or Formats from a specified range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Clear

Whether to clear All, Contents, Formats, or Excel Comments.

Close

Closes the view.

Overloads

Overload Name Description

General

Closes the view.

General

Closes the view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Close

Determines whether the view is closed.

CloseApplication

Closes the application.

Overloads

Overload Name Description

General

Closes the application.

General

Closes the application.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Close

Controls whether the application is closed.

CommentOperations (8.0)

Operations related to Dodeca Comments.

Overloads

Overload Name Description

Add

Add a Dodeca comment.

Copy

Copies comments from one or more sets of intersections to one or more other sets of intersections.

DeleteByCommentID

Delete the Dodeca comment that has the specified CommentID.

DeleteByKeyHash

Delete all Dodeca comments that have the specified KeyHash.

DeleteByKeyItems

Delete all Dodeca comments that have the specified KeyItems.

Load

Load comments for the specified worksheet(s).

Save

Save the view’s Dodeca comments.

Add

Add a Dodeca comment.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CommentText

The text of the new comment.

KeyItems

A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as <key>=<value>, where neither <key> nor <value> are blank. The @KeyItems(<Address>) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.

Context

The Context of the Comment.

Subject

The Subject of the comment.

ParentCommentID

The ID of the comment’s parent comment. This would be used if the comment is a response to another.

NewCommentIdPropertyName

The name of a script property which will be set to the ID of the comment.

NewKeyHashPropertyName

The name of a script property which will be set to the KeyHash of the comment.

Copy

Copies comments from one or more sets of intersections to one or more other sets of intersections.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Source

The set of key/value pairs that defines the filter for the source intersections from which comments will be copied. The source is expressed as key/value pairs, in the form of Key=Value, where the pairs are separated by a semi-colon character. Multiple sets of key/value pairs may be passed using a pipe delimiter to separate different sets.

Example: Scenario=Budget;Year=Jan

Scenario=Budget;Year=Feb

Note: The number of key/value pairs and the number of sets much exactly match the number of key/value pairs and the number of sets passed in the Target argument.

Target

The set of key/value pairs that defines the filter for the target intersections where comments will be copied. The target is expressed as key/value pairs, in the form of Key=Value, where the pairs are separated by a semi-colon character. Multiple sets of key/value pairs may be passed using a pipe delimiter to separate different sets.

Example: Scenario=Forecast;Year=Jan

Scenario=Forecast;Year=Feb

Note: The number of key/value pairs and the number of sets much exactly match the number of key/value pairs and the number of sets passed in the Source argument.

BackgroundExecute

Controls whether the method is executed asynchronous.

DeleteByCommentID

Delete the Dodeca comment that has the specified CommentID.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CommentID

The ID of the comment.

DeletedCountPropertyName

The name of a script property which will be set to the count of deleted comments.

DeleteByKeyHash

Delete all Dodeca comments that have the specified KeyHash.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

KeyHash

The KeyHash to match for comments. The KeyHash represents a specific set a KeyItems. All comments with the specified KeyHash will be impacted.

DeletedCountPropertyName

The name of a script property which will be set to the count of deleted comments.

DeleteByKeyItems

Delete all Dodeca comments that have the specified KeyItems.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

KeyItems

A semicolon delimited list of key-value pairs such as "Year=Jan;Market=East;Scenario=Budget". Each key item must be expressed as <key>=<value>, where neither <key> nor <value> are blank. The @KeyItems(<Address>) function can be used to specify the KeyItems of a specific cell. If KeyItems is blank the KeyItems of the active cell (if any) will be used.

MatchAny

If FALSE, then comments that have all of and ONLY the specified KeyItems will be matched. SPECIFYING TRUE IS DANGEROUS. If TRUE, then comments that have all of the specified KeyItems will be matched, even though they may also have other KeyItems as well.

DeletedCountPropertyName

The name of a script property which will be set to the count of deleted comments.

Load

Load comments for the specified worksheet(s).

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Save

Save the view’s Dodeca comments.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CopyComments

Copies comments from one or more sets of intersections to one or more other sets of intersections.

Overloads

Overload Name Description

General

Copies comments from one or more sets of intersections to one or more other sets of intersections.

General

Copies comments from one or more sets of intersections to one or more other sets of intersections.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Source

The set of key/value pairs that defines the filter for the source intersections from which comments will be copied. The source is expressed as key/value pairs, in the form of Key=Value, where the pairs are separated by a semi-colon character. Multiple sets of key/value pairs may be passed using a pipe delimiter to separate different sets.

Example: Scenario=Budget;Year=Jan

Scenario=Budget;Year=Feb

Note: The number of key/value pairs and the number of sets much exactly match the number of key/value pairs and the number of sets passed in the Target argument.

Target

The set of key/value pairs that defines the filter for the target intersections where comments will be copied. The target is expressed as key/value pairs, in the form of Key=Value, where the pairs are separated by a semi-colon character. Multiple sets of key/value pairs may be passed using a pipe delimiter to separate different sets.

Example: Scenario=Forecast;Year=Jan

Scenario=Forecast;Year=Feb

Note: The number of key/value pairs and the number of sets much exactly match the number of key/value pairs and the number of sets passed in the Source argument.

BackgroundExecute

Controls whether the method is executed asynchronous.

CopyFromBinaryArtifact (7.3)

Copy from a specifed Excel Binary Artifact.

Overloads

Overload Name Description

Range

Copy a range and specify the paste options.

Sheet

Copy a worksheet.

Range

Copy a range and specify the paste options.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

BinaryArtifactID

The ID of the source Excel Binary Artifact.

VersionPolicy

Determines the version to be used. If not specified and the BinaryArtifactVersion argument has no value, then Latest will be used. Latest = latest version of the Binary Artifact Specific = specified by the BinaryArtifactVersion argument

BinaryArtifactVersion

The version of the source Excel Binary Artifact. Leave blank to always use the most recent version.

Password

If the copy-from workbook is password-protected, specifies the password assigned to the workbook. NOTE: The password is currently only supported for XLS files that are saved from Excel 2010.

CopyRange

The address of the range to copy from.

PasteRange

The address of the range to paste into.

OutputRangeName

The range where the range is imported to 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. <blank> = 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.

PasteType

Specifies the type of copy to perform.

PasteOperation

Specifies an operation to perform on the numbers of the copied data (Add, Subtract, Multiply, or Divide).

CopyColumnWidths

Whether to copy the column widths of the copy range.

CopyRowHeights

Whether to copy the row heights of the copy range.

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.

Transpose

Rows become columns. Columns become rows.

Sheet

Copy a worksheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

BinaryArtifactID

The ID of the source Excel Binary Artifact.

BinaryArtifactVersion

The version of the source Excel Binary Artifact. Leave blank to always use the most recent version.

Password

If the copy-from workbook is password-protected, specifies the password assigned to the workbook. NOTE: The password is currently only supported for XLS files that are saved from Excel 2010.

SpecifyFromBy

Select how to specify which worksheet to copy.

FromSheetSpec

Specify the sheet-name or sheet-number, depending on SpecifyFromBy.

SpecifyToPosition

Select how to specify where to copy the worksheet to.

ToPosition

If SpecifyToPosition is ToPositionOfSheetNamed then enter a sheet name. If SpecifyToPosition is ToPositionNumber then enter a number.

NewSheetName

The name of the new sheet.

CopyRange

Copy a specifed range in the workbook.

Overloads

Overload Name Description

ColumnWidth

Copy the column widths of a specified range.

FromFile

Copy a specified range from an Excel or delimited file into the current view.

General

Copy a specified range.

RowHeight

Copy the row heights a specified range.

Specify

Copy a range and specify the paste options.

ToClipboardAsImage

Copy a specified workbook range to the clipboard as an image.

ToFileAsImage

Copy a specified workbook range to an image file.

ColumnWidth

Copy the column widths of a specified range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

FromFile

Copy a specified range from an Excel or delimited file into the current view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the file to copy from.

Folder

Specify the full path to the folder to put the file in. If left blank the Desktop folder will be used.

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

OutputRangeName

The range where the range is imported to 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. <blank> = 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.

PasteType

Specifies the type of copy to perform.

PasteOperation

Specifies an operation to perform on the numbers of the copied data (Add, Subtract, Multiply, or Divide).

CopyColumnWidths

Whether to copy the column widths of the copy range. If left blank TRUE will be used.

CopyRowHeights

Whether to copy the row heights of the copy range. If left blank TRUE will be used.

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.

Transpose

Rows become columns. Columns become rows.

Password

If the copy-from workbook is password-protected, specifies the password assigned to the workbook. NOTE: The password is currently only supported for XLS files that are saved from Excel 2010.

General

Copy a specified range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

Cut

If true the values of the cells copied from will be cleared.

InsertPolicy

Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. <blank> = 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.

RowHeight

Copy the row heights a specified range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

Specify

Copy a range and specify the paste options.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

Cut

If true the values of the cells copied from will be cleared.

InsertPolicy

Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. <blank> = 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.

PasteType

Specifies the type of copy to perform.

PasteOperation

Specifies an operation to perform on the numbers of the copied data (Add, Subtract, Multiply, or Divide).

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.

Transpose

Rows become columns. Columns become rows.

ToClipboardAsImage

Copy a specified workbook range to the clipboard as an image.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CopyRange

The address of the range to copy.

ScalePercent

Scale the image with a value between 10 and 400. If left blank 100 will be used.

ToFileAsImage

Copy a specified workbook range to an image file.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CopyRange

The address of the range to copy.

ScalePercent

Scale the image with a value between 10 and 400. If left blank 100 will be used.

ImageFormat

The format of the image file (If left blank Bmp will be used.): Bmp Bitmap Emf Enhanced metafile Exif Exchangeable Image File Gif Graphics Interchange Format Icon Windows icon Jpeg Joint Photographic Experts Group Png W3C Portable Network Graphics Tiff Tagged Image File Format Wmf Windows metafile

ImageFilename

Specify the name of the file image file.

Folder

Specify the full path to the folder to put the file in. If left blank the Desktop folder will be used.

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.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the file that is saved.

CopyWorksheet

Copy a specified worksheet in the workbook.

Overloads

Overload Name Description

FromFile

Copy a specified worksheet from an Excel file into the current view.

General

Copy a worksheet.

FromFile

Copy a specified worksheet from an Excel file into the current view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the file to copy from.

Folder

Specify the full path to the folder that contains the file.

ValuesOnly

Whether to replace cell formulas with cell values. If left blank FALSE will be used.

SheetName

Specify the name of the sheet to copy.

NewSheetName

The name of the new sheet.

ToPositionPolicy

Select how to specify where to copy the worksheet to. If left blank "Last" will be used.

ToPosition

If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number.

Password

The password assigned to the saved workbook.

General

Copy a worksheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FromWorkbook

The name of the workbook to copy the sheet from. Leave blank to copy from current workbook.

SpecifyFromBy

Select how to specify which worksheet to copy. If left blank SheetNumber will be used.

FromSheetSpec

Specify the sheet-name or sheet-number, depending on SpecifyFromBy.

SpecifyToPosition

Select how to specify where to copy the worksheet to. If left blank "Last" will be used.

ToPosition

If ToPositionPolicy is ToPositionOfSheetNamed then enter a sheet name. If ToPositionPolicy is ToPositionNumber then enter a number.

NewSheetName

The name of the new sheet.

DeleteBinaryArtifact (7.2)

Delete a specified binary artifact or binary artifact version.

Overloads

Overload Name Description

General

Delete a specified binary artifact or binary artifact version.

General

Delete a specified binary artifact or binary artifact version.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

BinaryArtifactID

The ID of the binary artifact to delete.

DeletionPolicy

Specifies whether to delete all versions, the latest version, or a specific version of the binary artifact specified by the SpecificVersion argument.

SpecificVersion

The version of the binary artifact to delete when the DeletionPolicy argument is set to SpecificVersion.

DeleteBreak (7.2)

Deletes a page break or breaks from one or all sheets.

Overloads

Overload Name Description

All

Deletes all page breaks from the sheet.

General

Deletes a page break or breaks from the sheet.

All

Deletes all page breaks from the sheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

General

Deletes a page break or breaks from the sheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DeleteBreakAddress

The address used to identify the address the break or breaks are deleted from.

DeleteDataTableRangeRows

Deletes rows from a DataTableRange’s sheet range.

Overloads

Overload Name Description

General

Deletes rows from a DataTableRange’s sheet range.

General

Deletes rows from a DataTableRange’s sheet range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

RowsAddress

The address used to identify the rows within a DataTableRange’s sheet range that are deleted. For example, the address of the selected range can be used to delete a DataTableRange’s rows.

DeleteFile (7.2)

Deletes a specified file.

Overloads

Overload Name Description

General

Deletes a specified file.

General

Deletes a specified file.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the file to delete.

Folder

Specify the folder from which to delete the file. Defaults to the user home directory if left blank.

DeleteRange

Delete cells from one or all sheets.

Overloads

Overload Name Description

General

Delete cells.

General

Delete cells.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DeleteRange

The address of the cells to delete.

ShiftDirection

The shift mode for the delete. Warning: ShiftEntireRow and ShiftEntireColumn do not work correctly. Use ShiftEntireRowExcel and ShiftEntireColumnExcel to get the correct result. ShiftEntireColumn performs the same as ShiftLeft (incorrect). ShiftEntireRow performs the same as ShiftUp (incorrect).

Using ShiftLeft will move the cells to the right of any cells in the specified range to the left. Using ShiftUp will move the cells below of any cells in the specified range up. Using ShiftEntireColumnExcel will delete the entire column of any cells in the sprecified range. Using ShiftEntireRowExcel will delete the entire row of any cells in the sprecified range.

VisibleOnly

Set this to TRUE to prohibit deleting hidden rows or columns. The default is FALSE.

EssbaseConnect

Connect an Essbase connection.

Overloads

Overload Name Description

General

Connect an Essbase connection.

General

Connect an Essbase connection.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ConnectionID

The ID of the Essbase Connection to use for the connection.

EssbaseLoginServiceObjectTypeID

The name of the IEssbaseLoginService to use to prompt for Essbase credentials. If blank, EssbaseLoginServiceObjectTypeID associated with the view will be used.

EssbaseCustomFunction

Executes a custom Java service on the dodeca-essbase server using the specified arguments.

Overloads

Overload Name Description

General

Executes a custom Java service on the dodeca-essbase server using the specified arguments.

General

Executes a custom Java service on the dodeca-essbase server using the specified arguments.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ServiceName

The name of the custom service to execute on the dodeca-essbase server. The value must correspond to a custom entry in the dodeca-essbase service’s WEB-INF\\classes\\dodeca-essbase-actions.properties file, which maps the service name to the fully qualified Java class name that implements the service.

FunctionArgumentsXml

The XML containing the arguments to pass to the service.

IncludeConnectionXml

Indicates whether the Essbase connection information is included in the Xml passed to the service. If TRUE, the Java class must subclass from EssOperation or one of its subclasses. The EssConnectionManager is automatically instanced and available to the subclass in a protected method overload.

ConnectionID

The ID of the Essbase connection that contains the credentials to be used by the service. The ConnectionID is only used when IncludeConnectionXml is True. For an Essbase view, the ConnectionID is optional. If not specified, the view’s EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified.

IncludeGridXml

Indicates whether the grid data is included in the Xml passed to the service. If TRUE, the Java class must subclass from EssGridOperation. The EssConnectionManager is automatically instanced and available to the subclass in a protected method overload. The EssConnectionManager.getGridView() method also returns an IEssGridView object filled with the grid data passed to the server. By default, the IEssGridView does not contain numbers passed from client. To fill the grid with numeric cells sent from the client, override the protected EssGridOperation.isUpdate() method as follows:

ResultPropertyName

(Optional) The name of the workbook script property that receives the value of the result returned by the function. If the property data type is Boolean, the workbook script will attempt to convert the value to True or False; otherwise, the value is treated as a string. If the property does not exist, it is created.

ResultsDataCacheName

(Optional) The name of the DataCache that the result values can be written to when the result string represents tabular data where rows are newline delimited and columns are tab delimited. The first column value of each row is used as the row index.

ResultsDataCacheUseFirstColumnAsKey

When the ResultsDataCacheName is specified, the argument indicates whether the first column value of each result row is used as the key for the corresponding data cache row. By default, the argument value is TRUE. The argument value can be set to FALSE when there is no need to lookup a row within the data cache or when the first column potentially contains duplicate values.

BackgroundExecute

Controls whether the function is executed asynchronous.

Timeout

The numbers of seconds allowed to elapse before the execution of the function is timed out on the server. The default value of 0 indicates that no timeout is enforced.

CoverDuringExecute

Controls whether the view is covered while the custom function is executing.

ProgressTextServiceStarted

(Optional) The text string displayed as the progress text in the status bar before the service is started. If no value is specified, "Custom service started" is displayed as the progress text.

ProgressTextServiceCompleted

(Optional) The text string displayed as the progress text in the status bar after the service completes. If no value is specified, "Custom service completed" is displayed as the progress text.

EssbaseDisconnect

Disconnect an Essbase connection.

Overloads

Overload Name Description

General

Disconnect an Essbase connection.

General

Disconnect an Essbase connection.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ConnectionID

The ID of the Essbase Connection to disconnect.

EssbaseKeepOnly

Do an Essbase keep-only.

Overloads

Overload Name Description

General

Do an Essbase KeepOnly.

General

Do an Essbase KeepOnly.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SelectedRange

The range to select while doing the Essbase KeepOnly.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

EssbaseMdxQuery

Run an Essbase MDX query.

Overloads

Overload Name Description

GridData

Execute an Essbase MDX query that is defined by the MDX argument and write the result to a worksheet.

GridData

Execute an Essbase MDX query that is defined by the MDX argument and write the result to a worksheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

MDXScriptID

The ID of the Essbase Script that represents the MDX query to run.

MDX

The text of the MDX query to execute.

Axis

Controls which of the axes of data generated by the query is returned to the client. By default, Axis is RowsColumnsAndPages; The data for the Rows, Columns, and Pages axes is returned to the client.

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.

HideRestrictedData

Controls whether data to which the user has no access is suppressed. By default, HideRestrictedData is TRUE; Restricted data is not returned.

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.

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, RepeatRowMemberLabels is True.

ConnectionID

The ID of the Essbase Connection to use for the query.

Username

The username of the Essbase credentials used to execute the query. If the username and password are not specified, the default credentials are used.

Password

The password of the Essbase credentials used to execute the query. If the username and password are not specified, the default credentials are used.

StartCell

The address of the cell where the first row and column of the report output goes.

OutputRangeName

The defined name to create for the range that contains the report output.

ProgressTextQueryStarted

(Optional) The text string displayed as the progress text in the status bar before the query is started. If no value is specified, "MDX query started" is displayed as the progress text.

ProgressTextQueryCompleted

(Optional) The text string displayed as the progress text in the status bar after the query completes. If no value is specified, "MDX query completed" is displayed as the progress text.

ProgressTextQueryFailed

(Optional) The text string displayed as the progress text in the status bar if the query fails. If no value is specified, "MDX query failed" is displayed as the progress text.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

EssbasePivot

Do an Essbase pivot.

Overloads

Overload Name Description

General

Do an Essbase Pivot.

General

Do an Essbase Pivot.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FromCell

The address of the cell that contains the member that the pivot is being done on.

ToCell

The address of the cell to pivot the from cell to.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

EssbaseRemoveOnly

Do an Essbase remove-only.

Overloads

Overload Name Description

General

Do an Essbase RemoveOnly.

General

Do an Essbase RemoveOnly.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SelectedRange

The range to select while doing the Essbase RemoveOnly.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

EssbaseReport

Run an Essbase report.

Overloads

Overload Name Description

ServerBased

Run an Essbase report that is defined on the server and write the output to a worksheet.

TextBased

Run an Essbase report that is defined by the ReportSpec argument and write the output to a worksheet.

ServerBased

Run an Essbase report that is defined on the server and write the output to a worksheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ReportScript

The name (server-side) of the report script to run.

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

StartCell

The address of the cell used as the location of the first row and column of the query results.

OutputRangeName

The defined name to create for the range that contains the query results.

ConnectionID

The ID of the Essbase Connection to use for the report.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

AttributesPolicy

Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client. When specified, the AttributesPolicy argument takes precedence over the deprecated Attributes argument. When the AttributesPolicy argument is not specified and the Attributes argument is specified, the Attributes argument is used, but the value is reversed as was the behavior prior to the deprecation of the Attributes argument. When neither argument is specified, attributes are returned. WARNING: Attributes should not be included if the report script suppresses page and column headings using {SUPPAGEHEADING} and {SUPCOLHEADING}.

IncludeAttributes

Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

TextBased

Run an Essbase report that is defined by the ReportSpec argument and write the output to a worksheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ReportScriptID

The ID of the Essbase Script that represents the report script to run.

ReportSpec

The text of the report script to run.

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

StartCell

The address of the cell used as the location of the first row and column of the query results.

OutputRangeName

The defined name to create for the range that contains the query results.

ConnectionID

The ID of the Essbase Connection to use for the report.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

AttributesPolicy

Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client. When specified, the AttributesPolicy argument takes precedence over the deprecated Attributes argument. When the AttributesPolicy argument is not specified and the Attributes argument is specified, the Attributes argument is used, but the value is reversed as was the behavior prior to the deprecation of the Attributes argument. When neither argument is specified, attributes are returned. WARNING: Attributes should not be included if the report script suppresses page and column headings using {SUPPAGEHEADING} and {SUPCOLHEADING}.

IncludeAttributes

Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

EssbaseRetrieve

Do an Essbase retrieve.

Overloads

Overload Name Description

Adhoc

Performs an Essbase retrieve operation for an Ad-hoc Essbase view.

General

Performs an Essbase retrieve operation for an Excel Essbase view.

Range

Performs an Essbase retrieve operation on a specific range for an Excel Essbase view.

Adhoc

Performs an Essbase retrieve operation for an Ad-hoc Essbase view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

ReplaceTokens

Whether to do token replacement before the retrieve.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

AutoAddRetrieveSubRanges

Controls whether named ranges are automatically added for the Essbase page, row, column, and data areas when any Essbase operation is performed that retrieves data. These operations include retrieve, pivot, zoom in, zoom out, remove only, and keep only. The names of the ranges are Ess.PageHeaderRange, Ess.RowHeaderRange, Ess.ColumnHeaderRange, and Ess.DataRange. For an Excel Essbase view that contains named retrieve ranges, such as Ess.Retrieve.Range.1, the sub-range names are given an extension to uniquely identify and associate the sub-ranges with the retrieve range. The extension is based on the retrieve range identifier. For example, if the named retrieve range is Ess.Retrieve.Range.1, the sub-range names are Ess.PageHeaderRange.1, Ess.RowHeaderRange.1, Ess.ColumnHeaderRange.1, and Ess.DataRange.1. The named ranges can be used by the view’s workbook script to format the page, row, column, and/or data areas after an Essbase operation is performed. If left blank the View’s setting for AutoAddRetrieveSubRanges will be used.

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

General

Performs an Essbase retrieve operation for an Excel Essbase view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

RetrievePolicy

Indicates whether only the active sheet, or all sheets, or all retrieve ranges should be retrieved when performing an Essbase retrieve operation.

ReplaceTokens

Whether to do token replacement before the retrieve.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

AutoAddRetrieveSubRanges

Controls whether named ranges are automatically added for the Essbase page, row, column, and data areas when any Essbase operation is performed that retrieves data. These operations include retrieve, pivot, zoom in, zoom out, remove only, and keep only. The names of the ranges are Ess.PageHeaderRange, Ess.RowHeaderRange, Ess.ColumnHeaderRange, and Ess.DataRange. For an Excel Essbase view that contains named retrieve ranges, such as Ess.Retrieve.Range.1, the sub-range names are given an extension to uniquely identify and associate the sub-ranges with the retrieve range. The extension is based on the retrieve range identifier. For example, if the named retrieve range is Ess.Retrieve.Range.1, the sub-range names are Ess.PageHeaderRange.1, Ess.RowHeaderRange.1, Ess.ColumnHeaderRange.1, and Ess.DataRange.1. The named ranges can be used by the view’s workbook script to format the page, row, column, and/or data areas after an Essbase operation is performed. If left blank the View’s setting for AutoAddRetrieveSubRanges will be used.

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetainFormulasOnRetrieval

Whether formulas are retained within data ranges retrieved.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

Range

Performs an Essbase retrieve operation on a specific range for an Excel Essbase view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

RangeName

The range to do the Essbase retrieve on.

EssbaseConnectionID

The Essbase connection ID.

ReplaceTokens

Whether to do token replacement before the retrieve.

SynchronizeCharts

Whether to synchronize the chart, if any, associated with the retrieve range.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

AutoAddRetrieveSubRanges

Controls whether named ranges are automatically added for the Essbase page, row, column, and data areas when any Essbase operation is performed that retrieves data. These operations include retrieve, pivot, zoom in, zoom out, remove only, and keep only. The names of the ranges are Ess.PageHeaderRange, Ess.RowHeaderRange, Ess.ColumnHeaderRange, and Ess.DataRange. For an Excel Essbase view that contains named retrieve ranges, such as Ess.Retrieve.Range.1, the sub-range names are given an extension to uniquely identify and associate the sub-ranges with the retrieve range. The extension is based on the retrieve range identifier. For example, if the named retrieve range is Ess.Retrieve.Range.1, the sub-range names are Ess.PageHeaderRange.1, Ess.RowHeaderRange.1, Ess.ColumnHeaderRange.1, and Ess.DataRange.1. The named ranges can be used by the view’s workbook script to format the page, row, column, and/or data areas after an Essbase operation is performed. If left blank the View’s setting for AutoAddRetrieveSubRanges will be used.

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetainFormulasOnRetrieval

Whether formulas are retained within data ranges retrieved.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

EssbaseRunCalc

Run an Essbase calc.

Overloads

Overload Name Description

DefaultCalc

Run the cube’s default Calc.

General

Run an Essbase Calc.

ServerBased

Run Essbase Calc that is defined on the server.

TextBased

Run an Essbase Calc defined by the ScriptText argument.

DefaultCalc

Run the cube’s default Calc.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

BackgroundCalc

Whether the method is executed asynchronous.

ConnectionID

The ID of the Essbase Connection to use for the Calc.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

CoverDuringCalc

Controls whether the view is covered while the calc is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the calc returns an exception.

General

Run an Essbase Calc.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ScriptName

The name (server-side) of the script to run.

CalcScriptID

The ID of the Essbase Script that represents the calc script to run.

ScriptText

The text of the script to run.

BackgroundCalc

Whether the method is executed asynchronous.

AddLineIndex

The line number of the calc script to add a line at. Leave this argument empty to add at the end of the script.

AddLineText

A line of calc script text to add to the calc script.

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

ConnectionID

The ID of the Essbase Connection to use for the Calc.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

CoverDuringCalc

Controls whether the view is covered while the calc is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the calc returns an exception.

ServerBased

Run Essbase Calc that is defined on the server.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ScriptName

The name (server-side) of the script to run.

RuntimeSubVars

(Optional) The runtime substitution variables that are used in a calculation script. The variables are specified as a delimited string of substitution variables and member pairs, such as currMarket="Florida";currScenario="Actual";

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

BackgroundCalc

Whether the method is executed asynchronous.

ConnectionID

The ID of the Essbase Connection to use for the Calc.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

CoverDuringCalc

Controls whether the view is covered while the calc is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the calc returns an exception.

TextBased

Run an Essbase Calc defined by the ScriptText argument.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

CalcScriptID

The ID of the Essbase Script that represents the calc script to run.

ScriptText

The text of the script to run.

RuntimeSubVars

(Optional) The runtime substitution variables that are used in a calculation script. The variables are specified as a delimited string of substitution variables and member pairs, such as currMarket="Florida";currScenario="Actual";

DoTokenReplacement

Whether to do token replacement on the script text before executing it.

BackgroundCalc

Whether the method is executed asynchronous.

ConnectionID

The ID of the Essbase Connection to use for the Calc.

Username

The username to use for the Essbase connection. Leave empty if defaulting to the current login.

Password

The password to use for the Essbase connection. Leave empty if defaulting to the current login.

CoverDuringCalc

Controls whether the view is covered while the calc is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the calc returns an exception.

EssbaseRunMaxL (7.7)

Run a MaxL script.

Overloads

Overload Name Description

General

Run a MaxL script.

General

Run a MaxL script.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ScriptText

One of more MaxL statements to be run.

ContinueOnError

Controls whether script execution continues after an error is encountered.

ConnectionID

The ID of the Essbase connection that contains the credentials to be used by script. For an Essbase view, the ConnectionID is optional. If not specified, the view’s EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified.

MessagesSheetName

If not blank, a worksheet will be added to the current view with the messages produced by the MaxL script execution.

ResultsSheetName

If not blank, a worksheet will be added to the current view with the results of each MaxL statement in the script. If the script contains more than one statement then a sequentially numbered sheet will be added for each statement.

StatementMessagesSheetName

If not blank, a worksheet will be added to the current view with the messages of each MaxL statement in the script. If the script contains more than one statement then a sequentially numbered sheet will be added for each statement.

MessagesDataCacheName

If not blank, a DataCache will be added to the current view with the messages produced by the MaxL script execution.

ResultsDataCacheName

If not blank, a DataCache will be added to the current view with the results of the MaxL script. If the script contains more than one statement then a sequentially numbered DataCache will be added for each statement.

StatementMessagesDataCacheName

If not blank, a DataCache will be added to the current view with the messages returned by each statement in the MaxL script. If the script contains more than one statement then a sequentially numbered DataCache will be added for each statement.

DataCacheColumnLabels

Whether to include column headers for DataCaches. The default is FALSE.

BackgroundExecute

Controls whether the method is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the script is running.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the script is run. If no value is specified, "Running MaxL" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the script is completed. If no value is specified, "RunMaxL completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the script fails. If no value is specified, "RunMaxL failed" is displayed as the progress text.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the MaxL script fails to run.

LogFileName

Specify a filename for the log file. If LogFileName is left blank no log file will be created.

LogFileFolder

Specify the full path to the folder of the log file. If LogFileFolder is left blank the log file will be written to the Desktop folder. If LogFileName is left blank no log file will be created.

LogFileOverwritePolicy

Specify what to do if the specified log file already exists. If LogFileOverwritePolicy is left blank IncrementFileName will be used. Append: Append new results to the existing file. IncrementFileName: Create a new file with a sequential number appended to the filename, like "MyLogFileName (1).txt". Overwrite: Replace the existing file with the new file.

EssbaseRunScript

Run a script on the server using a specified command line.

Overloads

Overload Name Description

FileBased

Run a script on the server using the specified CommandLine.

TextBased

Run a script, specified as the ScriptText argument, on the server using the specified CommandLine.

FileBased

Run a script on the server using the specified CommandLine.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ScriptTimeout

The numbers of seconds allowed to elapse before the script is timed out. The default value of 0 indicates that no timeout is enforced.

Filename

The name of the file to execute on the server using the CommandLine. For the TextBased overload, if not specified, a unique file name is generated.

Folder

The full path of the folder that contains the Filename.

CommandLine

The command line to execute on the server, which can optionally contain placeholders for the following parameters, which are replaced with the actual value at runtime: %directory% - The absolute path of the specified Folder, %filename% — The absolute path of the specified Filename, %file.separator% - The file separator used by the server operating system, and the following Essbase connection parameters: %server%, %application%, %database%, %username%, %password%.

ConnectionID

The ID of the Essbase connection that contains the credentials to be used by script. For an Essbase view, the ConnectionID is optional. If not specified, the view’s EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified.

BackgroundExecute

Controls whether the method is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the script is running.

ResultPropertyName

The name of the workbook script property that receives the value of the script execution result returned from the server. The value is either True, which indicates success, or False, which indicates an error occurred.

DetailsPropertyName

The name of the workbook script property that receives the value of the script execution details returned from the server. If the result is True, the details represent the value returned by the script to stdout. If the result if False, the details represent the value returned by the script to stderr.

TextBased

Run a script, specified as the ScriptText argument, on the server using the specified CommandLine.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ScriptTimeout

The numbers of seconds allowed to elapse before the script is timed out. The default value of 0 indicates that no timeout is enforced.

ScriptText

The text of the script to run on the server. The ScriptText is written to a file and the file is executed using the CommandLine.

CommandLine

The command line to execute on the server, which can optionally contain placeholders for the following parameters, which are replaced with the actual value at runtime: %directory% - The absolute path of the specified Folder, %filename% — The absolute path of the specified Filename, %file.separator% - The file separator used by the server operating system, and the following Essbase connection parameters: %server%, %application%, %database%, %username%, %password%.

Filename

The name of the file to execute on the server using the CommandLine. For the TextBased overload, if not specified, a unique file name is generated.

Folder

The full path of the folder that contains the Filename.

Extension

The extension appended to the file created on the server.

ConnectionID

The ID of the Essbase connection that contains the credentials to be used by script. For an Essbase view, the ConnectionID is optional. If not specified, the view’s EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified.

BackgroundExecute

Controls whether the method is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the script is running.

ResultPropertyName

The name of the workbook script property that receives the value of the script execution result returned from the server. The value is either True, which indicates success, or False, which indicates an error occurred.

DetailsPropertyName

The name of the workbook script property that receives the value of the script execution details returned from the server. If the result is True, the details represent the value returned by the script to stdout. If the result if False, the details represent the value returned by the script to stderr.

EssbaseSend

Do an Essbase send.

Overloads

Overload Name Description

Adhoc

Performs an Essbase send operation for an Ad-hoc Essbase view.

General

Performs an Essbase send operation for an Excel Essbase view.

Range

Performs an Essbase send operation on a specific range for an Excel Essbase view.

Adhoc

Performs an Essbase send operation for an Ad-hoc Essbase view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

EssbaseConnectionID

The Essbase connection ID.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

UseMemberNamesAndAliasesForRows

Controls whether to use member names and aliases for the row dimension. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

General

Performs an Essbase send operation for an Excel Essbase view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SendPolicy

Indicates whether only the active sheet, or all sheets, or all retrieve ranges should be sent when performing an Essbase send operation.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

UseMemberNamesAndAliasesForRows

Controls whether to use member names and aliases for the row dimension. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

Range

Performs an Essbase send operation on a specific range for an Excel Essbase view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

RangeName

The range to do the Essbase Send on.

EssbaseConnectionID

The Essbase connection ID.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

UseMemberNamesAndAliasesForRows

Controls whether to use member names and aliases for the row dimension. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

EssbaseSetOptions

Set Essbase options.

Overloads

Overload Name Description

General

Set the view’s Essbase options. User’s settings, if allowed, will override these settings.

General

Set the view’s Essbase options. User’s settings, if allowed, will override these settings.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

LatestMemberName

Indicates the name of the member to use as the latest time period for dynamic time series retrievals.

SpecifyLatestMember

Controls whether the LatestMemberName is used by dynamic time series retrievals.

MemberRetentionIncludeSelection

Controls whether the selected member is retained along with the other members retrieved by a Zoom In operation.

MemberRetentionRemoveUnselectedGroups

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation removes all dimension groups that are not in the selected group.

MemberRetentionWithinSelectedGroup

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation is applied only to the dimension of the selected member(s). WithinSelectedGroup is only applicable when the sheet contains two or more dimensions of data down a sheet as rows or across a sheet as columns.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetainFormulasOnRetrieval

Whether formulas are retained within data ranges retrieved.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SendBlanksAsMissing

Controls whether blanks are replaced with the missing string by a Send operation.

SendLevelZeroOnly

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

Controls whether zeros are replaced with the missing string by a Send operation.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

ZoomLevel

Indicates the depth of data that is retrieved relative to the selected member(s) by a Zoom In operation.

EssbaseUpdate

Do an Essbase update using a report spec.

Overloads

Overload Name Description

General

Do an Essbase Update.

General

Do an Essbase Update.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ReportScriptID

The ID of the Essbase Script that represents the report script used to update the database.

UpdateSpec

The report spec used to update the database. Example: '"New York" Jan Actual "100-10" Sales 640' will update the value of the given intersection to 640.

ConnectionID

The ID of the Essbase Connection to use for the update operation.

EssbaseZoomIn

Do an Essbase zoom-in.

Overloads

Overload Name Description

General

Do an Essbase ZoomIn.

General

Do an Essbase ZoomIn.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SelectedRange

The range to select while doing the Essbase ZoomIn.

EssbaseConnectionID

The ID of the Essbase Connection to use for the ZoomIn operation.

ZoomAcross

If TRUE, the zoom-in dimension will remain in column orientation. If the zoom-in dimension is in page orientation, it will go to column orientation.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MemberRetentionIncludeSelection

Controls whether the selected member is retained along with the other members retrieved by a Zoom In operation.

MemberRetentionRemoveUnselectedGroups

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation removes all dimension groups that are not in the selected group.

MemberRetentionWithinSelectedGroup

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation is applied only to the dimension of the selected member(s). WithinSelectedGroup is only applicable when the sheet contains two or more dimensions of data down a sheet as rows or across a sheet as columns.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

ZoomLevel

Indicates the depth of data that is retrieved relative to the selected member(s) by a Zoom In operation.

EssbaseZoomOut

Do an Essbase zoom-out.

Overloads

Overload Name Description

General

Do an Essbase ZoomOut.

General

Do an Essbase ZoomOut.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SelectedRange

The range to select while doing the Essbase ZoomOut.

AliasTableName

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true. See also: UseAliases

DisplayUnknownMembers

Controls whether unknown members are displayed in the grid.

EnableHybridAnalysis

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

Indentation

Indicates the indentation of member names. None — Prevents indentation of any member names. SubItems — Left-justifies ancestors and indents descendants. Totals — Left-justifies descendants and indents ancestors.

MissingLabel

The string used for missing values by Essbase operations.

NavigateWithoutData

Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.

NoAccessLabel

The string used for data to which the user has no access during Essbase operations.

RepeatMemberLabels

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrieveUpdateMode

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked. UpdateMode is only applicable when NavigateWithoutData is false.

SuppressMissingRows

Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscoreCharacters

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeroRows

Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UseAliases

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. See also: AliasTable

UseMemberNamesAndAliasesForRows

Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View’s setting for UseMemberNamesAndAliasesForRowDimensions will be used.

ExecuteProcedure

Execute a specified workbook script procedure.

Overloads

Overload Name Description

General

Execute a workbook script procedure.

ToolAction

Use to execute a workbook script procedure for a specific tool. Use this overload in conjunction with the ToolClicked and/or ToolValueChanged eventlinks.

General

Execute a workbook script procedure.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Procedure

The name of the procedure to execute.

Break

Use this argument to conditionally exit this procedure. This argument will be evaluated only after calling the specified procedure.

ToolAction

Use to execute a workbook script procedure for a specific tool. Use this overload in conjunction with the ToolClicked and/or ToolValueChanged eventlinks.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Procedure

The name of the procedure to execute.

ToolKey

The key of the tool that the execution of the procedure depends on. If left blank the specified procedure will run for any tool.

Break

Use this argument to conditionally exit this procedure. This argument will be evaluated only after calling the specified procedure.

ExecuteSQLTransaction (8.2)

Execute one or more SQL statements. ===== Hidden in 8.0.0 - ExecuteSQLTransaction is no longer supported.

Overloads

Overload Name Description

General

Execute one or more SQL statements.

General

Execute one or more SQL statements.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Driver

The driver to use.

ServletPath

The servlet-path to use.

SQLConnectString

The SQL connect-string to use.

Username

The username to use.

Password

The password to use.

Statements

One or more SQL statements delimited with the specified delimiter.

StatementDelimiter

The delimiter to use to define the end of each statement. The default is the "

" (pipe) character.

Inserts

ExitProcedure

Exit the workbook script procedure if the Method condition evaluates to TRUE. If run CellByCell then a CellCondition of TRUE in any cell will exit the procedure.

Overloads

Overload Name Description

General

Exit the procedure if the MethodCondition evaluates to TRUE. If run CellByCell then a CellCondition of TRUE in any cell will exit the procedure.

General

Exit the procedure if the MethodCondition evaluates to TRUE. If run CellByCell then a CellCondition of TRUE in any cell will exit the procedure.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Exit

Determines whether the current procedure is exited.

ExportToExcel

Export the view to an Excel file.

Overloads

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.

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.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

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.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

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.

Filter (7.4)

Filter a specified range.

Overloads

Overload Name Description

Between

Select the items that lie between two values (inclusive) from the filter of the specified column.

BottomX

Select the bottom X items from the filter of the specified column, where X is a specified number value.

BottomXPercent

Select the bottom X percent items from the filter of the specified column, where X is a specified percent value.

Clear

Clear all selections from all filters on the sheet.

Equals

Select one specific value from the filter of the specified column.

FiltersOff

Turn off filtering for the specified range.

FiltersOn

Turn on filtering for the specified range. Functions as a toggle if filters are already on.

GreaterThan

Select the items that are greater than the specified value from the filter of the specified column.

InList

Select a list of values from the filter of the specified column.

LessThan

Select the items that are less than the specified value from the filter of the specified column.

TopX

Select the top X items from the filter of the specified column, where X is a specified number value.

TopXPercent

Select the top X percent items from the filter of the specified column, where X is a specified percent value.

Between

Select the items that lie between two values (inclusive) from the filter of the specified column.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

LowValue

The lower value to use in the between range.

HighValue

The higher value to use in the between range.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

BottomX

Select the bottom X items from the filter of the specified column, where X is a specified number value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

ValueOfX

The value to use in Top and Bottom filters.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

BottomXPercent

Select the bottom X percent items from the filter of the specified column, where X is a specified percent value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

ValueOfX

The value to use in Top and Bottom filters.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

Clear

Clear all selections from all filters on the sheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

Equals

Select one specific value from the filter of the specified column.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

FiltersOff

Turn off filtering for the specified range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FiltersOn

Turn on filtering for the specified range. Functions as a toggle if filters are already on.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

GreaterThan

Select the items that are greater than the specified value from the filter of the specified column.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

InList

Select a list of values from the filter of the specified column.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

List

The list of values to select in the specified column.

Delimiter

The delimiter to use to parse the list of values. Comma, ",", is the default.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

LessThan

Select the items that are less than the specified value from the filter of the specified column.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

TopX

Select the top X items from the filter of the specified column, where X is a specified number value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

ValueOfX

The value to use in Top and Bottom filters.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

TopXPercent

Select the top X percent items from the filter of the specified column, where X is a specified percent value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ColumnNumber

The column number of the filter.

ValueOfX

The value to use in Top and Bottom filters.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter’s dropdown should be displayed after applying the selection.

ForEach

Execute a procedure for each value of a list or number range.

Overloads

Overload Name Description

DataCache

Execute a Procedure for each row in a DataCache.

NumberToNumber

Execute a Procedure for each number of a specified range.

SqlDataCache

Execute a Procedure for each row in a DataCache created using AddDataCache.SQLPassthroughDataSet.

A workbook script property with the name of the column will be added for each column of the SqlDataCache as each row of the SqlDataCache is processed by the ForEach method.

If PropertyNamePrefix argument is specified then the name of each property added will be prepended with the PropertyNamePrefix like [PropertyNamePrefix][ColumnName].

The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

DataCache

Execute a Procedure for each row in a DataCache.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the data-cache that contains the values.

SortOrder

Specifies one or more columns of the DataCache to sort by.

Example: Col1 Example: Col1, Col3 Example: "Col2 DESC, Col1 ASC"

Procedure

The name of the procedure to execute.

ExitLoopCondition

Condition evaluated before each iteration of the ForEach loop. If the condition evaluates to True, the loop is exited.

ColumnNumber

The column number to get each value from. Use ColumnNumber in conjunction with PropertyName to produce a property with the value of the specified column number with each iteration of the ForEach.

PropertyName

If PropertyName is specified, a script property will be added with the value specified by the ColumnNumber argument on each iteration of the ForEach loop with the specified name.

The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

NumberToNumber

Execute a Procedure for each number of a specified range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

StartNumber

The number to begin the ForEach with.

EndNumber

The number to end the ForEach on.

Procedure

The name of the procedure to execute.

ExitLoopCondition

Condition evaluated before each iteration of the ForEach loop. If the condition evaluates to True, the loop is exited.

PropertyName

If PropertyName is specified, a script property will be added with the value specified by the ColumnNumber argument on each iteration of the ForEach loop with the specified name.

The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

SqlDataCache

Execute a Procedure for each row in a DataCache created using AddDataCache.SQLPassthroughDataSet.

A workbook script property with the name of the column will be added for each column of the SqlDataCache as each row of the SqlDataCache is processed by the ForEach method.
If PropertyNamePrefix argument is specified then the name of each property added will be prepended with the PropertyNamePrefix like [PropertyNamePrefix][ColumnName].
The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.
Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DataCacheName

The name of the data-cache that contains the values.

SortOrder

Specifies one or more columns of the DataCache to sort by.

Example: Col1 Example: Col1, Col3 Example: "Col2 DESC, Col1 ASC"

Procedure

The name of the procedure to execute.

ExitLoopCondition

Condition evaluated before each iteration of the ForEach loop. If the condition evaluates to True, the loop is exited.

PropertyNamePrefix

If PropertyNamePrefix is specified the name of each workbook script property will be prepended with the prefix like [PropertyNamePrefix][ColumnName].

The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

InsertBreak (7.2)

Insert a break or breaks into one or all sheets.

Overloads

Overload Name Description

Dynamic

Insert page breaks at the specified page height.

General

Insert a single page break.

Dynamic

Insert page breaks at the specified page height.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FlagColumn

(Optional) The column that contains a TRUE/FALSE flag that represents whether a particular row is a candidate for a page break.

PageHeight

The page height in pixels where the break is inserted.

General

Insert a single page break.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

InsertAddress

The address to insert the range at.

InsertRange

Insert a range into one or all sheets.

Overloads

Overload Name Description

General

Insert cells.

General

Insert cells.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

InsertAddress

The address to insert the range at.

ShiftDirection

The shift mode for the insert. Warning: ShiftEntireRow and ShiftEntireColumn do not work correctly. Use ShiftEntireRowExcel and ShiftEntireColumnExcel to get the correct result. ShiftEntireColumn performs the same as ShiftRight (incorrect). ShiftEntireRow performs the same as ShiftDown (incorrect).

Using ShiftRight will move the cells to the right of any cells in the specified range to the right. Using ShiftDown will move the cells below of any cells in the specified range down. Using ShiftEntireColumnExcel will insert the entire column of any cells in the sprecified range. Using ShiftEntireRowExcel will insert the entire row of any cells in the sprecified range.

LoadWorkbook

Load a workbook from an Excel Binary Artifact.

Overloads

Overload Name Description

General

Load an Excel Binary Artifact.

General

Load an Excel Binary Artifact.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ExcelArtifactIDandVersion

The ID and version of the ExcelBinaryArtifact to load.

Password

If the workbook is password-protected, specifies the password assigned to the workbook. NOTE: The password is currently only supported for XLS files that are saved from Excel 2010.

MoveWorksheet

Move a specified worksheet within the workbook.

Overloads

Overload Name Description

General

Move a worksheet.

General

Move a worksheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SpecifyFromBy

Select how to specify which worksheet to move.

From

Specify the sheet-name or sheet-number, depending on SpecifyFromBy.

SpecifyToPosition

Select how to specify where to move the worksheet to.

ToPosition

If SpecifyToPosition is ToPositionOfSheetNamed then enter a sheet name. If SpecifyToPosition is ToPositionNumber then enter a number.

OpenApplication (7.3)

Open a specified DSMS application, using a full URL or application parameters.

Overloads

Overload Name Description

General

Open a specified DSMS application, using a full URL or application parameters.

General

Open a specified DSMS application, using a full URL or application parameters.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Application

The ID of the Application to open.

Tenant

(Optional) The ID of the Tenant to open. By default, the current tenant is used.

View

The ID of the View to open on launch.

URL

The full URL of the DSMS application to open, which can be used instead of the application parameters.

OpenBinaryArtifact (7.2)

Open a specified binary artifact, using the default editor on the system.

Overloads

Overload Name Description

General

Open a specified binary artifact, using the default editor on the system.

General

Open a specified binary artifact, using the default editor on the system.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

BinaryArtifactID

The ID of the Binary Artifact to open.

VersionPolicy

Specifies whether to open the latest version of the Binary Artifact or a specific version specified by the SpecificVersion argument.

SpecificVersion

The version of the Binary Artifact to open when using the VersionPolicy argument is set to Specific.

OpenView

Open a specified view.

Overloads

Overload Name Description

General

Open a specified view, and optionally build and/or close the view.

General

Open a specified view, and optionally build and/or close the view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ViewID

The ID of the view to open.

AutoBuildOnOpen

Whether the view should autobuild, or wait for the user to click the build button. Leave blank to use the view’s AutoBuildOnOpen property.

ShareViewTokens

Whether the current view’s tokens are added as tokens to the opened view. When added, the tokens are used to set default selections, when applicable, and can be referenced in workbook scripts, SQLPassthroughDataSets, etc. as used by the opened view.

ShareSelectorTokens

Whether the current view’s selector tokens are added as tokens to the opened view. When added, the tokens are used to set default selections, when applicable, and can be referenced in workbook scripts, SQLPassthroughDataSets, etc. as used by the opened view.

ShowViewAsActiveWindow

Whether the opened view’s window becomes the active window. By default, the view’s window is activated.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the opening or building of the view returns an exception.

Close

Controls whether the view should be closed after opening and automatically building. If specified, the ClosePolicy argument takes precedence over the Close argument. By default, if neither argument is specified, the view is not closed.

ClosePolicy

Controls whether the view should be closed after opening and automatically building. The ClosePolicy argument provides more control over whether the view is closed and, if specified, takes precedence over the Close argument. By default, if neither argument is specified, the view is not closed.

Print

Print Selection, Sheet, or Workbook.

Overloads

Overload Name Description

Preview

PrintPreview Selection, Sheet, or Workbook.

Print

Print Selection, Sheet, or Workbook.

PrintToFile

Print Selection, Sheet, or Workbook to a file.

PrintPreview Selection, Sheet, or Workbook.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

PrintWhat

Specifies what to print.

Print Selection, Sheet, or Workbook.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

PrintWhat

Specifies what to print.

ShowDialog

Whether to show the print dialog.

Print Selection, Sheet, or Workbook to a file.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

PrintWhat

Specifies what to print.

PrinterName

Specifies the name of the print driver, such as Microsoft XPS Document Writer.

Filename

Specify the name of the file.

FolderOption

Select which option is used to determine the folder to save the file to. If no option is specified, the Folder argument is used.

Folder

Specify the full path of the folder to save the file to. The Folder value is only used when the FolderOption is not specified.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

Process

Provides the ability to start a local process by specifying an application or document name.

Overloads

Overload Name Description

Start

Starts a local process specified as an application or document name.

Start

Starts a local process specified as an application or document name.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FileName

The name of the application or document to start. The document can be of any file type for which the extension has been associated with an application installed on the client system.

CommandLineArguments

Command-line arguments to pass when starting the application.

PromptForInput

Prompt the user for a value.

Overloads

Overload Name Description

Date

Prompt the user for a date value.

Double

Prompt the user for a double value.

DropDown

Prompt the user with a list of values in a drop-down.

Integer

Prompt the user for an integer value.

String

Prompt the user for a string value.

Date

Prompt the user for a date value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

Min

The minimum value to allow.

Max

The maximum value to allow.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

Double

Prompt the user for a double value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

Min

The minimum value to allow.

Max

The maximum value to allow.

DecimalPlaces

The maximum number of digits to the right of the decimal to allow.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

DropDown

Prompt the user with a list of values in a drop-down.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

MaxCharacters

The maximum number of characters to allow.

DropDownList

The list of values for the drop-down. If the list only contains display-values, separate each value with a semicolon. If the drop-down has display-values and data-values then the display-values should be separated from the data-values with a semicolon, and each row of the list should be followed by a new-line.

HasDataValues

Determines whether the combo-list has display-values and data-values, or just display-values.

LimitToList

Whether the entry must be in the drop-down list.

MaxDropDownItems

The number of rows to show in the drop-down list. The default is 15.

SortStyle

Whether null/empty is a valid entry.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

Integer

Prompt the user for an integer value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

Min

The minimum value to allow.

Max

The maximum value to allow.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

String

Prompt the user for a string value.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

MaxCharacters

The maximum number of characters to allow.

MultiLine

Whether to allow more than one line in the input.

WordWrap

Whether to automatically wrap text.

ScrollBars

The scrollbar configuration for the text box.

PasswordMaskCharacter

A character to use for password masking.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

RefreshView

Refresh the view.

Overloads

Overload Name Description

General

Refresh the view.

General

Refresh the view.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

RemoveDefinedName

Remove a defined name.

Overloads

Overload Name Description

Workbook

Remove a defined name from the workbook.

Worksheet

Remove a defined name from one or all worksheets.

Workbook

Remove a defined name from the workbook.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DefinedName

The name to remove.

Worksheet

Remove a defined name from one or all worksheets.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

DefinedName

The name to remove.

RemoveDuplicates (7.4)

Remove duplicate rows or columns.

Overloads

Overload Name Description

Columns

Remove duplicate columns based on values in specified rows.

Rows

Remove duplicate rows based on values in specified columns.

Columns

Remove duplicate columns based on values in specified rows.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Range

The name or address of the range to remove duplicates from.

HasHeaders

Set this to TRUE if the range has headers that should be ignored. The default is FALSE.

CompareRows

A comma delimited list of row numbers within the specified Range to use for the comparison. Example: 3, 4, 7

ShiftColumns

Whether to shift cells left when removing columns or remove the entire column. The default is "Left".

Rows

Remove duplicate rows based on values in specified columns.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Range

The name or address of the range to remove duplicates from.

HasHeaders

Set this to TRUE if the range has headers that should be ignored. The default is FALSE.

CompareColumns

A comma delimited list of column numbers within the specified Range to use for the comparison. Example: 3, 4, 7

ShiftRows

Whether to shift cells up when removing rows or remove the entire row. The default is "Up".

RemoveProperty

Remove a specified property from the workbook script.

Overloads

Overload Name Description

General

Remove a workbook script property from the script.

General

Remove a workbook script property from the script.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

PropertyName

The name of the property to remove.

RemoveToken

Remove a specified token from the workbook script.

Overloads

Overload Name Description

Any

Remove the specified token from the Application tokens, View tokens, and the view’s volatile tokens.

Application

Remove the specified token from the Application tokens.

General

Remove the specified token from the view’s volatile tokens.

View

Remove the specified token from the View’s tokens.

Any

Remove the specified token from the Application tokens, View tokens, and the view’s volatile tokens.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

TokenName

The name of the token to remove.

Application

Remove the specified token from the Application tokens.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

TokenName

The name of the token to remove.

General

Remove the specified token from the view’s volatile tokens.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

TokenName

The name of the token to remove.

View

Remove the specified token from the View’s tokens.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

TokenName

The name of the token to remove.

RemoveWorksheet

Remove a specified worksheet from the workbook.

Overloads

Overload Name Description

General

Remove a worksheet.

General

Remove a worksheet.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SpecifySheetToRemoveBy

Select how to specify which worksheet to remove.

SheetToRemove

Specify the sheet-name or sheet-number of the sheet to remove, depending on SpecifySheetToRemoveBy.

RenameWorkbook

Renames a workbook.

Overloads

Overload Name Description

General

Renames a workbook.

General

Renames a workbook.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SpecifyWorkbookBy

Select how to specify the workbook to rename.

Workbook

Specify the name or number of the workbook to rename, depending on SpecifyWorkbookBy.

NewWorkbookName

The new name of the workbook.

RenameWorksheet

Rename a specified worksheet in the workbook. Note: Changing the worksheet name in an event that fires after the BeforeCommentsSetup event may break comment functionality in the view instance.

Overloads

Overload Name Description

General

Rename one or all worksheets.

General

Rename one or all worksheets.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SpecifySheetToRenameBy

Select how to specify which worksheet to rename.

SheetToRename

Specify the sheet-name or sheet-number of the sheet to rename, depending on SpecifySheetToRenameBy.

NewSheetName

The new name of the sheet.

RepaintGrid

Repaints the grid control.

Overloads

Overload Name Description

General

Repaints the grid control.

General

Repaints the grid control.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Repaint

Determines whether to do the repaint.

Replace (7.4)

Find and replace a string.

Overloads

Overload Name Description

General

Find and replace string.

General

Find and replace string.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

FindWhat

The string that is going to be found and replaced.

ReplaceWith

The string that is going to replace the FindWhat string.

SearchOrder

Whether to replace by columns or rows. Defaults to ByRows if not entered.

MatchCase

Wether to consider Upper/Lower case to determine a match. Defaults to FALSE if not entered.

MatchEntireCellContents

Wether to use the entire cell contents to determine a match. Defaults to FALSE if not entered.

ReplaceTokens

Do token replacement.

Overloads

Overload Name Description

General

Do token replacement.

General

Do token replacement.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SQLPassthroughExecute

Executes a delimited list of SQL statements within a single server request. IMPORTANT: If the Statements argument contains a semicolon ";", then multiple statements should be delimited using a non-semicolon character, such as the pipe character "|", which should be specified as the StatementDelimiter argument. By default, the StatementDelimiter is a semicolon.

Overloads

Overload Name Description

General

Executes a delimited list of SQL statements within a single server request.

General

Executes a delimited list of SQL statements within a single server request.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SQLConnectionID

The SQL connection ID used by the operation.

Statements

The SQL statements delimited by the StatementDelimiter.

StatementDelimiter

The character used to delimit the statements. The recommended delimiters include the pipe "

" and the semi-colon ";". By default, a semi-colon is assumed to be the delimiter, but if any of statements include a delimiter, a non-semicolon character, such as the pipe character "

", should be used and specified as the StatementDelimiter.

Transaction

Controls whether the statements are executed within a transaction. By default, a transaction is not opened.

ContinueOnError

If the Transaction argument is FALSE, ContinueOnError controls whether the remaining statements are executed when a given statement generates an error. By default, execution of the remaining statements is not continued when an error is encountered.

BackgroundExecute

Controls whether the operation is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the statements are executed. By default, the view is not covered.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the statements are executed. If no value is specified, "SQLPassthroughExecute started" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the statements are executed. If no value is specified, "SQLPassthroughExecute completed" is displayed as the progress text.

ResultPropertyName

(Optional) The name of the workbook script property that receives the value of the result, which is a string containing the result of each statement delimited by the StatementDelimiter.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the service returns an exception.

SaveDataSetRange

Saves changes, including added, deleted, and modified rows, for a SQLPassthroughDataSetRange.

Overloads

Overload Name Description

General

Saves changes, including added, deleted, and modified rows, for a SQLPassthroughDataSetRange.

General

Saves changes, including added, deleted, and modified rows, for a SQLPassthroughDataSetRange.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SaveAll

If TRUE all datasets will be saved and DataSetRangeName isn’t necessary. Defaults to FALSE if not entered.

DataSetRangeName

The name of the view’s SQLPassthroughDataSetRange to save.

SaveDataTableRangeRow

Saves an added or modified row within a DataTableRange’s sheet range.

Overloads

Overload Name Description

ByRowAddress

Saves an added or modified row within a DataTableRange’s sheet range.

ByRowAddress

Saves an added or modified row within a DataTableRange’s sheet range.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

RowAddress

The address used to identify the row within a DataTableRange’s sheet range. The address of any cell within the data table range row to be saved can be used.

RowErrorClientPropertyName

The name of the workbook script property that receives the value of the error encountered on the client, such as a data conversion error.

RowErrorServerPropertyName

The name of the workbook script property that receives the value of the error returned by the server, such as a database constraint violation.

SaveWorkbook

Save the workbook to an Excel file.

Overloads

Overload Name Description

Desktop

Save to the desktop of the current user. Specify the file name.

General

Specify the full path.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Specify

Save workbook specifying the file name, file type, and folder.

Desktop

Save to the desktop of the current user. Specify the file name.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the file.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

Password

The password assigned to the saved workbook.

General

Specify the full path.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the file.

Folder

Specify the folder to save the file to. Defaults to MyDocuments if not specified.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

Password

The password assigned to the saved workbook.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the file.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

Password

The password assigned to the saved workbook.

Specify

Save workbook specifying the file name, file type, and folder.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the file.

FileType

Specify to the file type of saved workbook.

Defaults to OpenXMLWorkbook if not specified.

CSV: Specifies a text file of comma-separated values. Typically saved with the .csv filename extension. Excel8: Specifies the Biff 8 File format which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. This format is also supported by Excel 2007-2016. Typically saved with the .xls filename extension. OpenXMLWorkbook: Specifies the Excel 2007-2016 Open XML file format. Typically saved with the .xlsx filename extension. OpenXMLWorkbookMacroEnabled: Specifies the Excel 2007-2016 macro enabled Open XML file format. Typically saved with the .xlsm filename extension. UnicodeText: Specifies a tab-delimited Unicode text file encoded as UTF-8. Typically saved with the .txt filename extension.

Folder

Specify the folder to save the file to. Defaults to MyDocuments if not specified.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

Password

The password assigned to the saved workbook.

SaveWorkbookAsCsv (7.3)

Save the workbook to a CSV file.

Overloads

Overload Name Description

Desktop

Save to the desktop of the current user. Specify the file name.

General

Specify the full path.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Desktop

Save to the desktop of the current user. Specify the file name.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Delimiter

(Optional) Specify the delimiter to be used for the separated values file. By default, "," is used.

Filename

Specify the name of the file.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

Password

The password assigned to the saved workbook.

PreserveLeadingSingleQuotes

Whether to preserve the leading single quote used to indicate text in cells in the CSV output. If true, the resulting CSV file will preserve leading single quotes.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

General

Specify the full path.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Delimiter

(Optional) Specify the delimiter to be used for the separated values file. By default, "," is used.

Filename

Specify the name of the file.

Folder

Specify the folder to save the file to.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

Password

The password assigned to the saved workbook.

PreserveLeadingSingleQuotes

Whether to preserve the leading single quote used to indicate text in cells in the CSV output. If true, the resulting CSV file will preserve leading single quotes.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Delimiter

(Optional) Specify the delimiter to be used for the separated values file. By default, "," is used.

Filename

Specify the name of the file.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

Password

The password assigned to the saved workbook.

PreserveLeadingSingleQuotes

Whether to preserve the leading single quote used to indicate text in cells in the CSV output. If true, the resulting CSV file will preserve leading single quotes.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

SaveWorkbookAsPdf

Save the workbook to a PDF.

Overloads

Overload Name Description

Desktop

Save to the desktop of the current user. Specify the file name.

General

Specify the full path.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Desktop

Save to the desktop of the current user. Specify the file name.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the output PDF.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

BackgroundExecute

Controls whether the method is executed asynchronous.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

General

Specify the full path.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the output PDF.

Folder

Specify the folder to save the PDF to.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

BackgroundExecute

Controls whether the method is executed asynchronous.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

Filename

Specify the name of the output PDF.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

UseDialog

Whether to show the Save File dialog to allow the user to select the folder and filename.

BackgroundExecute

Controls whether the method is executed asynchronous.

DialogResultPropertyName

The name of the script property to hold the FileDialog form result.

FullFilePathPropertyName

The full path of the files that is saved.

SelectRange

Select a specified range in the workbook.

Overloads

Overload Name Description

General

Select a range using an address.

General

Select a range using an address.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

ActiveCell

The address of the cell to make active after the selection.

AddToSelection

Whether to add the specified range to the current selection.

SendEmail

Send an e-mail message.

Overloads

Overload Name Description

General

Send an e-mail message using Windows Simple MAPI, which supports the option to display the default email client dialog to allow the user to specify recipients and other send options.

SMTP

Send an e-mail message via SMTP. This is the preferred overload.

ServletSMTP

Send an e-mail message via the Dodeca servlet using SMTP.

General

Send an e-mail message using Windows Simple MAPI, which supports the option to display the default email client dialog to allow the user to specify recipients and other send options.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

To

E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon.

cc

E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

bcc

E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

Subject

The subject of the message.

Message

The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE.

Prompt

Whether to prompt the user before sending the message. The default is TRUE.

AttachView

Whether to attach the view to the e-mail message. The default is FALSE.

AttachViewAsPDF

Whether to attach the view as a PDF to the e-mail message. The default is FALSE.

AttachViewAsPDF_Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

AttachViewAsPDF_Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

ZipAttachments

Whether to add all attachments to a .zip file when composing the message. The default is FALSE.

ZipFileName

The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view’s name will be used.

ZipCompression

The compression level to use when sending attachments as a .zip file. The default is Normal.

SMTP

Send an e-mail message via SMTP. This is the preferred overload.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

From

The address from which the email will be sent.

FromDisplayName

The displayed address from which the email will be sent.

To

E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon.

cc

E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

bcc

E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

Subject

The subject of the message.

IsHtmlMessage

Whether the message body contains HTML. The default is FALSE.

Message

The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE.

Host

The SMTP hostname which will send the email.

Port

The SMTP port number on the SMTP host computer.

Security

The connection security type to use when connecting to the server and sending e-mail. The default is None.

Username

The username of the SMTP account used to send the email.

Password

The password of the SMTP account used to send the email.

AttachView

Whether to attach the view to the e-mail message. The default is FALSE.

AttachViewAsPDF

Whether to attach the view as a PDF to the e-mail message. The default is FALSE.

AttachViewAsPDF_Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

AttachViewAsPDF_Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

AttachmentFilenames

Specify the name(s) of the file(s) to attach. To attach multiple files, the filenames must be delimited with the vertical bar (

) character or each filename must be specified on a separate line.

AttachmentFolder

Specify the folder that contains the attachment file(s).

ZipAttachments

Whether to add all attachments to a .zip file when composing the message. The default is FALSE.

ZipFileName

The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view’s name will be used.

ZipCompression

The compression level to use when sending attachments as a .zip file. The default is Normal.

SnapshotRange

The range or ranges (separated by comma) to snapshot.

SnapshotAttachOrEmbed

Whether to attach the snapshot images to the email message or embed them. If embed is used then IsHtmlMessage will be forced to TRUE.

SnapshotFilename

The name to use for the snapshot file. "Snapshot" will be used if left blank.

SnapshotImageFormat

The format of the image file (If left blank Bmp will be used.): Bmp Bitmap Gif Graphics Interchange Format Jpeg Joint Photographic Experts Group Png W3C Portable Network Graphics Tiff Tagged Image File Format

SnapshotInsertToken

If AttachOrEmbed=Embed then the snapshot(s) will be inserted into the message in place of the specified token. If InsertToken is blank then snapshot(s) will be appended to the end of the message.

SnapshotScalePercent

ServletSMTP

Send an e-mail message via the Dodeca servlet using SMTP.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

From

The address from which the email will be sent.

FromDisplayName

The displayed address from which the email will be sent.

To

E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon.

cc

E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

bcc

E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

BounceAddress

E-mail address to which bounce messages are delivered.

Subject

The subject of the message.

IsHtmlMessage

Whether the message body contains HTML. The default is FALSE.

ImageBaseURL

When IsHtmlMessage is TRUE, the domain from which images included in the Message will be served.

Message

The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE.

AlternateText

Alternate text to be used for clients who do not support HTML messages, when IsHtmlMessage is TRUE.

Host

The SMTP hostname which will send the email.

Port

The SMTP port number on the SMTP host computer.

Security

The connection security type to use when connecting to the server and sending e-mail. The default is None.

Username

The username of the SMTP account used to send the email.

Password

The password of the SMTP account used to send the email.

EnableLogging

Whether to log the message details in the server log. The default is FALSE.

AttachView

Whether to attach the view to the e-mail message. The default is FALSE.

AttachViewAsPDF

Whether to attach the view as a PDF to the e-mail message. The default is FALSE.

AttachViewAsPDF_Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

AttachViewAsPDF_Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

AttachmentFilenames

Specify the name(s) of the file(s) to attach. To attach multiple files, the filenames must be delimited with the vertical bar (

) character or each filename must be specified on a separate line.

AttachmentFolder

Specify the folder that contains the attachment file(s).

ZipAttachments

Whether to add all attachments to a .zip file when composing the message. The default is FALSE.

ZipFileName

The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view’s name will be used.

ZipCompression

SetActiveSheet

Make the specified sheet active.

Overloads

Overload Name Description

General

Make the specified sheet active.

General

Make the specified sheet active.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SetActiveWorkbook

Make the specified workbook active.

Overloads

Overload Name Description

General

Make the specified workbook active.

General

Make the specified workbook active.

Argument Description

SpecifySheetBy

Select how to specify which worksheet to select while the method is being executed.

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.

CellCondition

If the result of the condition expression resolves to FALSE, then the current cell is skipped.

SpecifyWorkbookBy

Select how to specify which workbook to make active.

Workbook

The index or name of the workbook to activate, depending on the value of SpecifyWorkbookBy.

SetBorders

Set the borders of cells.

Overloads

Overload Name Description

All

Set border top, left, bottom, right, inside vertical, and inside horizontal.

Color

Set border color.

Diagonal

Set diagonal-up and diagonal-down border.

LineStyle

Set border line style. The SpreadsheetGear control can only render the Excel line styles None, Continuous, and Double. The Excel line styles Dash, DashDot, DashDotDot, Dot, and SlantDashDot are rendered as Continuous. All Excel line styles are maintained and displayed correctly when the workbook is viewed in Excel. The SpreadsheetGear line styles are supported by the LineStyleSG overload.

LineStyleSG

Set the border line style to a style available in the SpreadsheetGear control, which cannot render the Excel line styles Dash, DashDot, DashDotDot, Dot, and SlantDashDot. When using the LineStyle overload, these Excel styles are rendered as the Excel line style Continuous. The LineStyleSG overload provides the line styles None, Dotted, Thin, Medium, Thick, and Double, which render correctly in the SpreadsheetGear control and will look the same when the workbook is viewed in Excel.

None

Remove borders.

Weight

Set border weight.

All

Set border top, left, bottom, right, inside vertical, and inside horizontal.