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.


Examples

Zebra Striping

This example shows a few things.
One, it shows that foo.

A B C
1 First Second Third
2 This Is A
3 Before Table Test
Procedure  
  Method Overload ErrorHandlingMode  
    Argument Value Comment
OnAfterBuild  
  SetColor General    
    ColorSelect Color [WhiteSmoke]  
    Index 2  
  SetFill General    
    Address Transactions  
    CellByCell True  
    CellCondition =MOD(@CRow(), 2) = 0  
    FillColor 2  
A B C
1 First Second Third
2 This Is An
3 After Table Test

CascadeSummary

Sets the values of Product.Level and Market.Level in each sheet.

Procedure  
  Method Overload ErrorHandlingMode  
    Argument Value Comment
AddLevels  
  SetEntry Number    
    SpecifySheetBy AllSheets  
    SheetSpec  
    Address Product.Level  
    CellByCell FALSE  
    ReverseOrder FALSE  
    MethodCondition TRUE  
    CellCondition =And(@DefinedNameExists(Market.Level),Not(@ValueLogical(IsSummarySheet)))  
    Entry @MbrLevel(@ValueText(Token.Product))  
  SetEntry Number    
    SpecifySheetBy AllSheets  
    SheetSpec  
    Address Market.Level  
    CellByCell FALSE  
    ReverseOrder FALSE  
    MethodCondition TRUE  
    CellCondition =And(@DefinedNameExists(Market.Level),Not(@ValueLogical(IsSummarySheet)))  
    Entry @MbrLevel(@ValueText(Token.Market))  

Application

Add an application token to the Dodeca application.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
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
TokenName The name of the new token.
Value The value of the new token.
SyncTokens (8.1) Whether to sync the token table after adding the token. If not specified TRUE will be used.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE

Examples

Zebra Striping

This example shows a few things.
One, it shows that foo.

A B C
1 First Second Third
2 This Is A
3 Before Table Test
Procedure  
  Method Overload ErrorHandlingMode  
    Argument Value Comment
OnAfterBuild  
  SetColor General    
    ColorSelect Color [WhiteSmoke]  
    Index 2  
  SetFill General    
    Address Transactions  
    CellByCell True  
    CellCondition =MOD(@CRow(), 2) = 0  
    FillColor 2  
A B C
1 First Second Third
2 This Is An
3 After Table Test

General

Add a temporary token to the Dodeca view.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
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
TokenName The name of the new token.
Value The value of the new token.

TargetView

Add a view token to the target view.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
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
TokenName The name of the new token.
Value The value of the new token.
SyncTokens (8.1) Whether to sync the token table after adding the token. If not specified TRUE will be used.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE

View

Add a view token to the Dodeca view.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
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
TokenName The name of the new token.
Value The value of the new token.
SyncTokens (8.1) Whether to sync the token table after adding the token. If not specified TRUE will be used.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE