AddProperty

Add a property to the workbook script.

Overloads

Overload Name Description
Boolean Add a boolean property to the workbook script.
Double Add a double property to the workbook script.
Integer Add a integer property to the workbook script.
SpecifyDataType Add a property of specified data-type to the workbook script.
String Add a string property to the workbook script.


Boolean

Add a boolean property to the workbook script.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE

Double

Add a double property to the workbook script.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE

Integer

Add a integer property to the workbook script.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE

SpecifyDataType

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

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
PropertyName The name of the new property.
DataType The data-type of the new property.
Specify one of the following values or an arbitrary value: <blank>boolbytecharcolordatedecimaldoublefloatfontintegerlongshortstring
Value The value of the new property.
AppendToValue For a string property, controls whether to append the Value to the existing property value.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
Shared Whether to carry the property forward when opening one view from another.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE

String

Add a string property to the workbook script.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
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.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE