Control Token Box
Used by: Any output tag or parent tag
* Does not use the Style Settings tag.
This is a multi-use widget for Control Tokens that both indicates current token status and affects token behavior.
It can be used to indicate whether the current user has a token on the linked widget. The box will be colored the ‘No Token Color’ (red by default) if you do not have a token on the linked tag, the ‘Pending Token Request Color’ (orange by default) if you have a pending token request for the linked tag and the ‘Possessing Token Color’ (green by default) if you possess the token for the linked tag.
The Control Token Box can also be used to request or release a token automatically on the linked tag when the page the widget is drawn upon is opened (auto-request) or closed (auto-release). This aligns well with the security best-practice of placing controls on pop-up pages. (Best Practices for Security) Use the ‘Auto Request/Release’ option to enable this feature.
If you would like to keep the token after closing the page, you can check the ‘Hold Token Button’. If you would automatically re-request the token after losing it, you can check the ‘Auto Re-Request’ check box. The widget can also be made invisible by checking the ‘Hide’ box. (While these notes refer to "closing the page", any action that means the widget is no longer active on screen will have the same effect. For example, if the widget is drawn on a tabbed folder and you switch to a different tab.)
To provide the ability to control the entire tag tree, a fictitious ‘Root Tag’ is declared in the ControlTokenManager. The syntax to use this would look similar to:
\ControlTokenManager.RequestToken(\ControlTokenManager.RootTagID, Level)
This can also be configured in a Request Button widget or the Control Token Box widget. The Root Tag name and area can be changed by adding ControlTokenRootTagName and ControlTokenRootTagArea properties.
The properties dialog for the Control Token Box object:
No Token Color
Sets the color of the box when you do not have a Control Token on the linked tag.
Pending Token Request Color
Sets the color of the box when you have requested a Control Token on the linked tag.
Possessing Token Color
Sets the color of the box when you have a Control Token on the linked tag.
Auto Request Level
Applies only when you have enabled Auto Request / Release. Sets the Level that will be used for your automatic request.
Auto Request/Release
When selected, this widget will automatically request a Control Token for the linked tag when the page is opened and then automatically release that token when the page is closed.
Auto Re-Request
Certain events can release a token that you hold (For example, token administrators can release a token held by any user.) If this option is selected, and if the page displaying this widget remains open, the widget will automatically create a new request for a Control Token on the linked tag.
Hold Token
If selected then the act of closing the page where this widget is drawn will not release the token that you hold.
Hide
The widget does not need to be visible in order for the Auto Request/Release, Auto Re-Request, and Hold Token features to be active. You might choose to use the widget for the purpose of enabling those features on a page that holds control widgets for a tag but hide the Control Token Box itself.
Disable Options
Disable selected operator-interaction features of this widget.
See: Operator Interaction Controls
Tools\Control Tokens
