<Edit>.AddToken (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Token management functions

Prefix syntax

AddToken

Presentation

Example

Related examples

See also

<Edit>.AddToken (Function)

In french: <Saisie>.AjouteJeton

Adds a token to to a "Text token" Edit control.

Example

// Click [All recipients]
EDT_Recipient.DeleteAllToken()
FOR EACH mail OF tabMail
EDT_Recipient.AddToken(mail.Name, mail.Address)
END

// Syntax with the Token type
EDT_Recipient.DeleteAllToken()
FOR EACH mail OF tabMail
MyToken is Token
MyToken.Caption = mail.Address
MyToken.Value = mail.Name
EDT_Recipient.AddToken(MyToken)
END

Syntax

Adding a token directly Hide the details

<Result> = <Edit control>.AddToken(<Value> [, <Caption>])

<Result>: Integer

Subscript of added token,
0 if an error occurs:
If the Edit control is not a "Text token" control (the TokenEnabled property is set to False).
If a duplicate has been detected and the TokenAllowDuplicate property is set to False.

<Edit control>: Control name

Name of the "Text token" edit control.

<Value>: Character string

Value of the token.

<Caption>: Optional character string

Caption of the token. If this value is not specified, it will correspond to the value of the token.

Adding a token via the Token type Hide the details

<Result> = <Edit control>.AddToken(<Token>)

<Result>: Integer

Subscript of added token,
0 if an error occurs:
If the Edit control is not a "Text token" control (the TokenEnabled property is set to False).
If a duplicate has been detected and the TokenAllowDuplicate property is set to False.

<Edit control>: Control name

Name of the "Text token" edit control.

<Token>: Token variable

Name of the Token WLanguage variable that describes the token to add.

Remarks

The token is added at the position of the cursor. If the cursor is positioned between two tokens, the new token will be inserted between them.
To add a token after all other tokens, use <Edit>.InsertToken.
The edit control StoredValue property returns the stored values for the tokens, separated by the characters <CR> (Carriage Return).

Related Examples:

Unit examples (WINDEV): The Text token edit control

[ + ] Using a "Text token" edit control.

Unit examples (WEBDEV): The text token edit control

[ + ] Using a "Text token" edit control.

Unit examples (WINDEV Mobile): The Text token edit control

[ + ] Using a "Text token" edit control.

Business / UI classification: UI Code

Component: wd280obj.dll