ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Controls, pages and windows / Token functions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Adds a token 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
  • Index of the 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
Token value.
<Caption>: Optional character string
Token caption. 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
  • Index of the 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 be added.
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:
The Text token edit control Unit examples (WINDEV): The Text token edit control
[ + ] Using a "Text token" edit control.
The text token edit control Unit examples (WEBDEV): The text token edit control
[ + ] Using a "Text token" edit control.
The 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: wd290obj.dll
Minimum version required
  • Version 24
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 06/26/2023

Send a report | Local help