WBS Core, Dodeca 8.3

Methods

AddDataCache

Build a DataCache from the results of a script.

Overloads

Overload Name Description

CartesianList

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

DelimitedString

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

SQLPassthroughDataSet

Build a DataCache from a Dodeca SQLPassthroughDataSet.

URL

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

CartesianList

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

Argument Description

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. The script will receive token replacement before being run.

Shared

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

ListDelimiter

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

Delimiter

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

ScriptResultColumnCount

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

DelimitedString

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

Argument Description

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. The 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.

SQLPassthroughDataSet

Build a DataCache from a Dodeca SQLPassthroughDataSet.

Argument Description

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.

URL

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

Argument Description

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. The script will receive token replacement before being run.

AddDataTableRangeRows

Adds rows to a DataTableRange's sheet range.

Overloads

Overload Name Description

RangeAddress

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

RangeName

Adds rows to a DataTableRange's sheet range.

RangeAddress

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

Argument Description

DataTableRangeAddress

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

RowCount

The number of rows to add.

RangeName

Adds rows to a DataTableRange's sheet range.

Argument Description

DataSetRangeName

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

DataTableRangeName

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

GroupSheetRangeName

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

RowCount

The number of rows to add.

AddDefinedName

Add a defined name.

Overloads

Overload Name Description

WorkbookRange

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

WorkbookValue

Add a defined name to the workbook for a value.

WorksheetRange

Add a defined name for a range.

WorksheetValue

Add a defined name for a value.

WorkbookRange

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

Argument Description

DefinedName

The new defined name.

RangeAddress

The range to associate with the defined name.

WorkbookValue

Add a defined name to the workbook for a value.

Argument Description

DefinedName

The new defined name.

Value

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

WorksheetRange

Add a defined name for a range.

Argument Description

DefinedName

The new defined name.

RangeAddress

The range to associate with the defined name.

WorksheetValue

Add a defined name for a value.

Argument Description

DefinedName

The new defined name.

Value

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

AddProperty

Add a property to the workbook script.

Overloads

Overload Name Description

Boolean

Add a boolean property to the workbook script.

Double

Add a double property to the workbook script.

Integer

Add a integer property to the workbook script.

SpecifyDataType

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

String

Add a string property to the workbook script.

Boolean

Add a boolean property to the workbook script.

Argument Description

Initialize

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

PropertyName

The name of the new property.

Value

The value of the new property.

Shared

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

Double

Add a double property to the workbook script.

Argument Description

Initialize

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

PropertyName

The name of the new property.

Value

The value of the new property.

Shared

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

Integer

Add a integer property to the workbook script.

Argument Description

Initialize

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

PropertyName

The name of the new property.

Value

The value of the new property.

Shared

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

SpecifyDataType

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

Argument Description

Initialize

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

PropertyName

The name of the new property.

DataType

The data-type of the new property.

Value

The value of the new property.

AppendToValue

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

Shared

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

String

Add a string property to the workbook script.

Argument Description

Initialize

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

PropertyName

The name of the new property.

Value

The value of the new property.

AppendToValue

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

Delimiter

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

Shared

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

AddToken

Add a token to the workbook script.

Overloads

Overload Name Description

Application

Add an application token to the Dodeca application.

General

Add a temporary token to the Dodeca view.

TargetView

Add a view token to the target view.

View

Add a view token to the Dodeca view.

Application

Add an application token to the Dodeca application.

Argument Description

TokenName

The name of the new token.

Value

The value of the new token.

SyncTokens

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

General

Add a temporary token to the Dodeca view.

Argument Description

TokenName

The name of the new token.

Value

The value of the new token.

TargetView

Add a view token to the target view.

Argument Description

TokenName

The name of the new token.

Value

The value of the new token.

SyncTokens

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

View

Add a view token to the Dodeca view.

Argument Description

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.

AddWorksheet

Add a worksheet to the workbook.

Overloads

Overload Name Description

InPositionByName

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

InPositionByNumber

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

ToBeginning

Insert a new worksheet in the position of first sheet.

ToEnd

Add a new worksheet as the last sheet.

InPositionByName

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

Argument Description

NewSheetName

The new name of the new sheet.

SheetName

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

InPositionByNumber

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

Argument Description

NewSheetName

The new name of the new sheet.

SheetNumber

The number position to insert the sheet at.

ToBeginning

Insert a new worksheet in the position of first sheet.

Argument Description

NewSheetName

The new name of the new sheet.

ToEnd

Add a new worksheet as the last sheet.

Argument Description

NewSheetName

The new name of the new sheet.

AttachmentOperations

Operations related to Dodeca Attachments.

Since version 8.3

Overloads

Overload Name Description

AttachFile

Attaches the specified file.

AttachFileShortcut

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

AttachUrlShortcut

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

Delete

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

Export

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

Open

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

AttachFile

Attaches the specified file.

Argument Description

Filename

The name of the file to attach.

Folder

The path to the folder that contains the specified file.

Description

The description of the new attachment.

IncrementName

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

KeyItems

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

AllowedFileTypes

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

MaximumFileSize

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

MaximumAttachments

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

UseDialog

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

DialogTitle

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

DialogResultPropertyName

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

IdPropertyName

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

FullFilePathPropertyName

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

AttachFileShortcut

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

Argument Description

Filename

The name of the file to attach.

Folder

The path to the folder that contains the specified file.

Description

The description of the new attachment.

IncrementName

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

KeyItems

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

AllowedFileTypes

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

MaximumAttachments

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

UseDialog

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

DialogTitle

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

DialogResultPropertyName

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

IdPropertyName

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

FullFilePathPropertyName

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

AttachUrlShortcut

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

Argument Description

URL

The URL to create the shortcut for.

Name

The name of the attachment.

Description

The description of the new attachment.

IncrementName

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

KeyItems

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

MaximumAttachments

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

UseDialog

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

DialogTitle

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

DialogResultPropertyName

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

UrlPropertyName

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

NamePropertyName

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

DescriptionPropertyName

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

IdPropertyName

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

Delete

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

Argument Description

AttachmentID

The AttachmentID.

Name

The name of the attachment.

KeyItems

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

CountPropertyName

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

IdListPropertyName

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

Export

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

Argument Description

AttachmentID

The AttachmentID.

Name

The name of the attachment.

KeyItems

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

Folder

The path to the folder that contains the specified file.

FileExistsPolicy

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

UseDialog

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

DialogTitle

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

DialogResultPropertyName

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

CountPropertyName

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

FolderPropertyName

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

FilePathsListPropertyName

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

IdListPropertyName

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

NamesListPropertyName

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

Open

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

Argument Description

AttachmentID

The AttachmentID.

Name

The name of the attachment.

KeyItems

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

Folder

The path to the folder that contains the specified file.

FileExistsPolicy

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

UseDialog

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

DialogTitle

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

DialogResultPropertyName

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

FolderPropertyName

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

FullFilePathPropertyName

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

NamePropertyName

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

IdPropertyName

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

BinaryArtifactOperations

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

Since version 7.7

Overloads

Overload Name Description

AddSheet

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

AddWorkbook

Add all worksheets from the current view to a specified BinaryArtifact

CreateFromFile

Create a BinaryArtifact from a file.

CreateFromSheet

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

CreateFromWorkbook

Create a BinaryArtifact from the workbook of the current view.

Delete

Delete a specified BinaryArtifact.

ImportRange

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

ImportSheet

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

ImportWorkbook

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

AddSheet

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

Argument Description

SheetName

Specify the binary artifact sheet-name.

NewSheetName

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

ID

Specify the ID of the binary artifact. (Required)

VersionPolicy

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

SpecificVersion

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

ValuesOnly

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

ToPositionPolicy

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

ToPosition

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

Password

The password assigned to the saved workbook.

AddWorkbook

Add all worksheets from the current view to a specified BinaryArtifact

Argument Description

ID

Specify the ID of the binary artifact. (Required)

VersionPolicy

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

SpecificVersion

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

ValuesOnly

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

ToPositionPolicy

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

ToPosition

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

Password

The password assigned to the saved workbook.

CreateFromFile

Create a BinaryArtifact from a file.

Argument Description

Type

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

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

ID

Specify the ID of the binary artifact. (Required)

Name

Specify the name of the binary artifact.

Description

Specify the description for the binary artifact.

VersionPolicy

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

SpecificVersion

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

Filename

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

Folder

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

ValuesOnly

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

Password

The password assigned to the saved workbook.

CreateFromSheet

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

Argument Description

SheetName

Specify the binary artifact sheet-name.

Type

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

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

ID

Specify the ID of the binary artifact. (Required)

Name

Specify the name of the binary artifact.

Description

Specify the description for the binary artifact.

VersionPolicy

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

SpecificVersion

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

ValuesOnly

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

Filename

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

FileType

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

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

Password

The password assigned to the saved workbook.

CreateFromWorkbook

Create a BinaryArtifact from the workbook of the current view.

Argument Description

Type

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

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

ID

Specify the ID of the binary artifact. (Required)

Name

Specify the name of the binary artifact.

Description

Specify the description for the binary artifact.

VersionPolicy

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

SpecificVersion

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

ValuesOnly

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

Filename

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

FileType

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

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

Password

The password assigned to the saved workbook.

Delete

Delete a specified BinaryArtifact.

Argument Description

ID

Specify the ID of the binary artifact. (Required)

DeleteVersionPolicy

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

SpecificVersion

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

ImportRange

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

Argument Description

ID

Specify the ID of the binary artifact. (Required)

ImportVersionPolicy

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

SpecificVersion

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

CopyRange

The range from the specified BinaryArtifact that will be copied into the current workbook.

PasteRange

The address in the current workbook to copy the CopyRange's cells to.

OutputRangeName

The range where the range is imported to will be given the specified name.

InsertPolicy

Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. <blank> = Overwrite the paste range Rows = Insert the number of rows in the from-range at the first row of the paste range. Columns = Insert the number of columns in the from-range at the first column of the paste range. RowsAndColumns = Insert both rows and columns. ShiftCellsRight = Shift the cells in the paste range to the right. ShiftCellsDown = Shift the cells in the paste range to down.

PasteType

Specifies the type of paste to perform.

PasteOperation

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

CopyColumnWidths

Whether to copy the column widths of the copy range.

CopyRowHeights

Whether to copy the row heights of the copy range.

SkipBlanks

If cells in the copy range are empty, then the corresponding cells in the paste range are left unchanged. Defaults to FALSE if left blank. For consistency with the standard paste tool, this value should be set to TRUE.

Transpose

Rows become columns. Columns become rows.

Password

The password assigned to the saved workbook.

ImportSheet

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

Argument Description

ID

Specify the ID of the binary artifact. (Required)

ImportVersionPolicy

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

SpecificVersion

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

ValuesOnly

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

SheetName

Specify the binary artifact sheet-name.

NewSheetName

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

ToPositionPolicy

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

ToPosition

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

Password

The password assigned to the saved workbook.

ImportWorkbook

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

Argument Description

ID

Specify the ID of the binary artifact. (Required)

ImportVersionPolicy

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

SpecificVersion

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

ToPositionPolicy

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

ToPosition

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

Password

The password assigned to the saved workbook.

BuildDataSetRange

Builds a SQLPassthroughDataSetRange.

Overloads

Overload Name Description

General

Builds a SQLPassthroughDataSetRange.

General

Builds a SQLPassthroughDataSetRange.

Argument Description

DataSetRangeName

The name of the view's SQLPassthroughDataSetRange to build.

CoverDuringBuild

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

BuildRangeFromScript

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

Overloads

Overload Name Description

CartesianList

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

DataCache

Build a range on the sheet based on a DataCache created using the AddDataCache method.

DelimitedString

Loop a list of values specified by a delimited string.

ImportRange

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

SQLPassthroughDataSet

Build a range on the sheet based on a Dodeca SQLPassthroughDataSet.

URL

Loop values returned in XML format from a URL. Nodes named "value" will be used in the loop.

CartesianList

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

Argument Description

ScriptText

The text of the script that will be run. The script will receive token replacement before being run.

ListDelimiter

The delimiter to use to define the end of each List.

Delimiter

The delimiter to use to define the end of each value.

StartCell

The address of the cell that the first row of script output goes into.

ScriptResultColumnCount

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

OutputMap

A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

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

HandleDuplicates

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

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

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

Insert

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

OutputRangeName

The range where the script output is put will be given the specified name.

DataCache

Build a range on the sheet based on a DataCache created using the AddDataCache method.

Argument Description

DataCacheName

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

SortOrder

Specifies one or more columns of the DataCache to sort by.

Example: Col1 Example: Col1, Col3 Example: "Col2 DESC, Col1 ASC"

StartCell

The address of the cell that the first row of script output goes into.

ScriptResultColumnCount

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

OutputMap

A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

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

HandleDuplicates

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

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

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

Insert

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

OutputRangeName

The range where the script output is put will be given the specified name.

DelimitedString

Loop a list of values specified by a delimited string.

Argument Description

ScriptText

The text of the script that will be run. The script will receive token replacement before being run.

Delimiter

The delimiter to use to define the end of each value.

StartCell

The address of the cell that the first row of script output goes into.

ScriptResultColumnCount

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

OutputMap

A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

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.

ImportRange

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

Argument Description

ID

Specify the ID of the binary artifact. (Required)

VersionPolicy

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

SpecificVersion

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

CopyRange

The range from the specified BinaryArtifact that will be copied into the current workbook.

PasteRange

The address in the current workbook to copy the CopyRange's cells to.

OutputRangeName

The range where the script output is put will be given the specified name.

InsertPolicy

Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. <blank> = Overwrite the paste range Rows = Insert the number of rows in the from-range at the first row of the paste range. Columns = Insert the number of columns in the from-range at the first column of the paste range. RowsAndColumns = Insert both rows and columns. ShiftCellsRight = Shift the cells in the paste range to the right. ShiftCellsDown = Shift the cells in the paste range to down.

PasteType

Specifies the type of paste to perform.

PasteOperation

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

CopyColumnWidths

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

CopyRowHeights

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

SkipBlanks

If cells in the copy range are empty, then the corresponding cells in the paste range are left unchanged. Defaults to FALSE if left blank. For consistency with the standard paste tool, this value should be set to TRUE.

Transpose

Rows become columns. Columns become rows.

Password

The password of the BinaryArtifact workbook.

SQLPassthroughDataSet

Build a range on the sheet based on a Dodeca SQLPassthroughDataSet.

Argument Description

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.

URL

Loop values returned in XML format from a URL. Nodes named "value" will be used in the loop.

Argument Description

ScriptText

The text of the script that will be run. The script will receive token replacement before being run.

StartCell

The address of the cell that the first row of script output goes into.

BuildRowsOrColumns

Whether to build rows or columns from the script results.

EnterDatesAsText

Whether to treat a date value as text. When set to False, each valid date or date/time value returned by the script will be assigned to the cell as a date value. The number format of a cell that contains a date value should be set to Date; otherwise, the cell value will appear as the numeric value that is stored by Excel internally to represent dates. By default, EnterDatesAsText is True.

EnterNumbersAsText

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

CopyFromRange

The specified range will be copied for each row of output from the script.

CopyToRange

Specifies where the CopyFromRange will be copied to.

DoInsert

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

Insert

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

OutputRangeName

The range where the script output is put will be given the specified name.

OutputMap

A comma delimited string of rows or columns that the columns of the script results are written to. If BuildRowsOrColumns is Rows, then the script result's columns are written to the specified columns. If BuildRowsOrColumns is Columns, then the script result's columns are written to the specified rows.

BuildView

Build the view.

Overloads

Overload Name Description

General

Build the view.

General

Build the view.

Argument Description

CoverDuringBuild

Controls whether the view is covered during the build.

Calculate

Calculates Excel formulas in the workbook.

Overloads

Overload Name Description

AllWorkbooksAsNeeded

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

AllWorkbooksFull

Calculates all formulas in all workbooks.

AllWorkbooksAsNeeded

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

Argument Description

AllWorkbooksFull

Calculates all formulas in all workbooks.

Argument Description

CancelEvent

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

Overloads

Overload Name Description

General

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

General

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

Argument Description

Cancel

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

OnCancelProcedure

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

ClearRange

Clear a specified range in the workbook.

Overloads

Overload Name Description

General

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

General

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

Argument Description

Clear

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

Close

Closes the view.

Overloads

Overload Name Description

General

Closes the view.

General

Closes the view.

Argument Description

Close

Determines whether the view is closed.

CloseApplication

Closes the application.

Overloads

Overload Name Description

General

Closes the application.

General

Closes the application.

Argument Description

Close

Controls whether the application is closed.

CommentOperations

Operations related to Dodeca Comments.

Since version 8.0

Overloads

Overload Name Description

Add

Add a Dodeca comment.

Copy

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

DeleteByCommentID

Delete the Dodeca comment that has the specified CommentID.

DeleteByKeyHash

Delete all Dodeca comments that have the specified KeyHash.

DeleteByKeyItems

Delete all Dodeca comments that have the specified KeyItems.

Load

Load comments for the specified worksheet(s).

Save

Save the view's Dodeca comments.

Add

Add a Dodeca comment.

Argument Description

CommentText

The text of the new comment.

KeyItems

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

Context

The Context of the Comment.

Subject

The Subject of the comment.

ParentCommentID

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

NewCommentIdPropertyName

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

NewKeyHashPropertyName

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

Copy

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

Argument Description

Source

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

Example: Scenario=Budget;Year=Jan|Scenario=Budget;Year=Feb

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

Target

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

Example: Scenario=Forecast;Year=Jan|Scenario=Forecast;Year=Feb

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

BackgroundExecute

Controls whether the method is executed asynchronous.

DeleteByCommentID

Delete the Dodeca comment that has the specified CommentID.

Argument Description

CommentID

The ID of the comment.

DeletedCountPropertyName

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

DeleteByKeyHash

Delete all Dodeca comments that have the specified KeyHash.

Argument Description

KeyHash

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

DeletedCountPropertyName

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

DeleteByKeyItems

Delete all Dodeca comments that have the specified KeyItems.

Argument Description

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. MatchAny is FALSE by default. SPECIFYING TRUE SHOULD BE DONE WITH CAUTION. If TRUE, then comments that have all of the specified KeyItems will be matched, even though they may also have other KeyItems as well. MatchAny only functions on comments that are in context in the view.

DeletedCountPropertyName

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

Load

Load comments for the specified worksheet(s).

Argument Description

Save

Save the view's Dodeca comments.

Argument Description

CopyComments

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

Overloads

Overload Name Description

General

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

General

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

Argument Description

Source

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

Example: Scenario=Budget;Year=Jan|Scenario=Budget;Year=Feb

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

Target

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

Example: Scenario=Forecast;Year=Jan|Scenario=Forecast;Year=Feb

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

BackgroundExecute

Controls whether the method is executed asynchronous.

CopyFromBinaryArtifact

Copy from a specifed Excel Binary Artifact.

Since version 7.3

Overloads

Overload Name Description

Range

Copy a range and specify the paste options.

Sheet

Copy a worksheet.

Range

Copy a range and specify the paste options.

Argument Description

BinaryArtifactID

The ID of the source Excel Binary Artifact.

VersionPolicy

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

BinaryArtifactVersion

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

Password

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

CopyRange

The address of the range to copy from.

PasteRange

The address of the range to paste into.

OutputRangeName

The range where the range is imported to will be given the specified name.

InsertPolicy

Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. <blank> = Overwrite the paste range Rows = Insert the number of rows in the from-range at the first row of the paste range. Columns = Insert the number of columns in the from-range at the first column of the paste range. RowsAndColumns = Insert both rows and columns. ShiftCellsRight = Shift the cells in the paste range to the right. ShiftCellsDown = Shift the cells in the paste range to down.

PasteType

Specifies the type of copy to perform.

PasteOperation

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

CopyColumnWidths

Whether to copy the column widths of the copy range.

CopyRowHeights

Whether to copy the row heights of the copy range.

SkipBlanks

If cells in the copy range are empty, then the corresponding cells in the paste range are left unchanged. Defaults to FALSE if left blank. For consistency with the standard paste tool, this value should be set to TRUE.

Transpose

Rows become columns. Columns become rows.

Sheet

Copy a worksheet.

Argument Description

BinaryArtifactID

The ID of the source Excel Binary Artifact.

BinaryArtifactVersion

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

Password

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

SpecifyFromBy

Select how to specify which worksheet to copy.

FromSheetSpec

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

SpecifyToPosition

Select how to specify where to copy the worksheet to.

ToPosition

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

NewSheetName

The name of the new sheet.

CopyRange

Copy a specifed range in the workbook.

Overloads

Overload Name Description

AsImage

Copy a specified workbook range as an image to a specified location.

ColumnWidth

Copy the column widths of a specified range.

FromFile

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

General

Copy a specified range.

RowHeight

Copy the row heights a specified range.

Specify

Copy a range and specify the paste options.

ToClipboardAsImage

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

ToFileAsImage

Copy a specified workbook range to an image file.

AsImage

Copy a specified workbook range as an image to a specified location.

Argument Description

CopyRange

The address of the range to copy.

ImageName

The name assigned to the image. This can be used to identify the image after it is created.

OnClickProcedure

The name of the procedure to execute when the image is clicked. The worksheet must be protected and the image locked for OnClick to work.

Placement

The placement behavior of the image. FreeFloating: Do not move with cells. Move: Move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the image into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the image. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the image in points. If used with the Column argument then the two are added together.

Row

The row to put the image into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the image. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the image in points. If used with the Row argument then the two are added together.

Width

The width of the image in points. The EndColumn argument can be used instead of this.

Height

The height of the image in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the image's aspect ratio is locked.

Locked

Whether the image is locked.

Visible

Whether the image is visible.

PrintImage

Whether to print the image.

BorderColor

Select the color for the border's forecolor.

BorderColorIndex

Excel color palette index to use for the border's forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the border is visible.

BorderWeight

The weight of the border, in points.

ColumnWidth

Copy the column widths of a specified range.

Argument Description

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

FromFile

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

Argument Description

Filename

Specify the name of the file to copy from.

Folder

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

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

OutputRangeName

The range where the range is imported to will be given the specified name.

InsertPolicy

Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. <blank> = Overwrite the paste range Rows = Insert the number of rows in the from-range at the first row of the paste range. Columns = Insert the number of columns in the from-range at the first column of the paste range. RowsAndColumns = Insert both rows and columns. ShiftCellsRight = Shift the cells in the paste range to the right. ShiftCellsDown = Shift the cells in the paste range to down.

PasteType

Specifies the type of copy to perform.

PasteOperation

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

CopyColumnWidths

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

CopyRowHeights

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

SkipBlanks

If cells in the copy range are empty, then the corresponding cells in the paste range are left unchanged. Defaults to FALSE if left blank. For consistency with the standard paste tool, this value should be set to TRUE.

Transpose

Rows become columns. Columns become rows.

Password

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

General

Copy a specified range.

Argument Description

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

Cut

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

InsertPolicy

Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. <blank> = Overwrite the paste range Rows = Insert the number of rows in the from-range at the first row of the paste range. Columns = Insert the number of columns in the from-range at the first column of the paste range. RowsAndColumns = Insert both rows and columns. ShiftCellsRight = Shift the cells in the paste range to the right. ShiftCellsDown = Shift the cells in the paste range to down.

RowHeight

Copy the row heights a specified range.

Argument Description

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

Specify

Copy a range and specify the paste options.

Argument Description

CopyRange

The address of the range to copy.

PasteRange

The address of the range to paste into.

Cut

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

InsertPolicy

Determines whether/how to insert the copied range. If not specified then the copied range will overwrite the paste range. <blank> = Overwrite the paste range Rows = Insert the number of rows in the from-range at the first row of the paste range. Columns = Insert the number of columns in the from-range at the first column of the paste range. RowsAndColumns = Insert both rows and columns. ShiftCellsRight = Shift the cells in the paste range to the right. ShiftCellsDown = Shift the cells in the paste range to down.

PasteType

Specifies the type of copy to perform.

PasteOperation

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

SkipBlanks

If cells in the copy range are empty, then the corresponding cells in the paste range are left unchanged. Defaults to FALSE if left blank. For consistency with the standard paste tool, this value should be set to TRUE.

Transpose

Rows become columns. Columns become rows.

ToClipboardAsImage

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

Argument Description

CopyRange

The address of the range to copy.

ScalePercent

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

ToFileAsImage

Copy a specified workbook range to an image file.

Argument Description

CopyRange

The address of the range to copy.

ScalePercent

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

ImageFormat

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

ImageFilename

Specify the name of the file image file.

Folder

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

IncrementFilename

Whether to add a subscript, such as (2), to the filename if the specified file already exists. If not set to TRUE, an existing file with the same name will be overwritten.

UseDialog

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

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

CopyWorksheet

Copy a specified worksheet in the workbook.

Overloads

Overload Name Description

FromFile

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

General

Copy a worksheet.

FromFile

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

Argument Description

Filename

Specify the name of the file to copy from.

Folder

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

ValuesOnly

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

SheetName

Specify the name of the sheet to copy.

NewSheetName

The name of the new sheet.

ToPositionPolicy

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

ToPosition

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

Password

The password assigned to the saved workbook.

General

Copy a worksheet.

Argument Description

FromWorkbook

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

SpecifyFromBy

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

FromSheetSpec

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

SpecifyToPosition

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

ToPosition

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

NewSheetName

The name of the new sheet.

DeleteBinaryArtifact

Delete a specified binary artifact or binary artifact version.

Since version 7.2

Overloads

Overload Name Description

General

Delete a specified binary artifact or binary artifact version.

General

Delete a specified binary artifact or binary artifact version.

Argument Description

BinaryArtifactID

The ID of the binary artifact to delete.

DeletionPolicy

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

SpecificVersion

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

DeleteBreak

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

Since version 7.2

Overloads

Overload Name Description

All

Deletes all page breaks from the sheet.

General

Deletes a page break or breaks from the sheet.

All

Deletes all page breaks from the sheet.

Argument Description

General

Deletes a page break or breaks from the sheet.

Argument Description

DeleteBreakAddress

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

DeleteDataTableRangeRows

Deletes rows from a DataTableRange's sheet range.

Overloads

Overload Name Description

General

Deletes rows from a DataTableRange's sheet range.

General

Deletes rows from a DataTableRange's sheet range.

Argument Description

RowsAddress

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

DeleteFile

Deletes a specified file.

Since version 7.2

Overloads

Overload Name Description

General

Deletes a specified file.

General

Deletes a specified file.

Argument Description

Filename

Specify the name of the file to delete.

Folder

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

DeleteRange

Delete cells from one or all sheets.

Overloads

Overload Name Description

General

Delete cells.

General

Delete cells.

Argument Description

DeleteRange

The address of the cells to delete.

ShiftDirection

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

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

VisibleOnly

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

ExecuteProcedure

Execute a specified workbook script procedure.

Overloads

Overload Name Description

General

Execute a workbook script procedure.

ToolAction

Use to execute a workbook script procedure for a specific tool. Use this overload in conjunction with the ToolClicked and/or ToolValueChanged eventlinks.

General

Execute a workbook script procedure.

Argument Description

Procedure

The name of the procedure to execute.

Break

Use this argument to conditionally exit this procedure. This argument will be evaluated only after calling the specified procedure.

ToolAction

Use to execute a workbook script procedure for a specific tool. Use this overload in conjunction with the ToolClicked and/or ToolValueChanged eventlinks.

Argument Description

Procedure

The name of the procedure to execute.

ToolKey

The key of the tool that the execution of the procedure depends on. If left blank the specified procedure will run for any tool.

Break

Use this argument to conditionally exit this procedure. This argument will be evaluated only after calling the specified procedure.

ExitProcedure

Exit the workbook script procedure if the Method condition evaluates to TRUE. If run CellByCell then a CellCondition of TRUE in any cell will exit the procedure.

Overloads

Overload Name Description

General

Exit the procedure if the MethodCondition evaluates to TRUE. If run CellByCell then a CellCondition of TRUE in any cell will exit the procedure.

General

Exit the procedure if the MethodCondition evaluates to TRUE. If run CellByCell then a CellCondition of TRUE in any cell will exit the procedure.

Argument Description

Exit

Determines whether the current procedure is exited.

ExportToExcel

Export the view to an Excel file.

Overloads

Overload Name Description

General

Export the view to an Excel file. The exported file retains the point-of-view, which is used to restore the selected items when the file is imported, using the Import View from Excel tool. For an Essbase Excel view, the cell values within defined send ranges (i.e. Ess.Send.Range.x) are also restored when the file is imported.

General

Export the view to an Excel file. The exported file retains the point-of-view, which is used to restore the selected items when the file is imported, using the Import View from Excel tool. For an Essbase Excel view, the cell values within defined send ranges (i.e. Ess.Send.Range.x) are also restored when the file is imported.

Argument Description

Filename

Specify the name of the Excel file. When UseDialog is TRUE, the file name is used as the default file name presented in the Save File dialog. When UseDialog is FALSE, the file name is used as the exported Excel file name.

Folder

Specify the folder to save the Excel file to. When UseDialog is TRUE, the folder is used as the default folder presented in the Save File dialog. When UseDialog is FALSE, the folder is used as the location of the exported Excel file.

IncrementFilename

Whether to add a subscript, such as (2), to the filename if the specified file already exists. If not set to TRUE, an existing file with the same name will be overwritten. This argument is only applicable when UseDialog is FALSE.

UseDialog

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

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

Password

Each protected worksheet is password protected with the specified value in order to prevent a user from unprotecting the worksheet in the exported Excel file. If no password is specified, the view's ExportToExcelProtectedWorksheetPassword is used as the password.

Filter

Filter a specified range.

Since version 7.4

Overloads

Overload Name Description

AboveAverage

Select the items that are above the average in the specified column.

BeginsWith

Select the items that begin with the specified value from the filter of the specified column.

BelowAverage

Select the items that are below the average in the specified column.

Between

Select the items that lie between two values (inclusive) from the filter of the specified column.

BottomX

Select the bottom X items from the filter of the specified column, where X is a specified number value.

BottomXPercent

Select the bottom X percent items from the filter of the specified column, where X is a specified percent value.

Clear

Clear all selections from all filters on the sheet.

Contains

Select the items that contain the specified value from the filter of the specified column.

DoesNotBeginWith

Select the items that do not begin with the specified value from the filter of the specified column.

DoesNotContain

Select the items that do not contain the specified value from the filter of the specified column.

DoesNotEndWith

Select the items that do not end with the specified value from the filter of the specified column.

DoesNotEqual

Select all values except for specified value.

EndsWith

Select the items that end with the specified value from the filter of the specified column.

Equals

Select one specific value from the filter of the specified column.

FiltersOff

Turn off filtering for the specified range.

FiltersOn

Turn on filtering for the specified range. Functions as a toggle if filters are already on.

GreaterThan

Select the items that are greater than the specified value from the filter of the specified column.

GreaterThanOrEqual

Select the items that are greater than or equal to the specified value from the filter of the specified column.

InList

Select a list of values from the filter of the specified column.

LessThan

Select the items that are less than the specified value from the filter of the specified column.

LessThanOrEqual

Select the items that are less than or equal to the specified value from the filter of the specified column.

NotInList

Select the values from the filter that are not in the specified list.

TopX

Select the top X items from the filter of the specified column, where X is a specified number value.

TopXPercent

Select the top X percent items from the filter of the specified column, where X is a specified percent value.

AboveAverage

Select the items that are above the average in the specified column.

Argument Description

ColumnNumber

The column number of the filter.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

BeginsWith

Select the items that begin with the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

BelowAverage

Select the items that are below the average in the specified column.

Argument Description

ColumnNumber

The column number of the filter.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

Between

Select the items that lie between two values (inclusive) from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

LowValue

The lower value to use in the between range.

HighValue

The higher value to use in the between range.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

BottomX

Select the bottom X items from the filter of the specified column, where X is a specified number value.

Argument Description

ColumnNumber

The column number of the filter.

ValueOfX

The value to use in Top and Bottom filters.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

BottomXPercent

Select the bottom X percent items from the filter of the specified column, where X is a specified percent value.

Argument Description

ColumnNumber

The column number of the filter.

ValueOfX

The value to use in Top and Bottom filters.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

Clear

Clear all selections from all filters on the sheet.

Argument Description

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

Contains

Select the items that contain the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

DoesNotBeginWith

Select the items that do not begin with the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

DoesNotContain

Select the items that do not contain the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

DoesNotEndWith

Select the items that do not end with the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

DoesNotEqual

Select all values except for specified value.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

EndsWith

Select the items that end with the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

Equals

Select one specific value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

FiltersOff

Turn off filtering for the specified range.

Argument Description

FiltersOn

Turn on filtering for the specified range. Functions as a toggle if filters are already on.

Argument Description

GreaterThan

Select the items that are greater than the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

GreaterThanOrEqual

Select the items that are greater than or equal to the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

InList

Select a list of values from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

List

The list of values to select in the specified column.

Delimiter

The delimiter to use to parse the list of values. Comma, ",", is the default.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

LessThan

Select the items that are less than the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

LessThanOrEqual

Select the items that are less than or equal to the specified value from the filter of the specified column.

Argument Description

ColumnNumber

The column number of the filter.

Value

The value to select.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

NotInList

Select the values from the filter that are not in the specified list.

Argument Description

ColumnNumber

The column number of the filter.

List

The list of values to select in the specified column.

Delimiter

The delimiter to use to parse the list of values. Comma, ",", is the default.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

TopX

Select the top X items from the filter of the specified column, where X is a specified number value.

Argument Description

ColumnNumber

The column number of the filter.

ValueOfX

The value to use in Top and Bottom filters.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

TopXPercent

Select the top X percent items from the filter of the specified column, where X is a specified percent value.

Argument Description

ColumnNumber

The column number of the filter.

ValueOfX

The value to use in Top and Bottom filters.

ClearFirst

Whether to clear other selections from the filter before applying the selection.

ShowDropdown

Wheter the filter's dropdown should be displayed after applying the selection.

ForEach

Execute a procedure for each value of a list or number range.

Overloads

Overload Name Description

DataCache

Execute a Procedure for each row in a DataCache.

FileInFolder

Execute a Procedure for each file in a specified folder.

NumberToNumber

Execute a Procedure for each number of a specified range.

SqlDataCache

Execute a Procedure for each row in a DataCache created using AddDataCache.SQLPassthroughDataSet.

A workbook script property with the name of the column will be added for each column of the SqlDataCache as each row of the SqlDataCache is processed by the ForEach method.

If PropertyNamePrefix argument is specified then the name of each property added will be prepended with the PropertyNamePrefix like [PropertyNamePrefix][ColumnName].

The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

DataCache

Execute a Procedure for each row in a DataCache.

Argument Description

DataCacheName

The name of the data-cache that contains the values.

SortOrder

Specifies one or more columns of the DataCache to sort by.

Example: Col1 Example: Col1, Col3 Example: "Col2 DESC, Col1 ASC"

Procedure

The name of the procedure to execute.

ExitLoopCondition

Condition evaluated before each iteration of the ForEach loop. If the condition evaluates to True, the loop is exited.

ColumnNumber

The column number to get each value from. Use ColumnNumber in conjunction with PropertyName to produce a property with the value of the specified column number with each iteration of the ForEach.

PropertyName

If PropertyName is specified, a script property will be added with the value specified by the ColumnNumber argument on each iteration of the ForEach loop with the specified name.

The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

FileInFolder

Execute a Procedure for each file in a specified folder.

Argument Description

Folder

The full path of the folder to iterate through.

SubFolders

Whether to iterate through the specified folder's subfolders. If left blank FALSE will be used.

FileMatchPattern

Wild-carded file name like *.xlsx. If left blank all files will be processed.

UseDialog

Whether to prompt the user to select a folder. If left blank FALSE will be used.

Procedure

The name of the procedure to execute.

DialogResultPropertyName

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

ExitLoopCondition

Condition evaluated before each iteration of the ForEach loop. If the condition evaluates to True, the loop is exited.

FileNamePropertyName

If FileNamePropertyName is specified a workbook script property with the specified name will be added with the value of the current file's name. The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

FilePathPropertyName

If FilePathPropertyName is specified a workbook script property with the specified name will be added with the value of the current file's full path. The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

FolderPropertyName

If FolderPropertyName is specified a workbook script property with the specified name will be added with the value of the current file's folder path. The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

NumberToNumber

Execute a Procedure for each number of a specified range.

Argument Description

StartNumber

The number to begin the ForEach with.

EndNumber

The number to end the ForEach on.

Procedure

The name of the procedure to execute.

ExitLoopCondition

Condition evaluated before each iteration of the ForEach loop. If the condition evaluates to True, the loop is exited.

PropertyName

If PropertyName is specified, a script property will be added with the value specified by the ColumnNumber argument on each iteration of the ForEach loop with the specified name.

The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

SqlDataCache

++Execute a Procedure for each row in a DataCache created using AddDataCache.SQLPassthroughDataSet.

A workbook script property with the name of the column will be added for each column of the SqlDataCache as each row of the SqlDataCache is processed by the ForEach method.
If PropertyNamePrefix argument is specified then the name of each property added will be prepended with the PropertyNamePrefix like [PropertyNamePrefix][ColumnName].
The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property. ++
Argument Description

DataCacheName

The name of the data-cache that contains the values.

SortOrder

Specifies one or more columns of the DataCache to sort by.

Example: Col1 Example: Col1, Col3 Example: "Col2 DESC, Col1 ASC"

Procedure

The name of the procedure to execute.

ExitLoopCondition

Condition evaluated before each iteration of the ForEach loop. If the condition evaluates to True, the loop is exited.

PropertyNamePrefix

If PropertyNamePrefix is specified the name of each workbook script property will be prepended with the prefix like [PropertyNamePrefix][ColumnName].

The @PVal(<PropertyName>) function can be used within the specified Procedure to get the current value of this property.

InsertBreak

Insert a break or breaks into one or all sheets.

Since version 7.2

Overloads

Overload Name Description

Dynamic

Insert page breaks at the specified page height.

General

Insert a single page break.

Dynamic

Insert page breaks at the specified page height.

Argument Description

FlagColumn

(Optional) The column that contains a TRUE/FALSE flag that represents whether a particular row is a candidate for a page break.

PageHeight

The page height in pixels where the break is inserted.

General

Insert a single page break.

Argument Description

InsertAddress

The address to insert the range at.

InsertRange

Insert a range into one or all sheets.

Overloads

Overload Name Description

General

Insert cells.

General

Insert cells.

Argument Description

InsertAddress

The address to insert the range at.

ShiftDirection

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

Using ShiftRight will move the cells to the right of any cells in the specified range to the right. Using ShiftDown will move the cells below of any cells in the specified range down. Using ShiftEntireColumnExcel will insert the entire column of any cells in the sprecified range. Using ShiftEntireRowExcel will insert the entire row of any cells in the sprecified range.

LoadWorkbook

Load a workbook from an Excel Binary Artifact.

Overloads

Overload Name Description

General

Load an Excel Binary Artifact.

General

Load an Excel Binary Artifact.

Argument Description

ExcelArtifactIDandVersion

The ID and version of the ExcelBinaryArtifact to load.

Password

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

MoveWorksheet

Move a specified worksheet within the workbook.

Overloads

Overload Name Description

General

Move a worksheet.

General

Move a worksheet.

Argument Description

SpecifyToPosition

Select how to specify where to move the worksheet to.

ToPosition

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

OpenBinaryArtifact

Open a specified binary artifact, using the default editor on the system.

Since version 7.2

Overloads

Overload Name Description

General

Open a specified binary artifact, using the default editor on the system.

General

Open a specified binary artifact, using the default editor on the system.

Argument Description

BinaryArtifactID

The ID of the Binary Artifact to open.

VersionPolicy

Specifies whether to open the latest version of the Binary Artifact or a specific version specified by the SpecificVersion argument.

SpecificVersion

The version of the Binary Artifact to open when using the VersionPolicy argument is set to Specific.

OpenView

Open a specified view.

Overloads

Overload Name Description

General

Open a specified view, and optionally build and/or close the view.

General

Open a specified view, and optionally build and/or close the view.

Argument Description

ViewID

The ID of the view to open.

AutoBuildOnOpen

Whether the view should autobuild, or wait for the user to click the build button. Leave blank to use the view's AutoBuildOnOpen property.

ShareViewTokens

Whether the current view's tokens are added as tokens to the opened view. When added, the tokens are used to set default selections, when applicable, and can be referenced in workbook scripts, SQLPassthroughDataSets, etc. as used by the opened view.

ShareSelectorTokens

Whether the current view's selector tokens are added as tokens to the opened view. When added, the tokens are used to set default selections, when applicable, and can be referenced in workbook scripts, SQLPassthroughDataSets, etc. as used by the opened view.

ShowViewAsActiveWindow

Whether the opened view's window becomes the active window. By default, the view's window is activated.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the opening or building of the view returns an exception.

Close

Controls whether the view should be closed after opening and automatically building. If specified, the ClosePolicy argument takes precedence over the Close argument. By default, if neither argument is specified, the view is not closed.

ClosePolicy

Controls whether the view should be closed after opening and automatically building. The ClosePolicy argument provides more control over whether the view is closed and, if specified, takes precedence over the Close argument. By default, if neither argument is specified, the view is not closed.

PowerPointOperations

Create and update PowerPoint files.

Since version 8.3

Overloads

Overload Name Description

Close

Closes PowerPoint.

CloseFile

Closes a specified file or all files depending on whether a file is specified.

CopyRange

Copy a worksheet range to a PowerPoint slide as an image.

NewFile

Opens a new PowerPoint file for subsequent PowerPoint operations.

OpenFile

Opens an existing PowerPoint file for subsequent PowerPoint operations.

RemoveImage

Remove an image from a PowerPoint slide.

RemoveSlide

Remove an slide from a PowerPoint presentation.

ReplaceImage

Replace an image on a PowerPoint slide with a worksheet range.

SaveFile

Saves one or all PowerPoint files depending on whether a file is specified.

Close

Closes PowerPoint.

Argument Description

Save

Whether to save the file. Defaults to TRUE.

CloseFile

Closes a specified file or all files depending on whether a file is specified.

Argument Description

FullFilePath

The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with.

Save

Whether to save the file. Defaults to TRUE.

CopyRange

Copy a worksheet range to a PowerPoint slide as an image.

Argument Description

FullFilePath

The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with.

Range

Specifies the range to copy. Defaults to the sheet's used range.

ReplacePolicy

Whether to replace an image that has the same name. If ReplacePolicy is not specified PerSlideName will be used. None - The image will be added to the specified slide, if any. Otherwise the image will be added to a new slide. OnAnySlide - Every image with the same name on any slide (if any) would be replaced. If an image with the same name does not exist then the image would be added. PerSlideName - If an image with the specified name exists on the specified slide it would be replaced, otherwise it would be added.

SizePolicy

The size of the new image. The default is NewImage. NewImage - The size of the replacing image will be based on the size of the copied range. ReplacedImage - The size of the replacing image will be based on the size of the replaced image.

ImageName

The name of the image. ImageName can be left blank.

SlideName

The name of the slide.

Slide names can be listed in PowerPoint VBA using:

Public Sub ListSlideNames() Dim oSlide As Slide For Each oSlide In Presentations(1).Slides Debug.Print "Slide " & oSlide.SlideIndex & ": " & oSlide.Name Next End Sub

SlideNumber

The number of the slide.

Left

The horizontal position of the image on the slide. Left can be left blank.

Top

The vertical position of the image on the slide. Top can be left blank.

Height

The height of the image in pixels. If Height is specified it overrides other arguments that impact the height of the image. The height of the image is always limited by the height of the slide.

Width

The width of the image in pixels. If Width is specified it overrides other arguments that impact the width of the image. The width of the image is always limited by the width of the slide.

ScalePercent

Scale the image with a value between 10 and 400. The default is 100.

Save

Whether to save the file. Defaults to TRUE.

ImageNamePropertyName

The resolved name of the image.

SlideNamePropertyName

The resolved name of the slide.

NewFile

Opens a new PowerPoint file for subsequent PowerPoint operations.

Argument Description

Visible

Whether PowerPoint is made visible. Defaults to FALSE.

Filename

Specify the name of the PowerPoint file. When UseDialog is TRUE, the file name is used as the default file name presented in the file dialog. When UseDialog is FALSE, the file name is used as the exported PowerPoint file name.

Folder

Specify the folder to save the PowerPoint file to. When UseDialog is TRUE, the folder is used as the default folder presented in the file dialog. When UseDialog is FALSE, the folder is used as the location of the exported PowerPoint file.

IncrementFilename

Whether to add a subscript, such as (1), to the filename if the specified file already exists. If IncrementFilename is blank an existing file with the same name will be overwritten.

UseDialog

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

DialogResultPropertyName

The name of the script property to hold the FileDialog form result. Possible values are OK, Cancel, and Abort.

FullFilePathPropertyName

The full path of the file that is saved.

OpenFile

Opens an existing PowerPoint file for subsequent PowerPoint operations.

Argument Description

Visible

Whether PowerPoint is made visible. Defaults to FALSE.

BinaryArtifactID

Specifies a BinaryArtifactID of a PowerPoint binary artifact. If a BinaryArtifactID is specified then file related arguments will be ignored.

Filename

Specify the name of the PowerPoint file. When UseDialog is TRUE, the file name is used as the default file name presented in the file dialog. When UseDialog is FALSE, the file name is used as the exported PowerPoint file name.

Folder

Specify the folder to save the PowerPoint file to. When UseDialog is TRUE, the folder is used as the default folder presented in the file dialog. When UseDialog is FALSE, the folder is used as the location of the exported PowerPoint file.

UseDialog

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

DialogResultPropertyName

The name of the script property to hold the FileDialog form result. Possible values are OK, Cancel, and Abort.

FullFilePathPropertyName

The full path of the file that is saved.

RemoveImage

Remove an image from a PowerPoint slide.

Argument Description

FullFilePath

The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with.

ImageName

The name of the image. ImageName can be left blank.

SlideName

The name of the slide.

Slide names can be listed in PowerPoint VBA using:

Public Sub ListSlideNames() Dim oSlide As Slide For Each oSlide In Presentations(1).Slides Debug.Print "Slide " & oSlide.SlideIndex & ": " & oSlide.Name Next End Sub

SlideNumber

The number of the slide.

Left

The horizontal position of the image on the slide. Left can be left blank.

Top

The vertical position of the image on the slide. Top can be left blank.

Save

Whether to save the file. Defaults to TRUE.

ImageNamePropertyName

The resolved name of the image.

SlideNamePropertyName

The resolved name of the slide.

RemoveSlide

Remove an slide from a PowerPoint presentation.

Argument Description

FullFilePath

The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with.

SlideName

The name of the slide.

Slide names can be listed in PowerPoint VBA using:

Public Sub ListSlideNames() Dim oSlide As Slide For Each oSlide In Presentations(1).Slides Debug.Print "Slide " & oSlide.SlideIndex & ": " & oSlide.Name Next End Sub

SlideNumber

The number of the slide.

Save

Whether to save the file. Defaults to TRUE.

SlideNamePropertyName

The resolved name of the slide.

ReplaceImage

Replace an image on a PowerPoint slide with a worksheet range.

Argument Description

FullFilePath

The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with.

Range

Specifies the range to copy. Defaults to the sheet's used range.

ImageName

The name of the image. ImageName can be left blank.

SlideName

The name of the slide.

Slide names can be listed in PowerPoint VBA using:

Public Sub ListSlideNames() Dim oSlide As Slide For Each oSlide In Presentations(1).Slides Debug.Print "Slide " & oSlide.SlideIndex & ": " & oSlide.Name Next End Sub

SlideNumber

The number of the slide.

Left

The horizontal position of the image on the slide. Left can be left blank.

Top

The vertical position of the image on the slide. Top can be left blank.

Height

The height of the image in pixels. If Height is specified it overrides other arguments that impact the height of the image. The height of the image is always limited by the height of the slide.

Width

The width of the image in pixels. If Width is specified it overrides other arguments that impact the width of the image. The width of the image is always limited by the width of the slide.

ScalePercent

Scale the image with a value between 10 and 400. The default is 100.

SizePolicy

The size of the new image. The default is NewImage. NewImage - The size of the replacing image will be based on the size of the copied range. ReplacedImage - The size of the replacing image will be based on the size of the replaced image.

Save

Whether to save the file. Defaults to TRUE.

ImageNamePropertyName

The resolved name of the image.

SlideNamePropertyName

The resolved name of the slide.

SaveFile

Saves one or all PowerPoint files depending on whether a file is specified.

Argument Description

FullFilePath

The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with.

SaveAsFilePath

Specify the name to save the PowerPoint file as. If a full path is not specified the file will be saved in the original folder.

IncrementFilename

Whether to add a subscript, such as (1), to the filename if the specified file already exists. If IncrementFilename is blank an existing file with the same name will be overwritten.

UseDialog

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

DialogResultPropertyName

The name of the script property to hold the FileDialog form result. Possible values are OK, Cancel, and Abort.

FullFilePathPropertyName

The full path of the file that is saved.

Print

Print Selection, Sheet, or Workbook.

Overloads

Overload Name Description

Preview

PrintPreview Selection, Sheet, or Workbook.

Print

Print Selection, Sheet, or Workbook.

PrintToFile

Print Selection, Sheet, or Workbook to a file.

PrintPreview Selection, Sheet, or Workbook.

Argument Description

PrintWhat

Specifies what to print.

Print Selection, Sheet, or Workbook.

Argument Description

PrintWhat

Specifies what to print.

ShowDialog

Whether to show the print dialog.

Print Selection, Sheet, or Workbook to a file.

Argument Description

PrintWhat

Specifies what to print.

PrinterName

Specifies the name of the print driver, such as Microsoft XPS Document Writer.

Filename

Specify the name of the file.

FolderOption

Select which option is used to determine the folder to save the file to. If no option is specified, the Folder argument is used.

Folder

Specify the full path of the folder to save the file to. The Folder value is only used when the FolderOption is not specified.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

PromptForFolder

Prompt the user to select a folder.

Since version 8.3

Overloads

Overload Name Description

General

Prompt the user to select a folder.

General

Prompt the user to select a folder.

Argument Description

Caption

The caption to use for the dialog.

SelectedPath

The folder selected when the dialog is initially shown. If left blank the user's desktop folder will be used.

ShowNewFolderButton

Whether the New Folder button is available to the user. If left blank FALSE will be used.

FolderPathPropertyName

The name of the script property that will receive the selected folder path.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result: OK or Cancel.

PromptForInput

Prompt the user for a value.

Overloads

Overload Name Description

Date

Prompt the user for a date value.

Double

Prompt the user for a double value.

DropDown

Prompt the user with a list of values in a drop-down.

Integer

Prompt the user for an integer value.

String

Prompt the user for a string value.

Date

Prompt the user for a date value.

Argument Description

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

Min

The minimum value to allow.

Max

The maximum value to allow.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

Double

Prompt the user for a double value.

Argument Description

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

Min

The minimum value to allow.

Max

The maximum value to allow.

DecimalPlaces

The maximum number of digits to the right of the decimal to allow.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

DropDown

Prompt the user with a list of values in a drop-down.

Argument Description

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

MaxCharacters

The maximum number of characters to allow.

DropDownList

The list of values for the drop-down. If the list only contains display-values, separate each value with a semicolon. If the drop-down has display-values and data-values then the display-values should be separated from the data-values with a semicolon, and each row of the list should be followed by a new-line.

HasDataValues

Determines whether the combo-list has display-values and data-values, or just display-values.

LimitToList

Whether the entry must be in the drop-down list.

MaxDropDownItems

The number of rows to show in the drop-down list. The default is 15.

SortStyle

Whether null/empty is a valid entry.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

Integer

Prompt the user for an integer value.

Argument Description

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

Min

The minimum value to allow.

Max

The maximum value to allow.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

String

Prompt the user for a string value.

Argument Description

FormCaption

The caption to use for the form.

FormHeight

The height of the prompt form.

FormWidth

The width of the prompt form.

PromptText

The text to use to prompt the user.

NullText

The text to display in the input box if no value has been entered. The NullText does not become the value of the input.

DefaultValue

The value to use by default.

AllowNull

Whether null/empty is a valid entry.

MaxCharacters

The maximum number of characters to allow.

MultiLine

Whether to allow more than one line in the input.

WordWrap

Whether to automatically wrap text.

ScrollBars

The scrollbar configuration for the text box.

PasswordMaskCharacter

A character to use for password masking.

FailedValidationText

The message to display if the value is not valid.

InputValuePropertyName

The name of the script property that will receive the input value.

DialogResultPropertyName

The name of the script property that will receive the value of the dialog result, like Cancel, etc.

RefreshView

Refresh the view.

Overloads

Overload Name Description

General

Refresh the view.

General

Refresh the view.

Argument Description

RemoveDefinedName

Remove a defined name.

Overloads

Overload Name Description

Workbook

Remove a defined name from the workbook.

Worksheet

Remove a defined name from one or all worksheets.

Workbook

Remove a defined name from the workbook.

Argument Description

DefinedName

The name to remove.

Worksheet

Remove a defined name from one or all worksheets.

Argument Description

DefinedName

The name to remove.

RemoveDuplicates

Remove duplicate rows or columns.

Since version 7.4

Overloads

Overload Name Description

Columns

Remove duplicate columns based on values in specified rows.

Rows

Remove duplicate rows based on values in specified columns.

Columns

Remove duplicate columns based on values in specified rows.

Argument Description

Range

The name or address of the range to remove duplicates from.

HasHeaders

Set this to TRUE if the range has headers that should be ignored. The default is FALSE.

CompareRows

A comma delimited list of row numbers within the specified Range to use for the comparison. Example: 3, 4, 7

ShiftColumns

Whether to shift cells left when removing columns or remove the entire column. The default is "Left".

Rows

Remove duplicate rows based on values in specified columns.

Argument Description

Range

The name or address of the range to remove duplicates from.

HasHeaders

Set this to TRUE if the range has headers that should be ignored. The default is FALSE.

CompareColumns

A comma delimited list of column numbers within the specified Range to use for the comparison. Example: 3, 4, 7

ShiftRows

Whether to shift cells up when removing rows or remove the entire row. The default is "Up".

RemoveProperty

Remove a specified property from the workbook script.

Overloads

Overload Name Description

General

Remove a workbook script property from the script.

General

Remove a workbook script property from the script.

Argument Description

PropertyName

The name of the property to remove.

RemoveToken

Remove a specified token from the workbook script.

Overloads

Overload Name Description

Any

Remove the specified token from the Application tokens, View tokens, and the view's volatile tokens.

Application

Remove the specified token from the Application tokens.

General

Remove the specified token from the view's volatile tokens.

RemoveAll

Remove all tokens from the specified token tables.

View

Remove the specified token from the View's tokens.

Any

Remove the specified token from the Application tokens, View tokens, and the view's volatile tokens.

Argument Description

TokenName

The name of the token to remove.

Application

Remove the specified token from the Application tokens.

Argument Description

TokenName

The name of the token to remove.

General

Remove the specified token from the view's volatile tokens.

Argument Description

TokenName

The name of the token to remove.

RemoveAll

Remove all tokens from the specified token tables.

Argument Description

All

Enter TRUE to remove all tokens from all token tables. Selector tokens are not removed.

Application

Enter TRUE to remove all tokens from the application token table.

View

Enter TRUE to remove all view tokens from the view's token table.

TargetView

Enter TRUE to remove all tokens from the targetview's token table. This only applies when the event is OpenViewForMemberCells or OpenViewForDataCells.

View

Remove the specified token from the View's tokens.

Argument Description

TokenName

The name of the token to remove.

RemoveWorksheet

Remove a specified worksheet from the workbook.

Overloads

Overload Name Description

General

Remove a worksheet.

General

Remove a worksheet.

Argument Description

SpecifySheetToRemoveBy

Select how to specify which worksheet to remove.

SheetToRemove

Specify the sheet-name or sheet-number of the sheet to remove, depending on SpecifySheetToRemoveBy.

RenameWorkbook

Renames a workbook.

Overloads

Overload Name Description

General

Renames a workbook.

General

Renames a workbook.

Argument Description

SpecifyWorkbookBy

Select how to specify the workbook to rename.

Workbook

Specify the name or number of the workbook to rename, depending on SpecifyWorkbookBy.

NewWorkbookName

The new name of the workbook.

RenameWorksheet

Rename a specified worksheet in the workbook. Note: Changing the worksheet name in an event that fires after the BeforeCommentsSetup event may break comment functionality in the view instance.

Overloads

Overload Name Description

General

Rename one or all worksheets.

General

Rename one or all worksheets.

Argument Description

SpecifySheetToRenameBy

Select how to specify which worksheet to rename.

SheetToRename

Specify the sheet-name or sheet-number of the sheet to rename, depending on SpecifySheetToRenameBy.

NewSheetName

The new name of the sheet.

RepaintGrid

Repaints the grid control.

Overloads

Overload Name Description

General

Repaints the grid control.

General

Repaints the grid control.

Argument Description

Repaint

Determines whether to do the repaint.

Replace

Find and replace a string.

Since version 7.4

Overloads

Overload Name Description

General

Find and replace string.

General

Find and replace string.

Argument Description

FindWhat

The string that is going to be found and replaced.

ReplaceWith

The string that is going to replace the FindWhat string.

SearchOrder

Whether to replace by columns or rows. Defaults to ByRows if not entered.

MatchCase

Wether to consider Upper/Lower case to determine a match. Defaults to FALSE if not entered.

MatchEntireCellContents

Wether to use the entire cell contents to determine a match. Defaults to FALSE if not entered.

ReplaceTokens

Do token replacement.

Overloads

Overload Name Description

General

Do token replacement.

General

Do token replacement.

Argument Description

SQLBlobOperations

Downloads, uploads, or deletes SQL binary large objects via SQLPassthroughDataSet or Select/Insert/Update/Delete statements.

Since version 8.3

Overloads

Overload Name Description

DeleteBlobs

Deletes one or more documents from a relational database, optionally using a specified filename.

InsertBlobFromFile

Inserts a document from disk into a relational database.

InsertBlobsFromFolder

Inserts one or more documents from disk into a relational database.

SelectBlobToFile

Selects a document from a relational database and saves it to disk.

SelectBlobsToFolder

Select one or more documents from a relational database and saves them to disk.

UpdateBlobFromFile

Updates a relational database blob with a document from disk.

UpdateBlobsFromFolder

Updates relational database blobs with one or more documents from disk.

DeleteBlobs

Deletes one or more documents from a relational database, optionally using a specified filename.

Argument Description

SQLConnectionID

The SQL connection ID used by the operation. The specified SQL Connection must have the Database (type) property set in order to generate insert/update parameter values.

SQLPassthroughDataSetID

The SQLPassthroughDataSet used to select/insert/update/delete a blob from the relational database.

DeleteSQL

The SQL statement used to delete a blob from the relational database.

FilenameColumn

The name of the relational table column that contains the filename associated with the BLOB data.

LocalFilePath

The full path of the local file to be saved or uploaded.

UseDialog

(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used.

DialogFilter

(Optional) A filter string that determines which choices that appear in the save and open file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*"

DialogTitle

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

ContinueOnError

(Optional) Controls whether the remaining statements are executed when a given statement generates an error. By default, execution of the remaining statements is not continued when an error is encountered.

ErrorOccurredPropertyName

(Optional) The name of the property set to True when an error occurs.

DeleteAfterDelete

(Optional) Whether to delete the local file after the associated records are deleted.

RecordCountPropertyName

(Optional) The name of the workbook script property that receives the count of records selected or affected.

SpecifiedPathPropertyName

(Optional) The name of the workbook script property that receives the specified local path.

InsertBlobFromFile

Inserts a document from disk into a relational database.

Argument Description

SQLConnectionID

The SQL connection ID used by the operation. The specified SQL Connection must have the Database (type) property set in order to generate insert/update parameter values.

SQLPassthroughDataSetID

The SQLPassthroughDataSet used to select/insert/update/delete a blob from the relational database.

InsertSQL

The SQL statement used to insert a blob into the relational database.

BlobColumn

The name of the relational table column that contains the BLOB data.

FilenameColumn

The name of the relational table column that contains the filename associated with the BLOB data.

LocalFilePath

The full path of the local file to be saved or uploaded.

UseDialog

(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used.

DialogFilter

(Optional) A filter string that determines which choices that appear in the save and open file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*"

DialogTitle

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

DeleteAfterInsert

(Optional) Whether to delete the local file or files after they're inserted.

ContinueOnError

(Optional) Controls whether the remaining statements are executed when a given statement generates an error. By default, execution of the remaining statements is not continued when an error is encountered.

ErrorOccurredPropertyName

(Optional) The name of the property set to True when an error occurs.

RecordCountPropertyName

(Optional) The name of the workbook script property that receives the count of records selected or affected.

SpecifiedPathPropertyName

(Optional) The name of the workbook script property that receives the specified local path.

InsertBlobsFromFolder

Inserts one or more documents from disk into a relational database.

Argument Description

SQLConnectionID

The SQL connection ID used by the operation. The specified SQL Connection must have the Database (type) property set in order to generate insert/update parameter values.

SQLPassthroughDataSetID

The SQLPassthroughDataSet used to select/insert/update/delete a blob from the relational database.

InsertSQL

The SQL statement used to insert a blob into the relational database.

BlobColumn

The name of the relational table column that contains the BLOB data.

FilenameColumn

The name of the relational table column that contains the filename associated with the BLOB data.

LocalFolderPath

The full path of the local folder under which to save or from which to upload blobs.

UseDialog

(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used.

DialogTitle

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

DeleteAfterInsert

(Optional) Whether to delete the local file or files after they're inserted.

ContinueOnError

(Optional) Controls whether the remaining statements are executed when a given statement generates an error. By default, execution of the remaining statements is not continued when an error is encountered.

ErrorOccurredPropertyName

(Optional) The name of the property set to True when an error occurs.

RecordCountPropertyName

(Optional) The name of the workbook script property that receives the count of records selected or affected.

SpecifiedPathPropertyName

(Optional) The name of the workbook script property that receives the specified local path.

SelectBlobToFile

Selects a document from a relational database and saves it to disk.

Argument Description

SQLConnectionID

The SQL connection ID used by the operation. The specified SQL Connection must have the Database (type) property set in order to generate insert/update parameter values.

SQLPassthroughDataSetID

The SQLPassthroughDataSet used to select/insert/update/delete a blob from the relational database.

SelectSQL

The SQL statement used to retrieve a blob from the relational database.

BlobColumn

The name of the relational table column that contains the BLOB data.

LocalFilePath

The full path of the local file to be saved or uploaded.

UseDialog

(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used.

DialogFilter

(Optional) A filter string that determines which choices that appear in the save and open file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*"

DialogTitle

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

RecordCountPropertyName

(Optional) The name of the workbook script property that receives the count of records selected or affected.

SpecifiedPathPropertyName

(Optional) The name of the workbook script property that receives the specified local path.

SelectBlobsToFolder

Select one or more documents from a relational database and saves them to disk.

Argument Description

SQLConnectionID

The SQL connection ID used by the operation. The specified SQL Connection must have the Database (type) property set in order to generate insert/update parameter values.

SQLPassthroughDataSetID

The SQLPassthroughDataSet used to select/insert/update/delete a blob from the relational database.

SelectSQL

The SQL statement used to retrieve a blob from the relational database.

BlobColumn

The name of the relational table column that contains the BLOB data.

FilenameColumn

The name of the relational table column that contains the filename associated with the BLOB data.

LocalFolderPath

The full path of the local folder under which to save or from which to upload blobs.

UseDialog

(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used.

DialogTitle

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

RecordCountPropertyName

(Optional) The name of the workbook script property that receives the count of records selected or affected.

SpecifiedPathPropertyName

(Optional) The name of the workbook script property that receives the specified local path.

UpdateBlobFromFile

Updates a relational database blob with a document from disk.

Argument Description

SQLConnectionID

The SQL connection ID used by the operation. The specified SQL Connection must have the Database (type) property set in order to generate insert/update parameter values.

SQLPassthroughDataSetID

The SQLPassthroughDataSet used to select/insert/update/delete a blob from the relational database.

UpdateSQL

The SQL statement used to update a blob in the relational database.

BlobColumn

The name of the relational table column that contains the BLOB data.

FilenameColumn

The name of the relational table column that contains the filename associated with the BLOB data.

LocalFilePath

The full path of the local file to be saved or uploaded.

UseDialog

(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used.

DialogFilter

(Optional) A filter string that determines which choices that appear in the save and open file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*"

DialogTitle

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

DeleteAfterUpdate

(Optional) Whether to delete the local file or files after they're updated.

ContinueOnError

(Optional) Controls whether the remaining statements are executed when a given statement generates an error. By default, execution of the remaining statements is not continued when an error is encountered.

ErrorOccurredPropertyName

(Optional) The name of the property set to True when an error occurs.

RecordCountPropertyName

(Optional) The name of the workbook script property that receives the count of records selected or affected.

SpecifiedPathPropertyName

(Optional) The name of the workbook script property that receives the specified local path.

UpdateBlobsFromFolder

Updates relational database blobs with one or more documents from disk.

Argument Description

SQLConnectionID

The SQL connection ID used by the operation. The specified SQL Connection must have the Database (type) property set in order to generate insert/update parameter values.

SQLPassthroughDataSetID

The SQLPassthroughDataSet used to select/insert/update/delete a blob from the relational database.

UpdateSQL

The SQL statement used to update a blob in the relational database.

BlobColumn

The name of the relational table column that contains the BLOB data.

FilenameColumn

The name of the relational table column that contains the filename associated with the BLOB data.

LocalFolderPath

The full path of the local folder under which to save or from which to upload blobs.

UseDialog

(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used.

DialogTitle

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

DeleteAfterUpdate

(Optional) Whether to delete the local file or files after they're updated.

ContinueOnError

(Optional) Controls whether the remaining statements are executed when a given statement generates an error. By default, execution of the remaining statements is not continued when an error is encountered.

ErrorOccurredPropertyName

(Optional) The name of the property set to True when an error occurs.

RecordCountPropertyName

(Optional) The name of the workbook script property that receives the count of records selected or affected.

SpecifiedPathPropertyName

(Optional) The name of the workbook script property that receives the specified local path.

SQLPassthroughExecute

Executes a delimited list of SQL statements within a single server request. IMPORTANT: If the Statements argument contains a semicolon ";", then multiple statements should be delimited using a non-semicolon character, such as the pipe character "\|", which should be specified as the StatementDelimiter argument. By default, the StatementDelimiter is a semicolon.

Overloads

Overload Name Description

General

Executes a delimited list of SQL statements within a single server request.

General

Executes a delimited list of SQL statements within a single server request.

Argument Description

SQLConnectionID

The SQL connection ID used by the operation.

Statements

The SQL statements delimited by the StatementDelimiter.

StatementDelimiter

The character used to delimit the statements. The recommended delimiters include the pipe "|" and the semi-colon ";". By default, a semi-colon is assumed to be the delimiter, but if any of statements include a delimiter, a non-semicolon character, such as the pipe character "|", should be used and specified as the StatementDelimiter.

Transaction

Controls whether the statements are executed within a transaction. By default, a transaction is not opened.

ContinueOnError

If the Transaction argument is FALSE, ContinueOnError controls whether the remaining statements are executed when a given statement generates an error. By default, execution of the remaining statements is not continued when an error is encountered.

BackgroundExecute

Controls whether the operation is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the statements are executed. By default, the view is not covered.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the statements are executed. If no value is specified, "SQLPassthroughExecute started" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the statements are executed. If no value is specified, "SQLPassthroughExecute completed" is displayed as the progress text.

ResultPropertyName

(Optional) The name of the workbook script property that receives the value of the result, which is a string containing the result of each statement delimited by the StatementDelimiter.

ErrorPropertyName

(Optional) The name of the workbook script property that receives the error message if the service returns an exception.

SaveDataSetRange

Saves changes, including added, deleted, and modified rows, for a SQLPassthroughDataSetRange.

Overloads

Overload Name Description

General

Saves changes, including added, deleted, and modified rows, for a SQLPassthroughDataSetRange.

General

Saves changes, including added, deleted, and modified rows, for a SQLPassthroughDataSetRange.

Argument Description

SaveAll

If TRUE all datasets will be saved and DataSetRangeName isn't necessary. Defaults to FALSE if not entered.

DataSetRangeName

The name of the view's SQLPassthroughDataSetRange to save.

SaveDataTableRangeRow

Saves an added or modified row within a DataTableRange's sheet range.

Overloads

Overload Name Description

ByRowAddress

Saves an added or modified row within a DataTableRange's sheet range.

ByRowAddress

Saves an added or modified row within a DataTableRange's sheet range.

Argument Description

RowAddress

The address used to identify the row within a DataTableRange's sheet range. The address of any cell within the data table range row to be saved can be used.

RowErrorClientPropertyName

The name of the workbook script property that receives the value of the error encountered on the client, such as a data conversion error.

RowErrorServerPropertyName

The name of the workbook script property that receives the value of the error returned by the server, such as a database constraint violation.

SaveWorkbook

Save the workbook to an Excel file.

Overloads

Overload Name Description

Desktop

Save to the desktop of the current user. Specify the file name.

General

Specify the full path.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Specify

Save workbook specifying the file name, file type, and folder.

Desktop

Save to the desktop of the current user. Specify the file name.

Argument Description

Filename

Specify the name of the file.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

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

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

Password

The password assigned to the saved workbook.

General

Specify the full path.

Argument Description

Filename

Specify the name of the file.

Folder

Specify the folder to save the file to. Defaults to MyDocuments if not specified.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

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

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

Password

The password assigned to the saved workbook.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Argument Description

Filename

Specify the name of the file.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

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

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

Password

The password assigned to the saved workbook.

Specify

Save workbook specifying the file name, file type, and folder.

Argument Description

Filename

Specify the name of the file.

FileType

Specify to the file type of saved workbook.

Defaults to OpenXMLWorkbook if not specified.

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

Folder

Specify the folder to save the file to. Defaults to MyDocuments if not specified.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

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

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

Password

The password assigned to the saved workbook.

SaveWorkbookAsCsv

Save the workbook to a CSV file.

Since version 7.3

Overloads

Overload Name Description

Desktop

Save to the desktop of the current user. Specify the file name.

General

Specify the full path.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Desktop

Save to the desktop of the current user. Specify the file name.

Argument Description

Delimiter

(Optional) Specify the delimiter to be used for the separated values file. By default, "," is used.

Filename

Specify the name of the file.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

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

Password

The password assigned to the saved workbook.

PreserveLeadingSingleQuotes

Whether to preserve the leading single quote used to indicate text in cells in the CSV output. If true, the resulting CSV file will preserve leading single quotes.

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

General

Specify the full path.

Argument Description

Delimiter

(Optional) Specify the delimiter to be used for the separated values file. By default, "," is used.

Filename

Specify the name of the file.

Folder

Specify the folder to save the file to.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

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

Password

The password assigned to the saved workbook.

PreserveLeadingSingleQuotes

Whether to preserve the leading single quote used to indicate text in cells in the CSV output. If true, the resulting CSV file will preserve leading single quotes.

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Argument Description

Delimiter

(Optional) Specify the delimiter to be used for the separated values file. By default, "," is used.

Filename

Specify the name of the file.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

UseDialog

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

Password

The password assigned to the saved workbook.

PreserveLeadingSingleQuotes

Whether to preserve the leading single quote used to indicate text in cells in the CSV output. If true, the resulting CSV file will preserve leading single quotes.

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

SaveWorkbookAsPdf

Save the workbook to a PDF.

Overloads

Overload Name Description

Desktop

Save to the desktop of the current user. Specify the file name.

General

Specify the full path.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Desktop

Save to the desktop of the current user. Specify the file name.

Argument Description

Filename

Specify the name of the output PDF.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

UseDialog

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

BackgroundExecute

Controls whether the method is executed asynchronous.

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

General

Specify the full path.

Argument Description

Filename

Specify the name of the output PDF.

Folder

Specify the folder to save the PDF to.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

UseDialog

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

BackgroundExecute

Controls whether the method is executed asynchronous.

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

MyDocuments

Save to the My Documents folder of the current user. Specify the file name.

Argument Description

Filename

Specify the name of the output PDF.

IncrementFilename

Whether to add a subscript to the filename if the specified file already exists. If not true, an existing file with the same name will be overwritten.

Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

UseDialog

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

BackgroundExecute

Controls whether the method is executed asynchronous.

DialogResultPropertyName

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

FullFilePathPropertyName

The full path of the file that is saved.

SelectRange

Select a specified range in the workbook.

Overloads

Overload Name Description

General

Select a range using an address.

General

Select a range using an address.

Argument Description

ActiveCell

The address of the cell to make active after the selection.

AddToSelection

Whether to add the specified range to the current selection.

SendEmail

Send an e-mail message.

Overloads

Overload Name Description

General

Send an e-mail message using Windows Simple MAPI, which supports the option to display the default email client dialog to allow the user to specify recipients and other send options.

SMTP

Send an e-mail message via SMTP. This is the preferred overload.

ServletSMTP

Send an e-mail message via the Dodeca servlet using SMTP.

General

Send an e-mail message using Windows Simple MAPI, which supports the option to display the default email client dialog to allow the user to specify recipients and other send options.

Argument Description

To

E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon.

cc

E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

bcc

E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

Subject

The subject of the message.

Message

The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE.

Prompt

Whether to prompt the user before sending the message. The default is TRUE.

AttachView

Whether to attach the view to the e-mail message. The default is FALSE.

AttachedViewFilename

The name to give to the attached view file. If omitted the attached view file name will be based on the view name.

AttachViewAsPDF

Whether to attach the view as a PDF to the e-mail message. The default is FALSE.

AttachViewAsPDF_Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

AttachViewAsPDF_Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

ZipAttachments

Whether to add all attachments to a .zip file when composing the message. The default is FALSE.

ZipFileName

The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view's name will be used.

ZipCompression

The compression level to use when sending attachments as a .zip file. The default is Normal.

SMTP

Send an e-mail message via SMTP. This is the preferred overload.

Argument Description

From

The address from which the email will be sent.

FromDisplayName

The displayed address from which the email will be sent.

To

E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon.

cc

E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

bcc

E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

Subject

The subject of the message.

IsHtmlMessage

Whether the message body contains HTML. The default is FALSE.

Message

The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE.

Host

The SMTP hostname which will send the email.

Port

The SMTP port number on the SMTP host computer.

Security

The connection security type to use when connecting to the server and sending e-mail. The default is None.

Username

The username of the SMTP account used to send the email.

Password

The password of the SMTP account used to send the email.

AttachView

Whether to attach the view to the e-mail message. The default is FALSE.

AttachedViewFilename

The name to give to the attached view file. If omitted the attached view file name will be based on the view name.

AttachViewAsPDF

Whether to attach the view as a PDF to the e-mail message. The default is FALSE.

AttachViewAsPDF_Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

AttachViewAsPDF_Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

AttachmentFilenames

Specify the name(s) of the file(s) to attach. To attach multiple files, the filenames must be delimited with the vertical bar (|) character or each filename must be specified on a separate line.

AttachmentFolder

Specify the folder that contains the attachment file(s).

ZipAttachments

Whether to add all attachments to a .zip file when composing the message. The default is FALSE.

ZipFileName

The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view's name will be used.

ZipCompression

The compression level to use when sending attachments as a .zip file. The default is Normal.

SnapshotRange

The range or ranges (separated by comma) to snapshot.

SnapshotAttachOrEmbed

Whether to attach the snapshot images to the email message or embed them. If embed is used then IsHtmlMessage will be forced to TRUE.

SnapshotFilename

The name to use for the snapshot file. "Snapshot" will be used if left blank.

SnapshotImageFormat

The format of the image file (If left blank Bmp will be used.): Bmp Bitmap Gif Graphics Interchange Format Jpeg Joint Photographic Experts Group Png W3C Portable Network Graphics Tiff Tagged Image File Format

SnapshotInsertToken

If AttachOrEmbed=Embed then the snapshot(s) will be inserted into the message in place of the specified token. If InsertToken is blank then snapshot(s) will be appended to the end of the message.

SnapshotScalePercent

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

ServletSMTP

Send an e-mail message via the Dodeca servlet using SMTP.

Argument Description

From

The address from which the email will be sent.

FromDisplayName

The displayed address from which the email will be sent.

To

E-mail address(es) of the recipient(s). If multiple addresses are specified, the addresses must be delimited with a semicolon.

cc

E-mail address(es) to receive copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

bcc

E-mail address(es) to receive blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

BounceAddress

E-mail address to which bounce messages are delivered.

Subject

The subject of the message.

IsHtmlMessage

Whether the message body contains HTML. The default is FALSE.

ImageBaseURL

When IsHtmlMessage is TRUE, the domain from which images included in the Message will be served.

Message

The body of the message that will be sent. Can include HTML when IsHtmlMessage is TRUE.

AlternateText

Alternate text to be used for clients who do not support HTML messages, when IsHtmlMessage is TRUE.

Host

The SMTP hostname which will send the email.

Port

The SMTP port number on the SMTP host computer.

Security

The connection security type to use when connecting to the server and sending e-mail. The default is None.

Username

The username of the SMTP account used to send the email.

Password

The password of the SMTP account used to send the email.

EnableLogging

Whether to log the message details in the server log. The default is FALSE.

AttachView

Whether to attach the view to the e-mail message. The default is FALSE.

AttachedViewFilename

The name to give to the attached view file. If omitted the attached view file name will be based on the view name.

AttachViewAsPDF

Whether to attach the view as a PDF to the e-mail message. The default is FALSE.

AttachViewAsPDF_Compliance

Indicates whether to produce a PDF/A-1b compliant PDF. The default is PDF/A-1b.

AttachViewAsPDF_Optimization

Indicates whether to produce a standard or size-optimized PDF. The default is Standard.

AttachmentFilenames

Specify the name(s) of the file(s) to attach. To attach multiple files, the filenames must be delimited with the vertical bar (|) character or each filename must be specified on a separate line.

AttachmentFolder

Specify the folder that contains the attachment file(s).

ZipAttachments

Whether to add all attachments to a .zip file when composing the message. The default is FALSE.

ZipFileName

The name of the attached zip file if the ZipAttachments argument is TRUE. If ZipFileName is not specified then the view's name will be used.

ZipCompression

The compression level to use when sending attachments as a .zip file. The default is Normal.

SetActiveSheet

Make the specified sheet active.

Overloads

Overload Name Description

General

Make the specified sheet active.

General

Make the specified sheet active.

Argument Description

SetActiveWorkbook

Make the specified workbook active.

Overloads

Overload Name Description

General

Make the specified workbook active.

General

Make the specified workbook active.

Argument Description

SpecifyWorkbookBy

Select how to specify which workbook to make active.

Workbook

The index or name of the workbook to activate, depending on the value of SpecifyWorkbookBy.

SetBorders

Set the borders of cells.

Overloads

Overload Name Description

All

Set border top, left, bottom, right, inside vertical, and inside horizontal.

Color

Set border color.

Diagonal

Set diagonal-up and diagonal-down border.

LineStyle

Set border line style. The SpreadsheetGear control can only render the Excel line styles None, Continuous, and Double. The Excel line styles Dash, DashDot, DashDotDot, Dot, and SlantDashDot are rendered as Continuous. All Excel line styles are maintained and displayed correctly when the workbook is viewed in Excel. The SpreadsheetGear line styles are supported by the LineStyleSG overload.

LineStyleSG

Set the border line style to a style available in the SpreadsheetGear control, which cannot render the Excel line styles Dash, DashDot, DashDotDot, Dot, and SlantDashDot. When using the LineStyle overload, these Excel styles are rendered as the Excel line style Continuous. The LineStyleSG overload provides the line styles None, Dotted, Thin, Medium, Thick, and Double, which render correctly in the SpreadsheetGear control and will look the same when the workbook is viewed in Excel.

None

Remove borders.

Weight

Set border weight.

All

Set border top, left, bottom, right, inside vertical, and inside horizontal.

Argument Description

ColorRGB

Select a color to use for the border color. ColorRGB is used if Color and ColorRGB are both specified.

Color

Excel color palette index to use for the border color. The value is zero-based from 0 to 55.

LineStyle

Excel LineStyle to use for border. The SpreadsheetGear control can only render the Excel line styles None, Continuous, and Double. The Excel line styles Dash, DashDot, DashDotDot, Dot, and SlantDashDot are rendered as Continuous. All Excel line styles are maintained and displayed correctly when the workbook is viewed in Excel. The SpreadsheetGear line styles are supported by the LineStyleSG argument. If LineStyle and LineStyleSG are both specified, then LineStyleSG will be used.

LineStyleSG

SpreadsheetGear LineStyle to use for border. Options include the line styles that can be rendered by the SpreadsheetGear control. If LineStyle and LineStyleSG are both specified, then LineStyleSG will be used.

Weight

WeightNumber to use for border.

Color

Set border color.

Argument Description

TopColorRGB

Select a color to use for the top border color. TopColorRGB is used if TopColor and TopColorRGB are both specified.

BottomColorRGB

Select a color to use for bottom the border color. BottomColorRGB is used if BottomColor and BottomColorRGB are both specified.

LeftColorRGB

Select a color to use for the left border color. LeftColorRGB is used if LeftColor and LeftColorRGB are both specified.

RightColorRGB

Select a color to use for the right border color. RightColorRGB is used if RightColor and RightColorRGB are both specified.

OutsideColorRGB

Select a color to use for the outside border color. OutsideColorRGB is used if OutsideColor and OutsideColorRGB are both specified.

InsideColorRGB

Select a color to use for the inside border color. InsideColorRGB is used if InsideColor and InsideColorRGB are both specified.

InsideVerticalColorRGB

Select a color to use for the inside vertical border color. InsideVerticalColorRGB is used if InsideVerticalColor and InsideVerticalColorRGB are both specified.

InsideHorizontalColorRGB

Select a color to use for the inside horizontal border color. InsideHorizontalColorRGB is used if InsideHorizontalColor and InsideHorizontalColorRGB are both specified.

TopColor

Excel color palette index to use for top border color. The value is zero-based from 0 to 55.

BottomColor

Excel color palette index to use for bottom border color. The value is zero-based from 0 to 55.

LeftColor

Excel color palette index to use for left border color. The value is zero-based from 0 to 55.

RightColor

Excel color palette index to use for right border color. The value is zero-based from 0 to 55.

OutsideColor

Excel color palette index to use for outside border color. The value is zero-based from 0 to 55.

InsideColor

Excel color palette index to use for inside border color. The value is zero-based from 0 to 55.

InsideVerticalColor

Excel color palette index to use for inside-vertical border color. The value is zero-based from 0 to 55.

InsideHorizontalColor

Excel color palette index to use for inside-horizontal border color. The value is zero-based from 0 to 55.

Diagonal

Set diagonal-up and diagonal-down border.

Argument Description

DiagonalDownColor

Excel color palette index to use for right-diagonal border color. The value is zero-based from 0 to 55.

DiagonalDownColorRGB

Select a color to use for the diagonal down border color. DiagonalDownColorRGB is used if DiagonalDownColor and DiagonalDownColorRGB are both specified.

DiagonalDownStyle

Excel LineStyle to use for right-diagonal border.

DiagonalDownWeight

WeightNumber to use for right-diagonal border.

DiagonalUpColor

Excel color palette index to use for left-diagonal border color. The value is zero-based from 0 to 55.

DiagonalUpColorRGB

Select a color to use for the diagonal up border color. DiagonalUpColorRGB is used if DiagonalUpColor and DiagonalUpColorRGB are both specified.

DiagonalUpStyle

Excel LineStyle to use for left-diagonal border.

DiagonalUpWeight

WeightNumber to use for left-diagonal border.

LineStyle

Set border line style. The SpreadsheetGear control can only render the Excel line styles None, Continuous, and Double. The Excel line styles Dash, DashDot, DashDotDot, Dot, and SlantDashDot are rendered as Continuous. All Excel line styles are maintained and displayed correctly when the workbook is viewed in Excel. The SpreadsheetGear line styles are supported by the LineStyleSG overload.

Argument Description

TopStyle

Excel LineStyle to use for top border.

BottomStyle

Excel LineStyle to use for bottom border.

LeftStyle

Excel LineStyle to use for left border.

RightStyle

Excel LineStyle to use for right border.

OutsideStyle

Excel LineStyle to use for outside border.

InsideStyle

Excel LineStyle to use for inside border.

InsideVerticalStyle

Excel LineStyle to use for inside-vertical border.

InsideHorizontalStyle

Excel LineStyle to use for inside-horizontal border.

LineStyleSG

Set the border line style to a style available in the SpreadsheetGear control, which cannot render the Excel line styles Dash, DashDot, DashDotDot, Dot, and SlantDashDot. When using the LineStyle overload, these Excel styles are rendered as the Excel line style Continuous. The LineStyleSG overload provides the line styles None, Dotted, Thin, Medium, Thick, and Double, which render correctly in the SpreadsheetGear control and will look the same when the workbook is viewed in Excel.

Argument Description

Top

SpreadsheetGear LineStyle to use for the top border.

Bottom

SpreadsheetGear LineStyle to use for the bottom border.

Left

SpreadsheetGear LineStyle to use for the left border.

Right

SpreadsheetGear LineStyle to use for the right border.

Outside

SpreadsheetGear LineStyle to use for the outside border.

Inside

SpreadsheetGear LineStyle to use for the inside border.

InsideVertical

SpreadsheetGear LineStyle to use for the inside-vertical border.

InsideHorizontal

SpreadsheetGear LineStyle to use for the inside-horizontal border.

None

Remove borders.

Argument Description

Weight

Set border weight.

Argument Description

TopWeight

WeightNumber to use for top border.

BottomWeight

WeightNumber to use for bottom border.

LeftWeight

WeightNumber to use for left border.

RightWeight

WeightNumber to use for right border.

OutsideWeight

WeightNumber to use for outside border.

InsideWeight

WeightNumber to use for inside border.

InsideVerticalWeight

WeightNumber to use for inside-vertical border.

InsideHorizontalWeight

WeightNumber to use for inside-horizontal border.

SetCalculationOptions

Set workbook calculation options.

Overloads

Overload Name Description

CalculateOnDemand

Set calculate-on-demand (true/false).

General

Set calculation options.

CalculateOnDemand

Set calculate-on-demand (true/false).

Argument Description

CalculateOnDemand

Whether Calculate-On-Demand should be on.

General

Set calculation options.

Argument Description

CalculationMode

Whether calculation should be Automatic, Semi-Automatic, or Manual.

CalcBeforeSave

Whether to calculate automatically before saving.

Iteration

Whether iteration should be on.

MaxIterations

The maximum number of iterations.

MaxChange

The maximum iteration change.

PrecisionAsDisplayed

Whether to use precision determined by the displayed value.

SetCameraFrame

The SetCameraFrame method works similarly to Excel when Insert/Picture or Insert/Screenshot is used and the formula of the picture frame is set to a range on a worksheet. The range specified in the formula will be rendered as an image within the picture frame. The image is automatically updated with the contents of the rendered range whenever that range changes. The camera-frame is created if it doesn't exist. To have the camera image appear exactly like the camera range, do not specify Height, Width, EndColumn, or EndRow.

Since version 7.5

Overloads

Overload Name Description

General

Add or modify a camera-frame. The SetShape method can be used to manipulate a camera-frame once it is created.

General

Add or modify a camera-frame. The SetShape method can be used to manipulate a camera-frame once it is created.

Argument Description

Name

The name assigned to the camera-frame. This can be used to identify the camera-frame after it is created.

CameraRange

The range to be displayed inside the camera-frame.

Width

The width of the camera-frame in points. The EndColumn argument can be used instead of this. The Width argument will override the EndColumn argument. If neither Width nor EndColumn are specified then the width of the camera-frame will be the width of the camera-range.

Height

The height of the camera-frame in points. The EndRow argument can be used instead of this. The Height argument will override the EndRow argument. If neither Height nor EndRow are specified then the height of the camera-frame will be the height of the camera-range.

Column

The column to put the Camera into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

ColumnPoints

The position of the left edge of the Camera in points. If used with the Column argument then the two are added together.

EndColumn

The specified column the will define the width of the camera-frame. The Width argument can be used instead of this. The Width argument will override the EndColumn argument. If neither Width nor EndColumn are specified then the width of the camera-frame will be the width of the camera-range.

Row

The row to put the Camera into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

RowPoints

The position of the top edge of the Camera in points. If used with the Row argument then the two are added together.

EndRow

The row the will define the height of the camera-frame. The Height argument can be used instead of this. The Height argument will override the EndRow argument. If neither Height nor EndRow are specified then the height of the camera-frame will be the height of the camera-range.

Placement

The placement behavior of the camera-frame. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

SetChart

Sets the specified properties of a chart. The chart is created if it doesn't exist.

Overloads

Overload Name Description

Area

Add or modify a Area chart.

AxisProperties

Set the properties of a chart axis.

Bar

Add or modify a Bar chart.

Column

Add or modify a Column chart.

Format

Set the format properties of a chart.

GroupProperties

Set the properties of a chart group.

LegendProperties

Set the properties of a chart's legend.

Line

Add or modify a Line chart.

Pie

Add or modify a Pie chart.

PointProperties

Set the properties of a chart point.

Remove

Remove a chart.

Select

Select a chart.

SeriesProperties

Set the properties of a chart series.

Stock

Add or modify a Stock chart.

TitleProperties

Set the properties of a chart's title.

XYScatter

Add or modify a XYScatter chart.

Area

Add or modify a Area chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

AreaChartType

Select a chart-type.

DataRange

The address of the chart's data range.

SeriesOrientation

Whether the chart's series are in row or column orientation.

Title

The text for the chart's title.

HasLegend

Whether to display the chart's legend.

OnClickProcedure

The name of the procedure to execute when the chart is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the chart is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Chart into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the chart. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Chart in points. If used with the Column argument then the two are added together.

Row

The row to put the Chart into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the chart. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Chart in points. If used with the Row argument then the two are added together.

Width

The width of the Chart in points. The EndColumn argument can be used instead of this.

Height

The height of the Chart in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the chart's aspect ratio is locked.

Locked

Whether the chart is locked.

Visible

Whether the chart is visible.

PrintChart

Whether to print the chart.

AxisProperties

Set the properties of a chart axis.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

AxisType

The type of the axis (readonly). Use AxisType along with AxisGroup to identify which Axis to modify.

AxisGroup

Specifies which axis group this series is plotted on.

AxisBetweenCategories

Whether the value axis crosses between categories on the category axis.

BaseUnit

The base time unit for a category axis with a time-scale.

BaseUnitIsAuto

Whether the base unit is automatically set based on the category axis data.

CategoryType

The scale type on a category axis.

AxisCrosses

Where the other axis crosses this axis.

AxisCrossesAt

Custom (double) value where the other axis crosses this axis.

HasMajorGridlines

Whether an axis has major gridlines.

HasMinorGridlines

Whether an axis has minor gridlines.

MajorGridlinesColor

Select the color for the major gridlines's.

MajorGridlinesTransparency

From 0.0 to 1.0 (opaque to transparent).

MajorGridlinesVisible

Whether the major gridlines are visible.

MajorGridlinesWeight

The weight of the major gridlines, in points.

MajorTickMark

The type of major tick marks on an axis.

MajorUnit

The major unit of an axis (double).

MajorUnitIsAuto

Whether the major unit is automatically determined on an axis.

MajorUnitScale

The major time unit for a category axis with a time-scale.

MaximumScale

The maximum scale value of an axis (double).

MaximumScaleIsAuto

The maximum scale value of an axis.

MinimumScale

The minimum scale value of an axis (double).

MinimumScaleIsAuto

The minimum scale value of an axis.

ReversePlotOrder

Whether the axis scale values are in reverse order.

ScaleType

The scale type on a value axis.

TickLabelPosition

The tick label position on an axis.

TickLabelsFontName

Font of the chart's tick-labels.

TickLabelsFontBold

Whether the tick-labels are bolded.

TickLabelsFontColor

Select the tick-labels font color.

TickLabelsFontColorIndex

Excel color palette index to use for the tick-labels's Font color. The value is zero-based from 0 to 55.

TickLabelsFontItalic

Whether the tick-labels are italicized.

TickLabelsFontOutline

Whether the tick-label fonts are outlined.

TickLabelsFontShadow

Whether the tick-labels have shadows.

TickLabelsFontSize

Font size of the chart's tick-labels.

TickLabelsFontStrikeThrough

Whether the tick-labels have strikes through them.

TickLabelsFontSubscript

Whether the tick-labels are subscripted.

TickLabelsFontSuperscript

Whether the tick-labels are superscripted.

TickLabelsFontTintAndShade

Controls darkening (values between -1.0 and 0.0) or lightening (values between 0.0 and 1.0) of the underlying theme color.

TickLabelsFontUnderline

None, Single, Double, SingelAccounting, DoubleAccounting.

TickLabelsNumberFormat

Number format of the axis labels. Select number format from a list of format strings for numbers, or enter a valid string.

TickLabelsNumberFormatLinked

Whether the axis labels use the same number format as the cells that contain the data for the axis labels.

TickLabelsOrientation

The text orientation of the axis labels, which may be from -90 to 90 degrees or one of the TickLabelOrientation constants.

TickLabelSpacing

The number of categories between each tick label on a category axis.

TickLabelSpacingIsAuto

Whether the tick label spacing is automatically determined on an axis.

TickMarkSpacing

The number of categories between each tick mark on a category axis.

Bar

Add or modify a Bar chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

BarChartType

Select a chart-type.

DataRange

The address of the chart's data range.

SeriesOrientation

Whether the chart's series are in row or column orientation.

Title

The text for the chart's title.

HasLegend

Whether to display the chart's legend.

OnClickProcedure

The name of the procedure to execute when the chart is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the chart is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Chart into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the chart. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Chart in points. If used with the Column argument then the two are added together.

Row

The row to put the Chart into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the chart. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Chart in points. If used with the Row argument then the two are added together.

Width

The width of the Chart in points. The EndColumn argument can be used instead of this.

Height

The height of the Chart in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the chart's aspect ratio is locked.

Locked

Whether the chart is locked.

Visible

Whether the chart is visible.

PrintChart

Whether to print the chart.

Column

Add or modify a Column chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

ColumnChartType

Select a chart-type.

DataRange

The address of the chart's data range.

SeriesOrientation

Whether the chart's series are in row or column orientation.

Title

The text for the chart's title.

HasLegend

Whether to display the chart's legend.

OnClickProcedure

The name of the procedure to execute when the chart is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the chart is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Chart into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the chart. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Chart in points. If used with the Column argument then the two are added together.

Row

The row to put the Chart into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the chart. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Chart in points. If used with the Row argument then the two are added together.

Width

The width of the Chart in points. The EndColumn argument can be used instead of this.

Height

The height of the Chart in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the chart's aspect ratio is locked.

Locked

Whether the chart is locked.

Visible

Whether the chart is visible.

PrintChart

Whether to print the chart.

Format

Set the format properties of a chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for the fill back color. The value is zero-based from 0 to 55.

FillColor

Select the color for the fill's forecolor.

FillColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

FontName

Select a font.

FontSize

Select or specify a font size.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontBold

Whether the font is bolded.

FontItalic

Whether the font is italicized.

FontOutline

Whether the font is outlined.

FontShadow

Whether the font is shadowed.

FontStrikeThrough

Whether to apply Font strikethrough.

FontSubscript

Whether the font is subscripted.

FontSuperscript

Whether the font is superscripted.

FontTintAndShade

Specifies the TintAndShade of the font. Values between -1.0 and 0.0 darken, while values between 0.0 and 1.0 lighten the font color.

FontUnderline

None, Single, Double, SingelAccounting, DoubleAccounting.

GroupProperties

Set the properties of a chart group.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

GroupIndex

The index of the chart group. This value is used to identify which chart group to modify.

BubbleScale

The percentage of the default bubble size to use for the size of bubbles on a bubble chart.

DoughnutHoleSize

The percentage of the chart size to use for the size of the hole in a doughnut chart.

DownBarsFillColor

The fill color of the group's DownBars.

DownBarsFillTransparency

The fill transparency of the group's DownBars. From 0.0 to 1.0 (opaque to transparent).

DownBarsFillVisible

The fill visible of the group's DownBars.

DownBarsLineColor

The color of the group's SeriesLines DownBars.

DownBarsLineTransparency

The transparency of the group's SeriesLines DownBars. From 0.0 to 1.0 (opaque to transparent).

DownBarsLineVisible

The visible of the group's SeriesLines DownBars.

DownBarsLineWeight

The weight of the group's SeriesLines DownBars.

DropLinesFillColor

The fill color of the group's DropLines.

DropLinesFillTransparency

The fill transparency of the group's DropLines. From 0.0 to 1.0 (opaque to transparent).

DropLinesFillVisible

The fill visible of the group's DropLines.

DropLinesLineColor

The color of the group's SeriesLines DropLines.

DropLinesLineTransparency

The transparency of the group's SeriesLines DropLines. From 0.0 to 1.0 (opaque to transparent).

DropLinesLineVisible

The visible of the group's SeriesLines DropLines.

DropLinesLineWeight

The weight of the group's SeriesLines DropLines.

FirstSliceAngle

The angle, in degrees, of the first slice in a pie or doughnut chart.

GapWidth

The distance between bars in a clustered bar chart as a percentage of the bar width, or the distance between each plotted section in a pie of pie chart.

Has3DShading

Whether a surface chart has 3D shading.

HasDropLines

Whether a line or area chart has drop lines.

HasHiLoLines

Whether a line chart has high-low lines.

HasRadarAxisLabels

Whether a radar chart has axis labels.

HasSeriesLines

Whether a stacked bar or pie of pie chart has series lines.

HasUpDownBars

Whether a line chart has up and down bars.

HiLoLinesFillColor

The fill color of the group's HiLoLines.

HiLoLinesFillTransparency

The fill transparency of the group's HiLoLines. From 0.0 to 1.0 (opaque to transparent).

HiLoLinesFillVisible

The fill visible of the group's HiLoLines.

HiLoLinesLineColor

The color of the group's SeriesLines HiLoLines.

HiLoLinesLineTransparency

The transparency of the group's SeriesLines HiLoLines. From 0.0 to 1.0 (opaque to transparent).

HiLoLinesLineVisible

The visible of the group's SeriesLines HiLoLines.

HiLoLinesLineWeight

The weight of the group's SeriesLines HiLoLines.

Overlap

The overlap or space between bars within a category as a percentage of the bar width.".

RadarAxisLabelsFont

The name of the font to use for the axis labels of a radar chart.

RadarAxisLabelsFontBold

Whether to bold the axis labels of a radar chart.

RadarAxisLabelsFontColor

The font color to use for the axis labels of a radar chart.

RadarAxisLabelsFontColorIndex

The Excel color index to use for the font of the axis labels of a radar chart. The value is zero-based from 0 to 55.

RadarAxisLabelsFontItalic

Whether to italicize the axis labels of a radar chart.

RadarAxisLabelsFontOutline

Whether to outline the axis labels of a radar chart.

RadarAxisLabelsFontShadow

Whether to apply shadow to the axis labels of a radar chart.

RadarAxisLabelsFontSize

The font size to use for the axis labels of a radar chart.

RadarAxisLabelsFontStrikeThrough

Whether to apply strikethrough to the axis labels of a radar chart.

RadarAxisLabelsFontSubscript

Whether to subscript the axis labels of a radar chart.

RadarAxisLabelsFontSuperscript

Whether to superscript the axis labels of a radar chart.

RadarAxisLabelsFontTintAndShade

The tint-and-shade value to apply to the axis labels of a radar chart.

RadarAxisLabelsFontUnderline

The underline style to apply to the axis labels of a radar chart.

SecondPlotSize

The size of the second plot as a percentage of the size of the first plot on a pie of pie chart.

SeriesLinesFillColor

The fill color of the group's SeriesLines (of a stacked bar or pie of pie chart).

SeriesLinesFillTransparency

The fill transparency of the group's SeriesLines (of a stacked bar or pie of pie chart). From 0.0 to 1.0 (opaque to transparent).

SeriesLinesFillVisible

The fill visible of the group's SeriesLines (of a stacked bar or pie of pie chart).

SeriesLinesLineColor

The color of the group's SeriesLines (of a stacked bar or pie of pie chart).

SeriesLinesLineTransparency

The transparency of the group's SeriesLines (of a stacked bar or pie of pie chart). From 0.0 to 1.0 (opaque to transparent).

SeriesLinesLineVisible

The visible of the group's SeriesLines (of a stacked bar or pie of pie chart).

SeriesLinesLineWeight

The weight of the group's SeriesLines (of a stacked bar or pie of pie chart).

ShowNegativeBubbles

Whether bubbles with negative values are shown on a bubble chart.

SizeRepresents

What the size values represent on a bubble chart.

SplitType

The property which specifies how values are split on a pie of pie chart.

SplitValue

The property which specifies the separation value on a pie of pie chart.

UpBarsFillColor

The fill color of the group's UpBars.

UpBarsFillTransparency

The fill transparency of the group's UpBars. From 0.0 to 1.0 (opaque to transparent).

UpBarsFillVisible

The fill visible of the group's UpBars.

UpBarsLineColor

The color of the group's SeriesLines UpBars.

UpBarsLineTransparency

The transparency of the group's SeriesLines UpBars. From 0.0 to 1.0 (opaque to transparent).

UpBarsLineVisible

The visible of the group's SeriesLines UpBars.

UpBarsLineWeight

The weight of the group's SeriesLines UpBars.

VaryByCategories

Whether colors are varied for each data point of the first series in a chart containing only one series.

LegendProperties

Set the properties of a chart's legend.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

IncludeInLayout

Whether the legend will be included in the chart layout area.

Position

The position of the legend.

Left

The left position.

Top

The top position of the chart title.

LegendHeight

The height of the legend.

LegendWidth

The width of the legend.

BorderColor

Select the color for the line forecolor.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

FillColor

Select the color for the fill's forecolor.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FontName

Select a font.

FontSize

Select or specify a font size.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontBold

Whether the font is bolded.

FontItalic

Whether the font is italicized.

FontOutline

Whether the font is outlined.

FontShadow

Whether the font is shadowed.

FontStrikeThrough

Whether to apply Font strikethrough.

FontSubscript

Whether the font is subscripted.

FontSuperscript

Whether the font is superscripted.

FontTintAndShade

Specifies the TintAndShade of the font. Values between -1.0 and 0.0 darken, while values between 0.0 and 1.0 lighten the font color.

FontUnderline

None, Single, Double, SingelAccounting, DoubleAccounting.

Line

Add or modify a Line chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

LineChartType

Select a chart-type.

DataRange

The address of the chart's data range.

SeriesOrientation

Whether the chart's series are in row or column orientation.

Title

The text for the chart's title.

HasLegend

Whether to display the chart's legend.

OnClickProcedure

The name of the procedure to execute when the chart is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the chart is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Chart into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the chart. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Chart in points. If used with the Column argument then the two are added together.

Row

The row to put the Chart into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the chart. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Chart in points. If used with the Row argument then the two are added together.

Width

The width of the Chart in points. The EndColumn argument can be used instead of this.

Height

The height of the Chart in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the chart's aspect ratio is locked.

Locked

Whether the chart is locked.

Visible

Whether the chart is visible.

PrintChart

Whether to print the chart.

Pie

Add or modify a Pie chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

PieChartType

Select a chart-type.

DataRange

The address of the chart's data range.

SeriesOrientation

Whether the chart's series are in row or column orientation.

Title

The text for the chart's title.

HasLegend

Whether to display the chart's legend.

OnClickProcedure

The name of the procedure to execute when the chart is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the chart is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Chart into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the chart. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Chart in points. If used with the Column argument then the two are added together.

Row

The row to put the Chart into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the chart. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Chart in points. If used with the Row argument then the two are added together.

Width

The width of the Chart in points. The EndColumn argument can be used instead of this.

Height

The height of the Chart in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the chart's aspect ratio is locked.

Locked

Whether the chart is locked.

Visible

Whether the chart is visible.

PrintChart

Whether to print the chart.

PointProperties

Set the properties of a chart point.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

SeriesName

The name that identifies the series.

SeriesIndex

The one-based index that identifies the series.

PointIndex

The one-based index that identifies the point within the series.

HasDataLabel

Specifies whether the series has data labels.

DataLabelAutoText

Specifies whether the text is automatically generated based on the data label type.

DataLabelFillColor

Specifies the data label fill color.

DataLabelFillColorSpec

Specifies the data label fill color as an ARGB (alpha, red, green, blue) string, such as Color [A=255, R=255, G=192, B=0].

DataLabelFillTransparency

Specifies the transparency. From 0.0 to 1.0 (opaque to transparent).

DataLabelFillVisible

Specifies whether the fill is visible.

DataLabelFontName

Specifies the font.

DataLabelFontBold

Whether the data-labels are bolded.

DataLabelFontColor

Specifies the data-labels font color.

DataLabelFontColorIndex

Excel color palette index to use for the data-labels's Font color. The value is zero-based from 0 to 55.

DataLabelFontItalic

Whether the data-labels are italicized.

DataLabelFontOutline

Whether the data-label fonts are outlined.

DataLabelFontShadow

Whether the data-labels have shadows.

DataLabelFontSize

Font size of the series' data-labels.

DataLabelFontStrikeThrough

Whether the data-labels have strikes through them.

DataLabelFontSubscript

Whether the data-labels are subscripted.

DataLabelFontSuperscript

Whether the data-labels are superscripted.

DataLabelFontTintAndShade

Specifies the TintAndShade of the font. Values between -1.0 and 0.0 darken, while values between 0.0 and 1.0 lighten the font color.

DataLabelFontUnderline

Specifies the underline style of the font.

DataLabelLineColor

Specifies the data label line color.

DataLabelLineColorSpec

Specifies the data label line color as an ARGB (alpha, red, green, blue) string, such as Color [A=255, R=255, G=192, B=0].

DataLabelLineTransparency

Specifies the transparency of the lines. From 0.0 to 1.0 (opaque to transparent).

DataLabelLineVisible

Specifies whether the lines are visible.

DataLabelLineWeight

Specifies the weight of the lines, in points.

DataLabelNumberFormat

Specifies the number format.

DataLabelNumberFormatLinked

Specifies whether to use the same number format as the cells that contain the data for the associated data points.

DataLabelPosition

Specifies the position (Mixed, Automatic, OutsideEnd, InsideEnd, Center, InsideBase, Above, Below, Left, Right, BestFit, Custom).

DataLabelShowBubbleSize

Specifies whether to show the bubble size.

DataLabelShowCategoryName

Specifies whether to show the category name.

DataLabelShowLegendKey

Specifies whether to show the legend key.

DataLabelShowPercentage

Specifies whether the show the percentage.

DataLabelShowValue

Specifies whether to show the value.

DataLabelText

The text of the point's data label.

Explosion

Specifies the explosion value for all of the data points on a pie or doughnut chart.

PointFillColor

Specifies the fill color.

PointFillColorSpec

Specifies the fill color as an ARGB (alpha, red, green, blue) string, such as Color [A=255, R=255, G=192, B=0].

PointFillTransparency

Specifies the transparency. From 0.0 to 1.0 (opaque to transparent).

PointFillVisible

Specifies whether the fill is visible.

PointLineColor

Specifies the point line color.

PointLineColorSpec

Specifies the point line color as an ARGB (alpha, red, green, blue) string, such as Color [A=255, R=255, G=192, B=0].

PointLineTransparency

Specifies the transparency of the lines. From 0.0 to 1.0 (opaque to transparent).

PointLineVisible

Specifies whether the lines are visible.

PointLineWeight

Specifies the weight of the lines, in points.

InvertIfNegative

Specifies whether pattern colors are inverted on data points with negative values.

MarkerSize

Specifies the size of the markers in points.

MarkerStyle

Specifies the marker style.

SecondaryPlot

Whether the data point is in the secondary plot on a pie of pie chart.

Remove

Remove a chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

Select

Select a chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

Replace

Whether to replace the current selection of charts, or add this chart to the selections.

SeriesProperties

Set the properties of a chart series.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

SeriesName

The name that identifies the series.

SeriesIndex

The one-based index that identifies the series.

AxisGroup

Specifies which axis group this series is plotted on.

BarShape

Specifies the shape of 3D bars.

BubbleSizes

The bubble size values for the series.

ChartType

Specifies the chart type of the series.

HasDataLabel

Specifies whether the series has data labels.

DataLabelAutoText

Specifies whether the text is automatically generated based on the data label type.

DataLabelFillColor

Specifies the data label fill color.

DataLabelFillTransparency

Specifies the transparency. From 0.0 to 1.0 (opaque to transparent).

DataLabelFillVisible

Specifies whether the fill is visible.

DataLabelFontName

Specifies the font.

DataLabelFontBold

Whether the data-labels are bolded.

DataLabelFontColor

Specifies the data-labels font color.

DataLabelFontColorIndex

Excel color palette index to use for the data-labels's Font color. The value is zero-based from 0 to 55.

DataLabelFontItalic

Whether the data-labels are italicized.

DataLabelFontOutline

Whether the data-label fonts are outlined.

DataLabelFontShadow

Whether the data-labels have shadows.

DataLabelFontSize

Font size of the series' data-labels.

DataLabelFontStrikeThrough

Whether the data-labels have strikes through them.

DataLabelFontSubscript

Whether the data-labels are subscripted.

DataLabelFontSuperscript

Whether the data-labels are superscripted.

DataLabelFontTintAndShade

Specifies the TintAndShade of the font. Values between -1.0 and 0.0 darken, while values between 0.0 and 1.0 lighten the font color.

DataLabelFontUnderline

Specifies the underline style of the font.

DataLabelLineColor

Specifies the data label line color.

DataLabelLineTransparency

Specifies the transparency of the lines. From 0.0 to 1.0 (opaque to transparent).

DataLabelLineVisible

Specifies whether the lines are visible.

DataLabelLineWeight

Specifies the weight of the lines, in points.

DataLabelNumberFormat

Specifies the number format.

DataLabelNumberFormatLinked

Specifies whether to use the same number format as the cells that contain the data for the associated data points.

DataLabelPosition

Specifies the position (Mixed, Automatic, OutsideEnd, InsideEnd, Center, InsideBase, Above, Below, Left, Right, BestFit, Custom).

DataLabelShowBubbleSize

Specifies whether to show the bubble size.

DataLabelShowCategoryName

Specifies whether to show the category name.

DataLabelShowLegendKey

Specifies whether to show the legend key.

DataLabelShowPercentage

Specifies whether the show the percentage.

DataLabelShowValue

Specifies whether to show the value.

HasErrorBars

Specifies whether the series has error bars.

ErrorBarsEndStyle

The end style cap of the series' error bars.

ErrorBarsFillColor

Specifies the fill color of the series' error bars.

ErrorBarsFillTransparency

Specifies the transparency of the series' error bars fill. From 0.0 to 1.0 (opaque to transparent).

ErrorBarsFillVisible

Specifies whether the series' error bars fill is visible.

ErrorBarsLineColor

Specifies the series' error bars line color.

ErrorBarsLineTransparency

Specifies the transparency of the series' error bar lines. From 0.0 to 1.0 (opaque to transparent).

ErrorBarsLineVisible

Specifies whether the series' error bar lines are visible.

ErrorBarsLineWeight

Specifies the weight of the series' error bar lines, in points.

Explosion

Specifies the explosion value for all of the data points on a pie or doughnut chart.

SeriesFillColor

Specifies the fill color of the series.

SeriesFillTransparency

Specifies the transparency of the series' fill. From 0.0 to 1.0 (opaque to transparent).

SeriesFillVisible

Specifies whether the series' fill is visible.

SeriesLineColor

Specifies the series' line color.

SeriesLineTransparency

Specifies the transparency of the series' lines. From 0.0 to 1.0 (opaque to transparent).

SeriesLineVisible

Specifies whether the series' lines are visible.

SeriesLineWeight

Specifies the weight of the series' lines, in points.

Has3DEffect

Specifies whether all the bubbles in a bubble series are displayed with a 3D effect.

InvertIfNegative

Specifies whether pattern colors are inverted on data points with negative values.

HasLeaderLines

Specifies whether the series has leader lines.

LeaderLinesColor

Specifies the series' leader lines color.

LeaderLinesTransparency

Specifies the transparency of the series' leader lines. From 0.0 to 1.0 (opaque to transparent).

LeaderLinesVisible

Specifies whether the series' leader lines are visible.

LeaderLinesWeight

Specifies the weight of the series' leader lines, in points.

MarkerSize

Specifies the size of the markers in points.

MarkerStyle

Specifies the marker style.

SeriesValues

The address of the series' data range.

SeriesXValues

The address of the series' X (horizontal) axis values.

Smooth

Specifies whether smoothing is used on a line series.

Stock

Add or modify a Stock chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

StockChartType

Select a chart-type.

DataRange

The address of the chart's data range.

SeriesOrientation

Whether the chart's series are in row or column orientation.

Title

The text for the chart's title.

HasLegend

Whether to display the chart's legend.

OnClickProcedure

The name of the procedure to execute when the chart is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the chart is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Chart into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the chart. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Chart in points. If used with the Column argument then the two are added together.

Row

The row to put the Chart into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the chart. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Chart in points. If used with the Row argument then the two are added together.

Width

The width of the Chart in points. The EndColumn argument can be used instead of this.

Height

The height of the Chart in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the chart's aspect ratio is locked.

Locked

Whether the chart is locked.

Visible

Whether the chart is visible.

PrintChart

Whether to print the chart.

TitleProperties

Set the properties of a chart's title.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

Title

The text for the chart's title.

Left

The left position.

Top

The top position of the chart title.

BorderColor

Select the color for the line forecolor.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

FillColor

Select the color for the fill's forecolor.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FontName

Select a font.

FontSize

Select or specify a font size.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontBold

Whether the font is bolded.

FontItalic

Whether the font is italicized.

FontOutline

Whether the font is outlined.

FontShadow

Whether the font is shadowed.

FontStrikeThrough

Whether to apply Font strikethrough.

FontSubscript

Whether the font is subscripted.

FontSuperscript

Whether the font is superscripted.

FontTintAndShade

Specifies the TintAndShade of the font. Values between -1.0 and 0.0 darken, while values between 0.0 and 1.0 lighten the font color.

FontUnderline

None, Single, Double, SingelAccounting, DoubleAccounting.

XYScatter

Add or modify a XYScatter chart.

Argument Description

ChartName

The name assigned to the Chart. This can be used to identify the chart after it is created.

XYScatterChartType

Select a chart-type.

DataRange

The address of the chart's data range.

SeriesOrientation

Whether the chart's series are in row or column orientation.

Title

The text for the chart's title.

HasLegend

Whether to display the chart's legend.

OnClickProcedure

The name of the procedure to execute when the chart is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the chart is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Chart into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the chart. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Chart in points. If used with the Column argument then the two are added together.

Row

The row to put the Chart into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the chart. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Chart in points. If used with the Row argument then the two are added together.

Width

The width of the Chart in points. The EndColumn argument can be used instead of this.

Height

The height of the Chart in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the chart's aspect ratio is locked.

Locked

Whether the chart is locked.

Visible

Whether the chart is visible.

PrintChart

Whether to print the chart.

SetColor

Set the color of a specified Excel color palette index.

Overloads

Overload Name Description

General

Set the color of a specified Excel color palette index.

General

Set the color of a specified Excel color palette index.

Argument Description

Color

The color to set for the specified color-index. This will override ColorSelect if both are specified.

ColorSelect

Select the color to set for the specified color-index. This will be overridden by Color if both are specified.

Index

The color-index of the Excel color palette. The value is zero-based from 0 to 55.

SetColumnWidth

Set column widths.

Overloads

Overload Name Description

AutoFit

AutoFit the width of a column or a range of columns with Min/Max option.

Hide

Hide a column or a range of columns.

SetWidth

Set the width of a column or a range of columns to a specific value.

StandardWidth

Set the width of a column or a range of columns to the standard width.

Unhide

Unhide a column or a range of columns.

AutoFit

AutoFit the width of a column or a range of columns with Min/Max option.

Argument Description

MinWidth

The minimum column width to set using auto-fit.

MaxWidth

The maximum column width to set using auto-fit.

Hide

Hide a column or a range of columns.

Argument Description

SetWidth

Set the width of a column or a range of columns to a specific value.

Argument Description

Width

The column width.

MinWidth

The minimum column width to set using auto-fit.

MaxWidth

The maximum column width to set using auto-fit.

StandardWidth

Set the width of a column or a range of columns to the standard width.

Argument Description

Unhide

Unhide a column or a range of columns.

Argument Description

SetComment

Dodeca comments.

Overloads

Overload Name Description

Add

Add a Dodeca comment.

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.

Save

Save the view's Dodeca comments.

Add

Add a Dodeca comment.

Argument Description

CommentText

The text of the 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 string 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.

PropertyNameForNewID

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

PropertyNameForKeyHash

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

DeleteByCommentID

Delete the Dodeca comment that has the specified CommentID.

Argument Description

CommentID

The CommentID of the comment.

DeleteByKeyHash

Delete all Dodeca comments that have the specified KeyHash.

Argument Description

KeyHash

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

DeleteByKeyItems

Delete all Dodeca comments that have the specified KeyItems.

Argument Description

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.

Save

Save the view's Dodeca comments.

Argument Description

SetConditionalFormat

Set or clear conditional formats.

Overloads

Overload Name Description

Clear

Clear conditional formatting.

Set

Set conditional formatting.

Clear

Clear conditional formatting.

Argument Description

Set

Set conditional formatting.

Argument Description

Type

Whether the conditional format compares the values of cells or contains a formula.

Operator

The operator to be used by a conditional format.

Minimum

The first formula of the conditional format.

Maximum

The second formula of the conditional format.

BorderLeftStyle

Excel LineStyle to use for left border.

BorderLeftWeight

WeightNumber to use for left border.

BorderLeftColorRGB

Select a color to use for the left border color. BorderLeftColorRGB will be used if BorderLeftColor and BorderLeftColorRGB are both specified.

BorderLeftColor

Excel color palette index to use for left border color. The value is zero-based from 0 to 55.

BorderRightStyle

Excel LineStyle to use for right border.

BorderRightWeight

WeightNumber to use for right border.

BorderRightColorRGB

Select a color to use for the right border color. BorderRightColorRGB will be used if BorderRightColor and BorderRightColorRGB are both specified.

BorderRightColor

Excel color palette index to use for right border color. The value is zero-based from 0 to 55.

BorderTopStyle

Excel LineStyle to use for top border.

BorderTopWeight

WeightNumber to use for top border.

BorderTopColorRGB

Select a color to use for the top border color. BorderTopColorRGB will be used if BorderTopColor and BorderTopColorRGB are both specified.

BorderTopColor

Excel color palette index to use for top border color. The value is zero-based from 0 to 55.

BorderBottomStyle

Excel LineStyle to use for bottom border.

BorderBottomWeight

WeightNumber to use for bottom border.

BorderBottomColorRGB

Select a color to use for the bottom border color. BorderBottomColorRGB will be used if BorderBottomColor and BorderBottomColorRGB are both specified.

BorderBottomColor

Excel color palette index to use for bottom border color. The value is zero-based from 0 to 55.

FontName

Font to apply.

FontStyle

Regular, Italic, Bold, or BoldItalic.

FontSize

Font size to apply.

FontUnderline

None, Single, Double, SingelAccounting, DoubleAccounting.

FontColorRGB

Select a color to use for the font color. FontColorRGB will be used if FontColor and FontColorRGB are both specified.

FontColor

Excel color palette index to use for the Font color. The value is zero-based from 0 to 55.

FontStrikeThrough

Whether to apply Font strikethrough format.

FillColorRGB

Select a color to use for the fill color. FillColorRGB will be used if FillColor and FillColorRGB are both specified.

FillColor

Excel color palette index to use for fill color. The value is zero-based from 0 to 55.

PatternColorRGB

Select a color to use for the pattern color. PatternColorRGB will be used if PatternColor and PatternColorRGB are both specified.

PatternColor

Excel color palette index to use for pattern color. The value is zero-based from 0 to 55.

Pattern

Pattern to use for fill.

SetControl

Creates the specified Control if it doesn't exist, and sets the specified properties of it.

Overloads

Overload Name Description

AddItem

Add an item to the list of a drop-down or list-box control.

BringForward

Bring a control forward.

BringToFront

Bring a control to front.

Button

Add or modify a Button control.

CheckBox

Add or modify a CheckBox control.

DropDown

Add or modify a DropDown control.

FlipHorizontal

Flip a control horizontally.

FlipVertical

Flip a control vertically.

IncrementLeft

Increment the left position of a control.

IncrementTop

Increment the top position of a control.

Label

Add or modify a Label control.

ListBox

Add or modify a ListBox control.

Remove

Remove a control.

RemoveAllItems

Remove all items from a drop-down or list-box control's list. If the control's list is linked to a range then the link is removed.

RemoveItem

Remove an item from a drop-down or list-box control's list. Does nothing if the control's list is linked to a range.

ScaleHeight

Scales a control per the specified factor.

ScaleWidth

Scales a control per the specified factor.

ScrollBar

Add or modify a ScrollBar control.

Select

Select a control.

SendBackward

Send a control backwards.

SendToBack

Send a control to the back.

Spinner

Add or modify a Spinner control.

AddItem

Add an item to the list of a drop-down or list-box control.

Argument Description

Name

The name of the Control.

ItemText

For the AddItem overload, the text of the item to be added. For the RemoveItem overload, either the ListIndex or the ItemText can be used to indicate the item to be removed. If both are specified, the ListIndex is used.

ListIndex

The index of the selected item in the control's list.

BringForward

Bring a control forward.

Argument Description

Name

The name of the Control.

BringToFront

Bring a control to front.

Argument Description

Name

The name of the Control.

Button

Add or modify a Button control.

Argument Description

Name

The name of the Control.

Text

The text.

OnClickProcedure

The name of the procedure to execute when the control is clicked. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnDoubleClickProcedure

The name of the procedure to execute when the control is double-clicked. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Control into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column that will define the width of the control. The Width argument can be used instead of EndColumn.

ColumnPoints

The position of the left edge of the Control in points. If used with the Column argument then the two are added together.

Row

The row to put the Control into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the control. The Height argument can be used instead of EndRow.

RowPoints

The position of the top edge of the Control in points. If used with the Row argument then the two are added together.

Width

The width of the Control in points. The EndColumn argument can be used instead of this argument.

Height

The height of the Control in points. The EndRow argument can be used instead of this argument.

LockAspectRatio

Whether the control's aspect ratio is locked.

Locked

Whether the control is locked.

Visible

Whether the control is visible.

PrintControl

Whether to print the control.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for fill background color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

FontBold

Whether font is bold.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontItalic

Wether the font is italicized.

FontName

Select a font.

FontOutlineFont

Whether the font has the outline effect.

FontShadow

Whether the font has the shadow effect.

FontSize

The font size, in points.

FontStrikethrough

Whether the font has the strikethrough effect.

FontSubscript

Whether the font has the subscript effect.

FontSuperscript

Whether the font has the superscript effect.

FontUnderline

Whether the font has the underline effect.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

TextAutoSize

Whether the size of the text box will increase to display all of the text.

TextHorizontalAlignment

The horizontal alignment.

TextLockText

Whether text will be locked when sheet protection is enabled.

TextMarginBottom

The bottom margin of this text box in points.

TextMarginLeft

The left margin of this text box in points.

TextMarginRight

The right margin of this text box in points.

TextMarginTop

The top margin of this text box in points.

TextOrientation

The orientation of the text.

TextVerticalAlignment

The vertical alignment.

CheckBox

Add or modify a CheckBox control.

Argument Description

Name

The name of the Control.

Text

The text.

Value

The Value to assign to the control. Control values are always numeric.

OnCheckStateChangedProcedure

The name of the procedure to execute when the state of a checkbox changes. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnClickProcedure

The name of the procedure to execute when the control is clicked. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnDoubleClickProcedure

The name of the procedure to execute when the control is double-clicked. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnValueChangedProcedure

The name of the procedure to execute when the value of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

LinkedCell

The address of a cell that will be linked to the value of the control.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Control into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column that will define the width of the control. The Width argument can be used instead of EndColumn.

ColumnPoints

The position of the left edge of the Control in points. If used with the Column argument then the two are added together.

Row

The row to put the Control into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the control. The Height argument can be used instead of EndRow.

RowPoints

The position of the top edge of the Control in points. If used with the Row argument then the two are added together.

Width

The width of the Control in points. The EndColumn argument can be used instead of this argument.

Height

The height of the Control in points. The EndRow argument can be used instead of this argument.

LockAspectRatio

Whether the control's aspect ratio is locked.

Locked

Whether the control is locked.

Visible

Whether the control is visible.

PrintControl

Whether to print the control.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for fill background color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

FontBold

Whether font is bold.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontItalic

Wether the font is italicized.

FontName

Select a font.

FontOutlineFont

Whether the font has the outline effect.

FontShadow

Whether the font has the shadow effect.

FontSize

The font size, in points.

FontStrikethrough

Whether the font has the strikethrough effect.

FontSubscript

Whether the font has the subscript effect.

FontSuperscript

Whether the font has the superscript effect.

FontUnderline

Whether the font has the underline effect.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

TextAutoSize

Whether the size of the text box will increase to display all of the text.

TextHorizontalAlignment

The horizontal alignment.

TextLockText

Whether text will be locked when sheet protection is enabled.

TextMarginBottom

The bottom margin of this text box in points.

TextMarginLeft

The left margin of this text box in points.

TextMarginRight

The right margin of this text box in points.

TextMarginTop

The top margin of this text box in points.

TextOrientation

The orientation of the text.

TextVerticalAlignment

The vertical alignment.

DropDown

Add or modify a DropDown control.

Argument Description

Name

The name of the Control.

ItemsList

A semicolon delimited list of items to add to the control.

Text

The text.

DropDownLines

Specifies the number of items to display at one time in a dropdown.

Value

The Value to assign to the control. Control values are always numeric.

ValueText

The text of the item to select.

OnClickProcedure

The name of the procedure to execute when the control is clicked. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnDoubleClickProcedure

The name of the procedure to execute when the control is double-clicked. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnSelectedIndexChangedProcedure

The name of the procedure to execute when the selected item of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnTextChangedProcedure

The name of the procedure to execute when the text of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnValueChangedProcedure

The name of the procedure to execute when the value of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

LinkedCell

The address of a cell that will be linked to the value of the control.

ListFillRange

The address of a range that will be used to populate the list of the control.

ListIndex

The index of the selected item in the control's list.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Control into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column that will define the width of the control. The Width argument can be used instead of EndColumn.

ColumnPoints

The position of the left edge of the Control in points. If used with the Column argument then the two are added together.

Row

The row to put the Control into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the control. The Height argument can be used instead of EndRow.

RowPoints

The position of the top edge of the Control in points. If used with the Row argument then the two are added together.

Width

The width of the Control in points. The EndColumn argument can be used instead of this argument.

Height

The height of the Control in points. The EndRow argument can be used instead of this argument.

LockAspectRatio

Whether the control's aspect ratio is locked.

Locked

Whether the control is locked.

Visible

Whether the control is visible.

PrintControl

Whether to print the control.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for fill background color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

FontBold

Whether font is bold.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontItalic

Wether the font is italicized.

FontName

Select a font.

FontOutlineFont

Whether the font has the outline effect.

FontShadow

Whether the font has the shadow effect.

FontSize

The font size, in points.

FontStrikethrough

Whether the font has the strikethrough effect.

FontSubscript

Whether the font has the subscript effect.

FontSuperscript

Whether the font has the superscript effect.

FontUnderline

Whether the font has the underline effect.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

TextAutoSize

Whether the size of the text box will increase to display all of the text.

TextHorizontalAlignment

The horizontal alignment.

TextLockText

Whether text will be locked when sheet protection is enabled.

TextMarginBottom

The bottom margin of this text box in points.

TextMarginLeft

The left margin of this text box in points.

TextMarginRight

The right margin of this text box in points.

TextMarginTop

The top margin of this text box in points.

TextOrientation

The orientation of the text.

TextVerticalAlignment

The vertical alignment.

FlipHorizontal

Flip a control horizontally.

Argument Description

Name

The name of the Control.

FlipVertical

Flip a control vertically.

Argument Description

Name

The name of the Control.

IncrementLeft

Increment the left position of a control.

Argument Description

Name

The name of the Control.

Increment

Specifies the increment in points.

IncrementTop

Increment the top position of a control.

Argument Description

Name

The name of the Control.

Increment

Specifies the increment in points.

Label

Add or modify a Label control.

Argument Description

Name

The name of the Control.

Text

The text.

OnClickProcedure

The name of the procedure to execute when the control is clicked. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnDoubleClickProcedure

The name of the procedure to execute when the control is double-clicked. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Control into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column that will define the width of the control. The Width argument can be used instead of EndColumn.

ColumnPoints

The position of the left edge of the Control in points. If used with the Column argument then the two are added together.

Row

The row to put the Control into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the control. The Height argument can be used instead of EndRow.

RowPoints

The position of the top edge of the Control in points. If used with the Row argument then the two are added together.

Width

The width of the Control in points. The EndColumn argument can be used instead of this argument.

Height

The height of the Control in points. The EndRow argument can be used instead of this argument.

LockAspectRatio

Whether the control's aspect ratio is locked.

Locked

Whether the control is locked.

Visible

Whether the control is visible.

PrintControl

Whether to print the control.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for fill background color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

FontBold

Whether font is bold.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontItalic

Wether the font is italicized.

FontName

Select a font.

FontOutlineFont

Whether the font has the outline effect.

FontShadow

Whether the font has the shadow effect.

FontSize

The font size, in points.

FontStrikethrough

Whether the font has the strikethrough effect.

FontSubscript

Whether the font has the subscript effect.

FontSuperscript

Whether the font has the superscript effect.

FontUnderline

Whether the font has the underline effect.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

TextAutoSize

Whether the size of the text box will increase to display all of the text.

TextHorizontalAlignment

The horizontal alignment.

TextLockText

Whether text will be locked when sheet protection is enabled.

TextMarginBottom

The bottom margin of this text box in points.

TextMarginLeft

The left margin of this text box in points.

TextMarginRight

The right margin of this text box in points.

TextMarginTop

The top margin of this text box in points.

TextOrientation

The orientation of the text.

TextVerticalAlignment

The vertical alignment.

ListBox

Add or modify a ListBox control.

Argument Description

Name

The name of the Control.

ItemsList

A semicolon delimited list of items to add to the control.

Text

The text.

Value

The Value to assign to the control. Control values are always numeric.

ValueText

The text of the item to select.

OnClickProcedure

The name of the procedure to execute when the control is clicked. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnDoubleClickProcedure

The name of the procedure to execute when the control is double-clicked. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnSelectedIndexChangedProcedure

The name of the procedure to execute when the selected item of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnTextChangedProcedure

The name of the procedure to execute when the text of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnValueChangedProcedure

The name of the procedure to execute when the value of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

LinkedCell

The address of a cell that will be linked to the value of the control.

ListFillRange

The address of a range that will be used to populate the list of the control.

ListIndex

The index of the selected item in the control's list.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Control into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column that will define the width of the control. The Width argument can be used instead of EndColumn.

ColumnPoints

The position of the left edge of the Control in points. If used with the Column argument then the two are added together.

Row

The row to put the Control into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the control. The Height argument can be used instead of EndRow.

RowPoints

The position of the top edge of the Control in points. If used with the Row argument then the two are added together.

Width

The width of the Control in points. The EndColumn argument can be used instead of this argument.

Height

The height of the Control in points. The EndRow argument can be used instead of this argument.

LockAspectRatio

Whether the control's aspect ratio is locked.

Locked

Whether the control is locked.

Visible

Whether the control is visible.

PrintControl

Whether to print the control.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for fill background color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

FontBold

Whether font is bold.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontItalic

Wether the font is italicized.

FontName

Select a font.

FontOutlineFont

Whether the font has the outline effect.

FontShadow

Whether the font has the shadow effect.

FontSize

The font size, in points.

FontStrikethrough

Whether the font has the strikethrough effect.

FontSubscript

Whether the font has the subscript effect.

FontSuperscript

Whether the font has the superscript effect.

FontUnderline

Whether the font has the underline effect.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

TextAutoSize

Whether the size of the text box will increase to display all of the text.

TextHorizontalAlignment

The horizontal alignment.

TextLockText

Whether text will be locked when sheet protection is enabled.

TextMarginBottom

The bottom margin of this text box in points.

TextMarginLeft

The left margin of this text box in points.

TextMarginRight

The right margin of this text box in points.

TextMarginTop

The top margin of this text box in points.

TextOrientation

The orientation of the text.

TextVerticalAlignment

The vertical alignment.

Remove

Remove a control.

Argument Description

Name

The name of the Control.

RemoveAllItems

Remove all items from a drop-down or list-box control's list. If the control's list is linked to a range then the link is removed.

Argument Description

Name

The name of the Control.

RemoveItem

Remove an item from a drop-down or list-box control's list. Does nothing if the control's list is linked to a range.

Argument Description

Name

The name of the Control.

ItemText

For the AddItem overload, the text of the item to be added. For the RemoveItem overload, either the ListIndex or the ItemText can be used to indicate the item to be removed. If both are specified, the ListIndex is used.

ListIndex

The index of the selected item in the control's list.

Count

The number of items to remove.

ScaleHeight

Scales a control per the specified factor.

Argument Description

Name

The name of the Control.

Factor

Specifies the factor by which to scale the original or current size.

UseOriginalSize

Whether the original or current as the starting size.

ScaleFromPosition

Whether the size should be scaled from the top-left, middle or bottom-right of the shape.

ScaleWidth

Scales a control per the specified factor.

Argument Description

Name

The name of the Control.

Factor

Specifies the factor by which to scale the original or current size.

UseOriginalSize

Whether the original or current as the starting size.

ScaleFromPosition

Whether the size should be scaled from the top-left, middle or bottom-right of the shape.

ScrollBar

Add or modify a ScrollBar control.

Argument Description

Name

The name of the Control.

Text

The text.

Value

The Value to assign to the control. Control values are always numeric.

OnClickProcedure

The name of the procedure to execute when the control is clicked. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnDoubleClickProcedure

The name of the procedure to execute when the control is double-clicked. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnValueChangedProcedure

The name of the procedure to execute when the value of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

LinkedCell

The address of a cell that will be linked to the value of the control.

LargeChange

The large change amount for a scrollbar control.

Max

The maximum value for a scrollbar or spinner control.

Min

The minimum value for a scrollbar or spinner control.

SmallChange

The small change amount for a scrollbar or spinner control.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Control into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column that will define the width of the control. The Width argument can be used instead of EndColumn.

ColumnPoints

The position of the left edge of the Control in points. If used with the Column argument then the two are added together.

Row

The row to put the Control into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the control. The Height argument can be used instead of EndRow.

RowPoints

The position of the top edge of the Control in points. If used with the Row argument then the two are added together.

Width

The width of the Control in points. The EndColumn argument can be used instead of this argument.

Height

The height of the Control in points. The EndRow argument can be used instead of this argument.

LockAspectRatio

Whether the control's aspect ratio is locked.

Locked

Whether the control is locked.

Visible

Whether the control is visible.

PrintControl

Whether to print the control.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for fill background color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

FontBold

Whether font is bold.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontItalic

Wether the font is italicized.

FontName

Select a font.

FontOutlineFont

Whether the font has the outline effect.

FontShadow

Whether the font has the shadow effect.

FontSize

The font size, in points.

FontStrikethrough

Whether the font has the strikethrough effect.

FontSubscript

Whether the font has the subscript effect.

FontSuperscript

Whether the font has the superscript effect.

FontUnderline

Whether the font has the underline effect.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

TextAutoSize

Whether the size of the text box will increase to display all of the text.

TextHorizontalAlignment

The horizontal alignment.

TextLockText

Whether text will be locked when sheet protection is enabled.

TextMarginBottom

The bottom margin of this text box in points.

TextMarginLeft

The left margin of this text box in points.

TextMarginRight

The right margin of this text box in points.

TextMarginTop

The top margin of this text box in points.

TextOrientation

The orientation of the text.

TextVerticalAlignment

The vertical alignment.

Select

Select a control.

Argument Description

Name

The name of the Control.

Replace

Whether to replace the current selection of shapes, or add this shape to the selections.

SendBackward

Send a control backwards.

Argument Description

Name

The name of the Control.

SendToBack

Send a control to the back.

Argument Description

Name

The name of the Control.

Spinner

Add or modify a Spinner control.

Argument Description

Name

The name of the Control.

Text

The text.

Value

The Value to assign to the control. Control values are always numeric.

OnClickProcedure

The name of the procedure to execute when the control is clicked. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnDoubleClickProcedure

The name of the procedure to execute when the control is double-clicked. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

OnValueChangedProcedure

The name of the procedure to execute when the value of the control changes. The worksheet must be protected for OnClick to work. When multiple controls are added by calling the method from within a loop, you can use @EPVal(ControlName) to get the name of the affected control from within the executed procedure.

LinkedCell

The address of a cell that will be linked to the value of the control.

Max

The maximum value for a scrollbar or spinner control.

Min

The minimum value for a scrollbar or spinner control.

SmallChange

The small change amount for a scrollbar or spinner control.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Control into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column that will define the width of the control. The Width argument can be used instead of EndColumn.

ColumnPoints

The position of the left edge of the Control in points. If used with the Column argument then the two are added together.

Row

The row to put the Control into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the control. The Height argument can be used instead of EndRow.

RowPoints

The position of the top edge of the Control in points. If used with the Row argument then the two are added together.

Width

The width of the Control in points. The EndColumn argument can be used instead of this argument.

Height

The height of the Control in points. The EndRow argument can be used instead of this argument.

LockAspectRatio

Whether the control's aspect ratio is locked.

Locked

Whether the control is locked.

Visible

Whether the control is visible.

PrintControl

Whether to print the control.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for fill background color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

FontBold

Whether font is bold.

FontColor

Select the font color.

FontColorIndex

Excel color palette index to use for the font color. The value is zero-based from 0 to 55.

FontItalic

Wether the font is italicized.

FontName

Select a font.

FontOutlineFont

Whether the font has the outline effect.

FontShadow

Whether the font has the shadow effect.

FontSize

The font size, in points.

FontStrikethrough

Whether the font has the strikethrough effect.

FontSubscript

Whether the font has the subscript effect.

FontSuperscript

Whether the font has the superscript effect.

FontUnderline

Whether the font has the underline effect.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

TextAutoSize

Whether the size of the text box will increase to display all of the text.

TextHorizontalAlignment

The horizontal alignment.

TextLockText

Whether text will be locked when sheet protection is enabled.

TextMarginBottom

The bottom margin of this text box in points.

TextMarginLeft

The left margin of this text box in points.

TextMarginRight

The right margin of this text box in points.

TextMarginTop

The top margin of this text box in points.

TextOrientation

The orientation of the text.

TextVerticalAlignment

The vertical alignment.

SetCover

Set the value of the view's Cover property.

Overloads

Overload Name Description

General

Set the value of the view's Cover property.

General

Set the value of the view's Cover property.

Argument Description

Cover

Controls whether the view is covered.

SetCursor

Sets the Cursor as specified.

Overloads

Overload Name Description

General

Set the cursor.

General

Set the cursor.

Argument Description

Cursor

Specifies a cursor.

SetDataTableRangesModificationTracking

Any changes to cell values in existing data rows on the sheet, while modification tracking is disabled (FALSE), will not be detected as unsaved changes when the view is rebuilt or closed.

Since version 8.0

Overloads

Overload Name Description

General

Any changes to cell values in existing data rows on the sheet, while modification tracking is disabled (FALSE), will not be detected as unsaved changes when the view is rebuilt or closed.

General

Any changes to cell values in existing data rows on the sheet, while modification tracking is disabled (FALSE), will not be detected as unsaved changes when the view is rebuilt or closed.

Argument Description

Enabled

If left blank, the value will be TRUE. By default, SQL modification tracking is enabled for SQL and ExcelEssbase views. Any changes to cell values in existing data rows on the sheet, while modification tracking is disabled (FALSE), will not be detected as unsaved changes when the view is rebuilt or closed.

SetDataValidation

Set or clear data validation.

Overloads

Overload Name Description

Clear

Clear data validation.

Custom

The Formula determines whether an entered value is valid.

Date

The entered value must be a date.

Decimal

The entered value must be a decimal number.

InputOnly

Any value is valid.

List

Select a valid value from a list.

TextLength

A valid entry must contain the specified number of characters.

Time

The entered value must be a valid time.

WholeNumber

The entered value must be a whole number.

Clear

Clear data validation.

Argument Description

Custom

The Formula determines whether an entered value is valid.

Argument Description

Operator

The operator to be used for the validation.

Formula

The formula that will be used for custom validation.

IgnoreBlank

Specifies whether validation should be skipped if either validation formula refers to a blank cell.

ShowInputMessage

Specifies whether an input message should be displayed when one of the represented cells is active.

InputMessage

The input message displayed when one of the represented cells is active.

InputTitle

The input title displayed when one of the represented cells is active.

ShowError

Specifies whether errors should be shown when validation fails.

AlertStyle

The alert style used when validation fails.

ErrorMessage

The error message displayed when validation fails.

ErrorTitle

The error title displayed when validation fails.

Date

The entered value must be a date.

Argument Description

Operator

The operator to be used for the validation.

Minimum

The minimum value.

Maximum

The maximum value.

IgnoreBlank

Specifies whether validation should be skipped if either validation formula refers to a blank cell.

ShowInputMessage

Specifies whether an input message should be displayed when one of the represented cells is active.

InputMessage

The input message displayed when one of the represented cells is active.

InputTitle

The input title displayed when one of the represented cells is active.

ShowError

Specifies whether errors should be shown when validation fails.

AlertStyle

The alert style used when validation fails.

ErrorMessage

The error message displayed when validation fails.

ErrorTitle

The error title displayed when validation fails.

Decimal

The entered value must be a decimal number.

Argument Description

Operator

The operator to be used for the validation.

Minimum

The minimum value.

Maximum

The maximum value.

IgnoreBlank

Specifies whether validation should be skipped if either validation formula refers to a blank cell.

ShowInputMessage

Specifies whether an input message should be displayed when one of the represented cells is active.

InputMessage

The input message displayed when one of the represented cells is active.

InputTitle

The input title displayed when one of the represented cells is active.

ShowError

Specifies whether errors should be shown when validation fails.

AlertStyle

The alert style used when validation fails.

ErrorMessage

The error message displayed when validation fails.

ErrorTitle

The error title displayed when validation fails.

InputOnly

Any value is valid.

Argument Description

ShowInputMessage

Specifies whether an input message should be displayed when one of the represented cells is active.

InputMessage

The input message displayed when one of the represented cells is active.

InputTitle

The input title displayed when one of the represented cells is active.

ShowError

Specifies whether errors should be shown when validation fails.

AlertStyle

The alert style used when validation fails.

ErrorMessage

The error message displayed when validation fails.

ErrorTitle

The error title displayed when validation fails.

List

Select a valid value from a list.

Argument Description

Source

The source of the list, which can be a comma-delimited list of values or a sheet range reference. When specifying a comma-delimited list of values, Excel limits the string to 255 characters. When specifying a named range, use the format: ="=NamedRange" (including both equal signs and the double quotes.) When the named range is on a separate sheet, use the format: ="=SheetName!NamedRange"

IgnoreBlank

Specifies whether validation should be skipped if either validation formula refers to a blank cell.

InCellDropdown

Specifies whether an in-cell dropdown listbox should be used for validation with a ValidationType of List.

ShowInputMessage

Specifies whether an input message should be displayed when one of the represented cells is active.

InputMessage

The input message displayed when one of the represented cells is active.

InputTitle

The input title displayed when one of the represented cells is active.

ShowError

Specifies whether errors should be shown when validation fails.

AlertStyle

The alert style used when validation fails.

ErrorMessage

The error message displayed when validation fails.

ErrorTitle

The error title displayed when validation fails.

TextLength

A valid entry must contain the specified number of characters.

Argument Description

Operator

The operator to be used for the validation.

Length

The Length specification.

Minimum

The minimum value.

Maximum

The maximum value.

IgnoreBlank

Specifies whether validation should be skipped if either validation formula refers to a blank cell.

ShowInputMessage

Specifies whether an input message should be displayed when one of the represented cells is active.

InputMessage

The input message displayed when one of the represented cells is active.

InputTitle

The input title displayed when one of the represented cells is active.

ShowError

Specifies whether errors should be shown when validation fails.

AlertStyle

The alert style used when validation fails.

ErrorMessage

The error message displayed when validation fails.

ErrorTitle

The error title displayed when validation fails.

Time

The entered value must be a valid time.

Argument Description

Operator

The operator to be used for the validation.

Minimum

The minimum value.

Maximum

The maximum value.

IgnoreBlank

Specifies whether validation should be skipped if either validation formula refers to a blank cell.

ShowInputMessage

Specifies whether an input message should be displayed when one of the represented cells is active.

InputMessage

The input message displayed when one of the represented cells is active.

InputTitle

The input title displayed when one of the represented cells is active.

ShowError

Specifies whether errors should be shown when validation fails.

AlertStyle

The alert style used when validation fails.

ErrorMessage

The error message displayed when validation fails.

ErrorTitle

The error title displayed when validation fails.

WholeNumber

The entered value must be a whole number.

Argument Description

Operator

The operator to be used for the validation.

Minimum

The minimum value.

Maximum

The maximum value.

IgnoreBlank

Specifies whether validation should be skipped if either validation formula refers to a blank cell.

ShowInputMessage

Specifies whether an input message should be displayed when one of the represented cells is active.

InputMessage

The input message displayed when one of the represented cells is active.

InputTitle

The input title displayed when one of the represented cells is active.

ShowError

Specifies whether errors should be shown when validation fails.

AlertStyle

The alert style used when validation fails.

ErrorMessage

The error message displayed when validation fails.

ErrorTitle

The error title displayed when validation fails.

SetEntry

Enter a value or formula into a specified range in the workbook. Can also be used to clear cells or set the error value.

Overloads

Overload Name Description

Clear

Clear the value of each cell.

Error

Set the error value of each cell.

Formula

Set the formula of each cell.

FormulaArray

Set the formula array of each cell.

Logical

Set the logical value of each cell.

Number

Set the number value of each cell.

Text

Set the text value of each cell.

Clear

Clear the value of each cell.

Argument Description

TargetSpecifySheetBy

Select how to specify for which sheet the TargetAddress applies.

TargetSheetSpec

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

TargetAddress

The address of the cell or range for which the Entry is entered. If TargetAddress is not specified, the Address is used as the target address.

Error

Set the error value of each cell.

Argument Description

TargetSpecifySheetBy

Select how to specify for which sheet the TargetAddress applies.

TargetSheetSpec

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

TargetAddress

The address of the cell or range for which the Entry is entered. If TargetAddress is not specified, the Address is used as the target address.

Error

The error.

Formula

Set the formula of each cell.

Argument Description

TargetSpecifySheetBy

Select how to specify for which sheet the TargetAddress applies.

TargetSheetSpec

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

TargetAddress

The address of the cell or range for which the Entry is entered. If TargetAddress is not specified, the Address is used as the target address.

Entry

The entry.

FormulaArray

Set the formula array of each cell.

Argument Description

TargetSpecifySheetBy

Select how to specify for which sheet the TargetAddress applies.

TargetSheetSpec

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

TargetAddress

The address of the cell or range for which the Entry is entered. If TargetAddress is not specified, the Address is used as the target address.

Entry

The entry.

Logical

Set the logical value of each cell.

Argument Description

TargetSpecifySheetBy

Select how to specify for which sheet the TargetAddress applies.

TargetSheetSpec

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

TargetAddress

The address of the cell or range for which the Entry is entered. If TargetAddress is not specified, the Address is used as the target address.

Entry

The entry.

Number

Set the number value of each cell.

Argument Description

TargetSpecifySheetBy

Select how to specify for which sheet the TargetAddress applies.

TargetSheetSpec

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

TargetAddress

The address of the cell or range for which the Entry is entered. If TargetAddress is not specified, the Address is used as the target address.

Entry

The entry.

Text

Set the text value of each cell.

Argument Description

TargetSpecifySheetBy

Select how to specify for which sheet the TargetAddress applies.

TargetSheetSpec

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

TargetAddress

The address of the cell or range for which the Entry is entered. If TargetAddress is not specified, the Address is used as the target address.

Entry

The entry.

Set the value of an EventLink's Active property to control whether the EventLink's Procedure runs or not.

Overloads

Overload Name Description

General

Set the value of an EventLink's Active property to control whether the EventLink's Procedure runs or not.

Set the value of an EventLink's Active property to control whether the EventLink's Procedure runs or not.

Argument Description

EventLink

The name of the EventLink.

Procedure

The name of the Procedure associated with the EventLink. Leave this argument empty to specify all EventLinks with the specified EventLink name.

Active

The value to assign to the EventLink's Active property to control whether the EventLink's Procedure runs or not.

SetExcelComment

Set, Add-to, or clear Excel comments from cell(s).

Overloads

Overload Name Description

Add

Add an Excel comment to the cell's comments.

Clear

Clear Excel comments from cells.

Set

Set the Excel comments. This replaces any Excel comments in the cell.

Add

Add an Excel comment to the cell's comments.

Argument Description

Comment

The comment.

Author

The author of the comment.

MaxCharactersPerLine

(Optional) The maximum number of characters per comment line, which determines the maximum width of the Excel comment. The default value is 40.

FontStyle

Controls whether the comment is displayed with regular or bold font. The default is regular font.

Clear

Clear Excel comments from cells.

Argument Description

Set

Set the Excel comments. This replaces any Excel comments in the cell.

Argument Description

Comment

The comment.

Author

The author of the comment.

MaxCharactersPerLine

(Optional) The maximum number of characters per comment line, which determines the maximum width of the Excel comment. The default value is 40.

FontStyle

Controls whether the comment is displayed with regular or bold font. The default is regular font.

SetFill

Set the fill colors and patterns of cells.

Overloads

Overload Name Description

Clear

Clears the fill color and pattern.

General

Set cell fill properties.

Gradient

Set cell fill as gradient.

GradientLinear

Set cell fill as gradient/linear with up to 10 colors.

GradientRectangle

Set cell fill as gradient/recangle with up to 10 colors.

Clear

Clears the fill color and pattern.

Argument Description

General

Set cell fill properties.

Argument Description

FillColorRGB

Select a color to use for the fill color. FillColorRGB is used if FillColor and FillColorRGB are both specified.

FillColor

Excel color palette index to use for fill color. The value is zero-based from 0 to 55.

PatternColorRGB

Select a color to use for the pattern color. PatternColorRGB is used if PatternColor and PatternColorRGB are both specified.

PatternColor

Excel color palette index to use for pattern color. The value is zero-based from 0 to 55.

Pattern

Pattern to use for fill.

Gradient

Set cell fill as gradient.

Argument Description

Style

Controls where gradient starts (with Color1) and the direction it fills from.

Color1

The color for Color1. Use Color1 or Color1Index. If both are specified then Color1 is used.

Color1Index

Excel color palette index to use for Color1. The value is zero-based from 0 to 55. Use Color1 or Color1Index. If both are specified then Color1 is used.

Color2

The color for Color2. Use Color2 or Color2Index. If both are specified then Color2 is used.

Color2Index

Excel color palette index to use for Color2. The value is zero-based from 0 to 55. Use Color2 or Color2Index. If both are specified then Color2 is used.

GradientLinear

Set cell fill as gradient/linear with up to 10 colors.

Argument Description

DirectionLinear

Controls where gradient starts (with Color1) and the direction it fills from. If Angle is also specified, Angle will override the value of DirectionLinear.

Angle

Controls where gradient starts (with Color1) and the direction it fills from. If DirectionLinear is also specified, Angle will override the value of DirectionLinear.

Color1

The color for Color1. Use Color1 or Color1Index. If both are specified then Color1 is used.

Color1Index

Excel color palette index to use for Color1. The value is zero-based from 0 to 55. Use Color1 or Color1Index. If both are specified then Color1 is used.

Color1Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color2

The color for Color2. Use Color2 or Color2Index. If both are specified then Color2 is used.

Color2Index

Excel color palette index to use for Color2. The value is zero-based from 0 to 55. Use Color2 or Color2Index. If both are specified then Color2 is used.

Color2Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color3

The color for Color3. Use Color3 or Color3Index. If both are specified then Color3 is used.

Color3Index

Excel color palette index to use for Color3. The value is zero-based from 0 to 55. Use Color3 or Color3Index. If both are specified then Color3 is used.

Color3Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color4

The color for Color4. Use Color4 or Color4Index. If both are specified then Color4 is used.

Color4Index

Excel color palette index to use for Color4. The value is zero-based from 0 to 55. Use Color4 or Color4Index. If both are specified then Color4 is used.

Color4Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color5

The color for Color5. Use Color5 or Color5Index. If both are specified then Color5 is used.

Color5Index

Excel color palette index to use for Color5. The value is zero-based from 0 to 55. Use Color5 or Color5Index. If both are specified then Color5 is used.

Color5Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color6

The color for Color6. Use Color6 or Color6Index. If both are specified then Color6 is used.

Color6Index

Excel color palette index to use for Color6. The value is zero-based from 0 to 55. Use Color6 or Color6Index. If both are specified then Color6 is used.

Color6Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color7

The color for Color7. Use Color7 or Color7Index. If both are specified then Color7 is used.

Color7Index

Excel color palette index to use for Color7. The value is zero-based from 0 to 55. Use Color7 or Color7Index. If both are specified then Color7 is used.

Color7Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color8

The color for Color8. Use Color8 or Color8Index. If both are specified then Color8 is used.

Color8Index

Excel color palette index to use for Color8. The value is zero-based from 0 to 55. Use Color8 or Color8Index. If both are specified then Color8 is used.

Color8Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color9

The color for Color9. Use Color9 or Color9Index. If both are specified then Color9 is used.

Color9Index

Excel color palette index to use for Color9. The value is zero-based from 0 to 55. Use Color9 or Color9Index. If both are specified then Color9 is used.

Color9Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color10

The color for Color10. Use Color10 or Color10Index. If both are specified then Color10 is used.

Color10Index

Excel color palette index to use for position 10. The value is zero-based from 0 to 55. Use Color10 or Color10Index. If both are specified then Color10 is used.

Color10Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

GradientRectangle

Set cell fill as gradient/recangle with up to 10 colors.

Argument Description

DirectionRectangle

Controls where gradient starts (with Color1) and the direction it fills from.

Color1

The color for Color1. Use Color1 or Color1Index. If both are specified then Color1 is used.

Color1Index

Excel color palette index to use for Color1. The value is zero-based from 0 to 55. Use Color1 or Color1Index. If both are specified then Color1 is used.

Color1Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color2

The color for Color2. Use Color2 or Color2Index. If both are specified then Color2 is used.

Color2Index

Excel color palette index to use for Color2. The value is zero-based from 0 to 55. Use Color2 or Color2Index. If both are specified then Color2 is used.

Color2Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color3

The color for Color3. Use Color3 or Color3Index. If both are specified then Color3 is used.

Color3Index

Excel color palette index to use for Color3. The value is zero-based from 0 to 55. Use Color3 or Color3Index. If both are specified then Color3 is used.

Color3Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color4

The color for Color4. Use Color4 or Color4Index. If both are specified then Color4 is used.

Color4Index

Excel color palette index to use for Color4. The value is zero-based from 0 to 55. Use Color4 or Color4Index. If both are specified then Color4 is used.

Color4Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color5

The color for Color5. Use Color5 or Color5Index. If both are specified then Color5 is used.

Color5Index

Excel color palette index to use for Color5. The value is zero-based from 0 to 55. Use Color5 or Color5Index. If both are specified then Color5 is used.

Color5Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color6

The color for Color6. Use Color6 or Color6Index. If both are specified then Color6 is used.

Color6Index

Excel color palette index to use for Color6. The value is zero-based from 0 to 55. Use Color6 or Color6Index. If both are specified then Color6 is used.

Color6Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color7

The color for Color7. Use Color7 or Color7Index. If both are specified then Color7 is used.

Color7Index

Excel color palette index to use for Color7. The value is zero-based from 0 to 55. Use Color7 or Color7Index. If both are specified then Color7 is used.

Color7Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color8

The color for Color8. Use Color8 or Color8Index. If both are specified then Color8 is used.

Color8Index

Excel color palette index to use for Color8. The value is zero-based from 0 to 55. Use Color8 or Color8Index. If both are specified then Color8 is used.

Color8Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color9

The color for Color9. Use Color9 or Color9Index. If both are specified then Color9 is used.

Color9Index

Excel color palette index to use for Color9. The value is zero-based from 0 to 55. Use Color9 or Color9Index. If both are specified then Color9 is used.

Color9Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

Color10

The color for Color10. Use Color10 or Color10Index. If both are specified then Color10 is used.

Color10Index

Excel color palette index to use for position 10. The value is zero-based from 0 to 55. Use Color10 or Color10Index. If both are specified then Color10 is used.

Color10Position

The point within the cell that the color is going to start at, (0-100). The cell is divided into 100 points in whatever direction the gradient is being applied in. Color1Position should be less than Color2Position; Color2Position should be less than Color3Position; etc. If left blank, the position will be automatically calculated for even distribution.

SetFocus

Set the focus as specified.

Since version 8.3

Overloads

Overload Name Description

Grid

Set the focus to the view's grid.

Selector

Set the focus to the specified selector.

Grid

Set the focus to the view's grid.

Argument Description

Selector

Set the focus to the specified selector.

Argument Description

SelectorID

The ID of the selector to set the focus to.

SetFont

Set the font properties (font-name, color, size, etc.) of cells.

Overloads

Overload Name Description

General

Set cell font properties.

General

Set cell font properties.

Argument Description

Font

Font to apply.

Style

Regular, Italic, Bold, or BoldItalic.

Size

Font size to apply.

Underline

None, Single, Double, SingleAccounting, DoubleAccounting.

Color

Excel color palette index to use for Font color. The value is zero-based from 0 to 55.

ColorValue

Select a specific color using the color selector.

StrikeThrough

Whether to apply Font strikethrough format.

Superscript

NOT SUPPORTED?: Whether to apply Font superscript format.

Subscript

NOT SUPPORTED?: Whether to apply Font subscript format.

SetFormulaBar

Sets whether the formula bar is visible.

Overloads

Overload Name Description

General

Set whether the formula bar is visible.

General

Set whether the formula bar is visible.

Argument Description

Visible

Controls whether the formula bar is visible.

SetHidden

Set the Hidden property of rows, columns, or sheets to true or false.

Overloads

Overload Name Description

Columns

Set Hidden of the specified column(s) to True or False.

OfWorksheet

Set Hidden of the specified worksheet to True or False. Argument formulas are evaluated per the Address argument.

Rows

Set Hidden of the specified row(s) to True or False.

ToggleColumns

Set Hidden of the specified column(s) to the opposite of the current setting.

ToggleRows

Set Hidden of the specified row(s) to the opposite of the current setting.

ToggleWorksheet

Set Hidden of the specified worksheet to the opposite of the current setting. Argument formulas are evaluated per the Row and Column of the active cell at the time of execution.

Worksheet

Set Hidden of the specified worksheet to True or False. Argument formulas are evaluated per the Row and Column of the active cell at the time of execution.

Columns

Set Hidden of the specified column(s) to True or False.

Argument Description

Hidden

True to hide. False to show.

OfWorksheet

Set Hidden of the specified worksheet to True or False. Argument formulas are evaluated per the Address argument.

Argument Description

Hidden

True to hide. False to show.

Rows

Set Hidden of the specified row(s) to True or False.

Argument Description

Hidden

True to hide. False to show.

ToggleColumns

Set Hidden of the specified column(s) to the opposite of the current setting.

Argument Description

ToggleRows

Set Hidden of the specified row(s) to the opposite of the current setting.

Argument Description

ToggleWorksheet

Set Hidden of the specified worksheet to the opposite of the current setting. Argument formulas are evaluated per the Row and Column of the active cell at the time of execution.

Argument Description

Worksheet

Set Hidden of the specified worksheet to True or False. Argument formulas are evaluated per the Row and Column of the active cell at the time of execution.

Argument Description

Hidden

True to hide. False to show.

Create or clear hyperlinks in cells (web, e-mail, file, or address in the workbook).

Overloads

Overload Name Description

Clear

Clear hyperlinks from cells.

Custom

Add a hyperlink that can be used in conjunction with the FollowCustomHyperlink event link to execute a procedure when the hyperlink is clicked.

E-Mail

Add e-mail hyperlinks to cells.

ExistingFile

Add hyperlinks to view existing (available) files.

ThisWorkbook

Add hyperlinks to go to locations in this workbook.

WebAddress

Add URL hyperlinks to cells.

Clear hyperlinks from cells.

Argument Description

Add a hyperlink that can be used in conjunction with the FollowCustomHyperlink event link to execute a procedure when the hyperlink is clicked.

Argument Description

DisplayText

The text to display for the hyperlink. If no DisplayText is specified, the cell text is used.

ScreenTip

The screen-tip to display for the hyperlink.

Add e-mail hyperlinks to cells.

Argument Description

E-MailAddress

E-mail address(es) of the hyperlink. If multiple addresses are specified, the addresses must be delimited with a semicolon.

CopyTo

E-mail address(es) to receive a copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

BlindCopyTo

E-mail address(es)s to receive a blind copy. If multiple addresses are specified, the addresses must be delimited with a semicolon.

Subject

The subject for the e-mail message.

Body

The body of the e-mail message.

DisplayText

The text to display for the hyperlink. If no DisplayText is specified, the cell text is used.

ScreenTip

The screen-tip to display for the hyperlink.

Add hyperlinks to view existing (available) files.

Argument Description

Filename

The filename to link to.

Bookmark

A specific location in the link file.

DisplayText

The text to display for the hyperlink. If no DisplayText is specified, the cell text is used.

ScreenTip

The screen-tip to display for the hyperlink.

Add hyperlinks to go to locations in this workbook.

Argument Description

LinkToAddress

The cell address to jump to.

DisplayText

The text to display for the hyperlink. If no DisplayText is specified, the cell text is used.

ScreenTip

The screen-tip to display for the hyperlink.

Add URL hyperlinks to cells.

Argument Description

WebAddress

The web address of the hyperlink.

DisplayText

The text to display for the hyperlink. If no DisplayText is specified, the cell text is used.

ScreenTip

The screen-tip to display for the hyperlink.

SetImage

Adds the specified Image with the specifed name and sets the specified properties. If the image/name already exists then the properties are modified.

Overloads

Overload Name Description

BringForward

Bring a shape forward.

BringToFront

Bring a shape to front.

FlipHorizontal

Flip a shape horizontally.

FlipVertical

Flip a shape vertically.

General

Add or modify an image.

IncrementLeft

Increment the left position of a shape.

IncrementTop

Increment the top position of a shape.

Remove

Remove a shape.

ScaleHeight

Scales a shape per the specified factor.

ScaleWidth

Scales a shape per the specified factor.

Select

Select a shape.

SendBackward

Send a shape backwards.

SendToBack

Send a shape to the back.

BringForward

Bring a shape forward.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

BringToFront

Bring a shape to front.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

FlipHorizontal

Flip a shape horizontally.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

FlipVertical

Flip a shape vertically.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

General

Add or modify an image.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

BinaryArtifactID

The ID of the Image BinaryArtifact.

OnClickProcedure

The name of the procedure to execute when the image is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the image is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

Column

The column to put the Image into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the shape. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Image in points. If used with the Column argument then the two are added together.

Row

The row to put the Image into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the shape. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Image in points. If used with the Row argument then the two are added together.

Width

The width of the Image in points. The EndColumn argument can be used instead of this.

Height

The height of the Image in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the shape's aspect ratio is locked.

Locked

Whether the shape is locked.

Visible

Whether the shape is visible.

PrintImage

Whether to print the shape.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for the fill back color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

IncrementLeft

Increment the left position of a shape.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

Increment

Specifies the increment in points.

IncrementTop

Increment the top position of a shape.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

Increment

Specifies the increment in points.

Remove

Remove a shape.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

ScaleHeight

Scales a shape per the specified factor.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

Factor

Specifies the factor by which to scale the original or current size.

UseOriginalSize

Whether the original or current as the starting size.

ScaleFromPosition

Whether the size should be scaled from the top-left, middle or bottom-right of the shape.

ScaleWidth

Scales a shape per the specified factor.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

Factor

Specifies the factor by which to scale the original or current size.

UseOriginalSize

Whether the original or current as the starting size.

ScaleFromPosition

Whether the size should be scaled from the top-left, middle or bottom-right of the shape.

Select

Select a shape.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

Replace

Whether to replace the current selection of shapes, or add this shape to the selections.

SendBackward

Send a shape backwards.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

SendToBack

Send a shape to the back.

Argument Description

Name

The name assigned to the Image. This can be used to identify the shape after it is created.

SetLine

Creates the specified Line if it doesn't exist, and sets the specified properties of it.

Overloads

Overload Name Description

BringForward

Bring a line forward.

BringToFront

Bring a line to front.

FlipHorizontal

Flip a line horizontally.

FlipVertical

Flip a line vertically.

General

Add or modify a line.

IncrementLeft

Increment the left position of a line.

IncrementTop

Increment the top position of a line.

Remove

Remove a line.

ScaleHeight

Scales a line per the specified factor.

ScaleWidth

Scales a line per the specified factor.

Select

Select a line.

SendBackward

Send a line backwards.

SendToBack

Send a line to the back.

BringForward

Bring a line forward.

Argument Description

Name

The name of the Line.

BringToFront

Bring a line to front.

Argument Description

Name

The name of the Line.

FlipHorizontal

Flip a line horizontally.

Argument Description

Name

The name of the Line.

FlipVertical

Flip a line vertically.

Argument Description

Name

The name of the Line.

General

Add or modify a line.

Argument Description

Name

The name of the Line.

OnClickProcedure

The name of the procedure to execute when the line is clicked.

OnDoubleClickProcedure

The name of the procedure to execute when the line is double-clicked.

Placement

The placement behavior of the chart. FreeFloating: Do not move with cells. Move: Do not move with cells. MoveAndSize: Move and size with cells.

StartHorizontalColumn

The horizontal starting point of the line specified as a column number. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the StartHorizontalPoints argument then the two are added together to determine the line's starting point.

StartHorizontalPoints

The horizontal starting point of the line specified in points. If used with the StartHorizontalColumn argument then the two are added together to determine the line's starting point.

StartVerticalRow

The vertical starting point of the line specified as a row number. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the StartVerticalPoints argument then the two are added together to determine the line's starting point.

StartVerticalPoints

The vertical starting point of the line specified in points. If used with the StartVerticalRow argument then the two are added together to determine the line's starting point.

EndHorizontalColumn

The horizontal ending point of the line specified as a column number. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the EndHorizontalPoints argument then the two are added together to determine the line's ending point.

EndHorizontalPoints

The horizontal ending point of the line specified in points. If used with the EndHorizontalColumn argument then the two are added together to determine the line's ending point.

EndVerticalRow

The vertical ending point of the line specified as a row number. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the EndVerticalPoints argument then the two are added together to determine the line's ending point.

EndVerticalPoints

The vertical ending point of the line specified in points. If used with the EndVerticalRow argument then the two are added together to determine the line's ending point.

LockAspectRatio

Whether the text box's aspect ratio is locked.

Locked

Whether the text box is locked.

Visible

Whether the text box is visible.

PrintLine

Whether to print the text box.

Color

Select the color for the line.

ColorIndex

Excel color palette index to use for the line. The value is zero-based from 0 to 55.

Transparency

From 0.0 to 1.0 (opaque to transparent).

Weight

The weight of the line, in points.

IncrementLeft

Increment the left position of a line.

Argument Description

Name

The name of the Line.

Increment

Specifies the increment in points.

IncrementTop

Increment the top position of a line.

Argument Description

Name

The name of the Line.

Increment

Specifies the increment in points.

Remove

Remove a line.

Argument Description

Name

The name of the Line.

ScaleHeight

Scales a line per the specified factor.

Argument Description

Name

The name of the Line.

Factor

Specifies the factor by which to scale the original or current size.

UseOriginalSize

Whether the original or current as the starting size.

ScaleFromPosition

Whether the size should be scaled from the top-left, middle or bottom-right of the shape.

ScaleWidth

Scales a line per the specified factor.

Argument Description

Name

The name of the Line.

Factor

Specifies the factor by which to scale the original or current size.

UseOriginalSize

Whether the original or current as the starting size.

ScaleFromPosition

Whether the size should be scaled from the top-left, middle or bottom-right of the shape.

Select

Select a line.

Argument Description

Name

The name of the Line.

Replace

Whether to replace the current selection of shapes, or add this shape to the selections.

SendBackward

Send a line backwards.

Argument Description

Name

The name of the Line.

SendToBack

Send a line to the back.

Argument Description

Name

The name of the Line.

SetNumberFormat

Set the number format of specific cells.

Overloads

Overload Name Description

All

Select a number format from a list of all predefined formats.

Currency

Select a number format from a list of currency formats.

Date

Select a number format from a list of date formats.

Fraction

Select a number format from a list of fraction formats.

General

Use the General number format.

Number

Select a number format from a list of numeric formats.

Percentage

Select a number format from a list of percentage formats.

Scientific

Select a number format from a list of scientific notation formats.

Specify

Enter a custom number format.

Time

Select a number format from a list of time formats.

All

Select a number format from a list of all predefined formats.

Argument Description

AllFormats

Format string for a numerical value.

Currency

Select a number format from a list of currency formats.

Argument Description

CurrencyFormats

Select number format from a list of currency formats.

Date

Select a number format from a list of date formats.

Argument Description

DateFormats

Select number format from a list of date formats.

Fraction

Select a number format from a list of fraction formats.

Argument Description

FractionFormats

Select number format from a list of fraction formats.

General

Use the General number format.

Argument Description

Number

Select a number format from a list of numeric formats.

Argument Description

NumberFormats

Select number format from a list of format strings for numbers.

Percentage

Select a number format from a list of percentage formats.

Argument Description

PercentageFormats

Select number format from a list of percentage formats.

Scientific

Select a number format from a list of scientific notation formats.

Argument Description

ScientificFormats

Select number format from a list of scientific notation formats.

Specify

Enter a custom number format.

Argument Description

Format

Format string for a numerical value.

Time

Select a number format from a list of time formats.

Argument Description

TimeFormats

Select number format from a list of time formats.

SetOutlineLevel

Set outline/grouping level.

Overloads

Overload Name Description

Clear

Clear the outline/grouping level.

ClearAll

Clear all outline/grouping.

Group

Increment the outline/grouping level.

Set

Set the outline/grouping level.

ShowDetail

Show/expand or hide/collapse the detail corresponding to the outline level of a row or column.

ShowLevels

Shows rows and/or columns with an outline level that is less than or equal to the specified level.

Ungroup

Decrement the outline/grouping level.

Clear

Clear the outline/grouping level.

Argument Description

RowOrCol

Whether to set row or column outline levels.

ClearAll

Clear all outline/grouping.

Argument Description

Group

Increment the outline/grouping level.

Argument Description

RowOrCol

Whether to set row or column outline levels.

Set

Set the outline/grouping level.

Argument Description

Level

The level to set for the range.

RowOrCol

Whether to set row or column outline levels.

ShowDetail

Show/expand or hide/collapse the detail corresponding to the outline level of a row or column.

Argument Description

RowOrCol

Whether to set row or column outline levels.

ShowDetail

Controls whether the detail corresponding to the outline level of a row or column will be shown (expanded) or hidden (collapsed). The RowOrCol argument indicates whether the outline level is related to a row or column group, and the Address argument specifies a row or column address or the address of a cell within the row or column. The operation is only valid for a single row or column.

ShowLevels

Shows rows and/or columns with an outline level that is less than or equal to the specified level.

Argument Description

RowLevels

All rows whose outline level is less than or equal to the specified level will be shown. A RowLevels value of 0, which is the default, leaves the rows unchanged. To collapse all row levels, specify 1.

ColumnLevels

All columns whose outline level is less than or equal to the specified level will be shown. A ColumnLevels value of 0, which is the default, leaves the columns unchanged. To collapse all column levels, specify 1.

Ungroup

Decrement the outline/grouping level.

Argument Description

RowOrCol

Whether to set row or column outline levels.

SetPageBreak

Set page breaks to automatic, or add/clear print page breaks.

Overloads

Overload Name Description

General

Set page break setting.

General

Set page break setting.

Argument Description

BreakSetting

The page-break setting.

Orientation

The orientation of the page-break.

SetPageSetup

Set the page setup options of one or all worksheets.

Overloads

Overload Name Description

Center

Specify whether/how to center the grid on the page.

Fit

Specify how to fit grid onto the printed page. Use either ZoomPercent or the FitTo properties.

General

General print settings.

HeadersAndFooters

Specify headers and footers.

Margins

Set print margins.

Titles

Specify areas on the worksheet to use as titles.

Center

Specify whether/how to center the grid on the page.

Argument Description

CenterHorizontally

Whether to center the print area horizontally on the page.

CenterVertically

Whether to center the print area vertically on the page.

Fit

Specify how to fit grid onto the printed page. Use either ZoomPercent or the FitTo properties.

Argument Description

ZoomPercent

The Print zoom factor.

FitToPagesWide

Specify a number of pages wide to fit the print range into.

FitToPagesTall

Specify a number of pages tall to fit the print range into.

General

General print settings.

Argument Description

PrintArea

The address of the print area range.

Orientation

Whether to print in Landscape or Portrait mode.

FirstPageNumber

The page number to start with.

PrintGridLines

Whether to print grid lines.

PrintRowColumnHeaders

Whether to print row and column headers.

BlackAndWhite

Whether to print in black and white.

PrintComments

Select where to print comments.

PageOrder

Select how order the pages.

HeadersAndFooters

Specify headers and footers.

Argument Description

LeftHeader

Text for the left header area.

CenterHeader

Text for the center header area.

RightHeader

Text for the right header area.

LeftFooter

Text for the left footer area.

CenterFooter

Text for the center footer area.

RightFooter

Text for the right footer area.

Margins

Set print margins.

Argument Description

TopMargin

The top margin of the page.

BottomMargin

The bottom margin of the page.

LeftMargin

The left margin of the page.

RightMargin

The right margin of the page.

HeaderMargin

The header margin.

FooterMargin

The footer margin.

Titles

Specify areas on the worksheet to use as titles.

Argument Description

TitleRows

Row range specification for row titles.

TitleColumns

Column range specification for column titles.

SetProgressText

Set the progress text displayed at the bottom of the view.

Overloads

Overload Name Description

Clear

Clear the progress text displayed at the bottom of the view.

Set

Set the progress text displayed at the bottom of the view.

Clear

Clear the progress text displayed at the bottom of the view.

Argument Description

Set

Set the progress text displayed at the bottom of the view.

Argument Description

Text

The progress text to display.

SetProtection

Set the protection properties of the workbook, worksheet, or specific cells.

Overloads

Overload Name Description

Cells

Set protection parameters of specified cells.

Sheets

Set protection parameters of specified sheets.

Workbook

Set protection parameters of the workbook.

Cells

Set protection parameters of specified cells.

Argument Description

Locked

Whether the specified cell(s) are locked.

FormulasHidden

Whether the specified cell(s)' formulas are hidden.

Sheets

Set protection parameters of specified sheets.

Argument Description

Protected

For the Worksheet overload, enables or disables protection for the worksheet. For the Workbook overload, controls whether the specified Password is required to open and/or unprotect the workbook.

SheetVisibility

Whether the specified sheet(s) are Visible, Hidden, or VeryHidden.

Password

For the Worksheet overload, the password to set for the sheet. For the Workbook overload, the password which will be required to unprotect the workbook structure. (The password is not required to open the workbook.)

Workbook

Set protection parameters of the workbook.

Argument Description

StructureProtected

Whether the structure (number and order of worksheets) of the workbook is protected from changes. When the structure is protected, a user cannot add, delete, or rename worksheets or display hidden worksheets. When the StructureProtected is True and a Password is specified, the user is not able to unprotect the workbook.

Password

For the Worksheet overload, the password to set for the sheet. For the Workbook overload, the password which will be required to unprotect the workbook structure. (The password is not required to open the workbook.)

RecommendReadOnly

Whether to turn on RecommendReadOnly.

SetRowHeight

Set row heights.

Overloads

Overload Name Description

AutoFit

AutoFit the height of a row or a range of rows with Min/Max option.

Hide

Hide a row or a range of rows.

SetHeight

Set the height of a row or a range of rows to a specific value.

Unhide

Unhide a row or a range of rows.

AutoFit

AutoFit the height of a row or a range of rows with Min/Max option.

Argument Description

MinHeight

The minimum row height to set using auto-fit.

MaxHeight

The maximum row height to set using auto-fit.

Hide

Hide a row or a range of rows.

Argument Description

SetHeight

Set the height of a row or a range of rows to a specific value.

Argument Description

Height

The row height.

MinHeight

The minimum row height to set using auto-fit.

MaxHeight

The maximum row height to set using auto-fit.

Unhide

Unhide a row or a range of rows.

Argument Description

SetSelector

Sets the selected value(s) of the specified Selector.

Overloads

Overload Name Description

Clear

Clear the selected value(s) of a specified selector.

General

Set the selected value(s) of a specified selector.

Clear

Clear the selected value(s) of a specified selector.

Argument Description

SelectorID

The ID of the Selector.

ResetControl

For the selector treeview, controls whether the expansion of the nodes is restored to the initial state when the selection is cleared or before the selection is set. By default, the treeview is not reset.

General

Set the selected value(s) of a specified selector.

Argument Description

SelectorID

The ID of the Selector.

Required

Whether a selection is required for the view to be built.

Value

The new value(s) of the selector. If the selector is configured for multiselect then multiple values can be strung together with the specified delimiter.

ValueDelimiter

The delimiter to use to separate multiple values.

Enabled

Whether the selector is enabled.

Visible

Whether the selector is visible.

ResetControl

For the selector treeview, controls whether the expansion of the nodes is restored to the initial state when the selection is cleared or before the selection is set. By default, the treeview is not reset.

BringSelectionIntoView

For the selector treeview and listbox, controls whether the selected item (or first selected item) is within the viewable area of the control.

SetSelectorConfiguration

Adds, modifies, or removes a selector configuration before the view is displayed. This method should be called from either the AfterConstruct or BeforeInitializeUI event link.

Overloads

Overload Name Description

Add

Adds or modifies a Generic, SQL, or Date selector configuration.

Remove

Removes an existing selector configuration.

Add

Adds or modifies a Generic, SQL, or Date selector configuration.

Argument Description

SelectorID

(Required) The ID of the Selector to be added to, modified, or removed from the view's selector configuration.

Required

Controls whether a selection is required. If required, the view is not buildable until the selector has a selection. By default, the argument value is TRUE.

SelectionPolicy

Controls whether the user is allowed to select multiple items or only a single item. By default, the argument value is SingleItem.

Caption

(Optional) A caption that overrides the default caption defined for the selector.

SelectorListID

(Optional) The ID of the Selector List assigned to the selector. If no selector list ID is specified, the selector's default selector list is used.

LastUsedItemContext

Controls the caching of the item(s) selected when the view is built or refreshed. The cache is used to determine the default selected item(s) for a selector with selector list configured with a DefaultSelectionPolicy of LastUsedItem. By default, the argument is Default.

Default - Uses the view's SelectorLastUsedItemContext setting. None - The last used item(s) are not cached. BySelector - The cache is shared by all views configured with the BySelector context. ByView - The cache is used only by the view for which the selector is configured. ByLabel - The cache is shared by all views configured with the ByLabel context and assigned the same LastUsedItemContextLabel.

LastUsedItemContextLabel

The context label used when the LastUsedItemContext argument is ByLabel.

ToolbarKey

(Optional) Specifies the key of the toolbar to which the selector is added. By default, the selector is added to the toolbar assigned the key "View", which is typically the view's main toolbar.

Remove

Removes an existing selector configuration.

Argument Description

SelectorID

(Required) The ID of the Selector to be added to, modified, or removed from the view's selector configuration.

SetShape

Sets the specified properties of a Shape. The Shape is created if it doesn't exist.

Overloads

Overload Name Description

BringForward

Bring a shape forward.

BringToFront

Bring a shape to front.

FlipHorizontal

Flip a shape horizontally.

FlipVertical

Flip a shape vertically.

General

Add or modify a shape.

IncrementLeft

Increment the left position of a shape.

IncrementTop

Increment the top position of a shape.

Remove

Remove a shape.

ScaleHeight

Scales a shape per the specified factor.

ScaleWidth

Scales a shape per the specified factor.

Select

Select a shape.

SendBackward

Send a shape backwards.

SendToBack

Send a shape to the back.

BringForward

Bring a shape forward.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

BringToFront

Bring a shape to front.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

FlipHorizontal

Flip a shape horizontally.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

FlipVertical

Flip a shape vertically.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

General

Add or modify a shape.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

Shape_ActionButtons

Select a shape.

Shape_Callouts

Select a shape.

Shape_BasicShapes

Select a shape.

Shape_BlockArrows

Select a shape.

Shape_FlowchartShapes

Select a shape.

Shape_StarsAndBanners

Select a shape.

OnClickProcedure

The name of the procedure to execute when the shape is clicked. The worksheet must be protected for OnClick to work.

OnDoubleClickProcedure

The name of the procedure to execute when the shape is double-clicked. The worksheet must be protected for OnClick to work.

Placement

The placement behavior of the shape.

Column

The column to put the Shape into. 0.0 is the left edge of the first column. 0.5 is the middle of the first column, etc. If used with the ColumnPoints argument then the two are added together.

EndColumn

The column the will define the width of the shape. The Width argument can be used instead of this.

ColumnPoints

The position of the left edge of the Shape in points. If used with the Column argument then the two are added together.

Row

The row to put the Shape into. 0.0 is the top edge of the first row. 0.5 is the middle of the first row, etc. If used with the RowPoints argument then the two are added together.

EndRow

The row the will define the height of the shape. The Height argument can be used instead of this.

RowPoints

The position of the top edge of the Shape in points. If used with the Row argument then the two are added together.

Width

The width of the Shape in points. The EndColumn argument can be used instead of this.

Height

The height of the Shape in points. The EndRow argument can be used instead of this.

LockAspectRatio

Whether the shape's aspect ratio is locked.

Locked

Whether the shape is locked.

Visible

Whether the shape is visible.

PrintShape

Whether to print the shape.

FillBackColor

Select the fill back color.

FillBackColorIndex

Excel color palette index to use for the fill back color. The value is zero-based from 0 to 55.

FillForeColor

Select the fill forecolor.

FillForeColorIndex

Excel color palette index to use for the fill forecolor. The value is zero-based from 0 to 55.

FillTransparency

From 0.0 to 1.0 (opaque to transparent).

FillVisible

Whether the fill is visible.

BorderColor

Select the color for the line forecolor.

BorderColorIndex

Excel color palette index to use for the line forecolor. The value is zero-based from 0 to 55.

BorderTransparency

From 0.0 to 1.0 (opaque to transparent).

BorderVisible

Whether the line is visible.

BorderWeight

The weight of the line, in points.

IncrementLeft

Increment the left position of a shape.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

Increment

Specifies the increment in points.

IncrementTop

Increment the top position of a shape.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

Increment

Specifies the increment in points.

Remove

Remove a shape.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

ScaleHeight

Scales a shape per the specified factor.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

Factor

Specifies the factor by which to scale the original or current size.

UseOriginalSize

Whether the original or current as the starting size.

ScaleFromPosition

Whether the size should be scaled from the top-left, middle or bottom-right of the shape.

ScaleWidth

Scales a shape per the specified factor.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

Factor

Specifies the factor by which to scale the original or current size.

UseOriginalSize

Whether the original or current as the starting size.

ScaleFromPosition

Whether the size should be scaled from the top-left, middle or bottom-right of the shape.

Select

Select a shape.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.

Replace

Whether to replace the current selection of shapes, or add this shape to the selections.

SendBackward

Send a shape backwards.

Argument Description

Name

The name assigned to the Shape. This can be used to identify the shape after it is created.