WBS Documentation, Dodeca 8.2

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>

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 token for one or more Essbase substitution variables.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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)

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.

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.

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.

General

Builds a SQLPassthroughDataSetRange.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

General

Build the view.

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.

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.

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.

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

RESTRequest

Makes an HTTP web request to a REST web service.

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.

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.

General

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

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.

General

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

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.

General

Closes the view.

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.

General

Closes the application.

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.

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.

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.

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.

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.

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.

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.

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.

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

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