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
Inserts a token into a "Text token" Edit control.
Example
// Click [Insert the test robot]
EDT_Recipient.InsertToken(1, "ROBOT", "robotmail@address.test.com")
// Syntax using the Token type
MyToken is Token
MyToken.DisplayedValue = "ROBOT"
MyToken.StoredValue = "robotmail@address.test.com"
EDT_Recipient.InsertToken(1, MyToken)
Syntax

Inserting a token directly Hide the details

<Result> = <Edit control>.InsertToken(<Position> , <Value> [, <Caption>])
<Result>: Integer
  • Real index of the inserted 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.
<Position>: Integer
Token insertion index.
  • If <Position> is greater than the number of tokens in the control, the token is added at the end of the existing tokens (<Edit>.AddToken).
  • If <Position> is set to 0, the token is added at the beginning.
  • If <Position> is set to -1, <Result> is 0.
<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.

Inserting a token via the Token type Hide the details

<Result> = <Edit control>.InsertToken(<Position> , <Token>)
<Result>: Integer
  • Real index of the inserted 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.
<Position>: Integer
Token insertion index.
  • If <Position> is greater than the number of tokens in the control, the token is added at the end of the existing tokens (<Edit>.AddToken).
  • If <Position> is set to 0, the token is added at the beginning.
  • If <Position> is set to -1, <Result> is 0.
<Token>: Token variable
Name of the Token variable describing the token to add.
Remarks
  • To add a token at the cursor position, use <Edit>.AddToken.
  • 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