The
Token type is used to define all the advanced characteristics of a token displayed in an edit control. The characteristics of this token can be defined and changed using different WLanguage properties.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see
Declaring a variable.
// Add a token to an Edit control
MyToken is Token
MyToken.Caption = Customer.Name
MyToken.Value = Customer.IdCustomer
EditAddToken(EDT_Customer, MyToken)
// Modify the background color of a token
FOR EACH MyToken OF EDT_Customer.Token
IF MyToken.Value = Customer.IdCustomer THEN
MyToken.BackgroundColor = LightRed
END
END
Remarks
Properties specific to Token variables
The following properties can be used to handle a token:
| | |
| Property name | Type used | Effect |
|---|
| BackgroundColor | Color variable | Background color of the token. |
| Caption | Character string | Caption of the token as it will be displayed in the Edit control. If this property is not specified, the caption of the token will correspond to its stored value. |
| Character string | HTML code of the token caption as it will be displayed in the Edit control. If this property is not specified, the caption specified with the Caption property is used. |
| Color | Color variable | Color of the token text. |
 New in version 28StoredValue | Character string | Stored value of the token. Stores any type of value. |
| Tooltip | Character string | Tooltip displayed when hovering over the token. |
| Value | Character string | Value of the token. |
Handling tokens
- To handle the tokens of an Edit control, it is possible to use:
- You can use VariableReset to reset the content of a Token variable.
Functions that use the Token type
The following functions handle Token variables: