Token (Type of variable)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Properties specific to the description of Token variables
Handling tokens
Functions that use the Token type

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Token (Type of variable)

In french: Jeton

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 modified using different WLanguage properties.

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

Example

// Add a token into 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 the description of Token variables

The following properties can be used to handle a token:

Property name	Type used	Effect

Tooltip	Character string	Tooltip displayed when hovering over the token.
Color	Color variable	Color of the token text.
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 for the caption of the token as it will be displayed in the edit control. If this property is not specified, the caption specified with the property ..Caption is used.
Value	Character string	Stored value of the token.

Remark: These properties can be handled by using one of the following syntaxes:

<Variable name>..<Property name>
<Variable name>.<Property name>

Handling tokens

To handle the tokens of an edit control, it is possible to use:
- the token management functions.
- the ..Token property of the edit control that returns a modifiable list containing all the tokens displayed in the control.
To reset the content of a Token variable, you can use VariableReset.

Functions that use the Token type

The following functions handle Token variables:


Versions 24 and later EditAddToken New in version 24 EditAddToken EditAddToken	Adds a token to into a "Text token" edit control.
Versions 24 and later EditInsertToken New in version 24 EditInsertToken EditInsertToken	Inserts a token into a "Text token" edit control.