Deselect Tree Entries
Tag: Unselect
The Unselect action, along with the applicable SetParam options, lets you automate deselecting documents and design elements within scanEZ's selection tree.
<Unselect Category="Designs" Type="Views"/>| NOTE | The Unselect action can be used for deselecting entries within trees and grids; the selection mechanics, attributes and compatible values, and the attributes and SetParam options are different depending on what you need to select. |
|---|
For selections in grids, selection trees in mono-database products or server/database trees, please look at these pages:
- Deselecting grid rows
- Deselecting in design element trees (signEZ, viewEZ, designPropEZ, actionBarEZ)
- Deselecting in multi-database and multi-server selection trees (databaseEZ, aclEZ, replicationEZ, agentEZ)
Tag Attributes
| Attributes | Attribute Value | Value Description | Comment |
|---|---|---|---|
| Category | User defined My Selection name Access Control List Designs Documents Profile Documents Deletion Stubs Conflicts ByNoteID | Defines the form of Unselect operation to be used | Mandatory |
| Type | See detailed description* |
|
|
SetParam Options
| Field Name | Compatible Field Values | Value Description | Comment |
|---|---|---|---|
| NoteID | The NoteID in either decimal or hexadecimal format prefixed with an "h" or "H" |  |
|
| Name | User defined OR set value All | The text displayed in tree node Will deselect everything in the tree | Case insensitive "All" value depends on the current language of the product. |
<Unselect>
<SetParam NoteID="hC9A"/>
<SetParam NoteID="h18FA"/>
</Unselect>Detailed Description
To automate selections in scanEZ's Selection Tree, use the Unselect action along with a combination of Category and Type attributes.
| NOTE | This action will not automatically expand a category. A category must already be expanded from a previous action in the script in order to be deselected. This will deselect checkbox selections. |
|---|
For all Category values except Designs, the Type value is equal to the displayed title in the selection tree.
The following are compatible Type values when using the 'Designs' Category:
- Outlines
- Framesets
- Pages
- Forms
- Views
- Folders
- Navigators
- Agents
- Images
- Applets
- Web Services Providers
- Web Services Consumers
- Java
- Jars
- Subforms
- Shared Fields
- Script Libraries
- Others
- Agent Data
- Data Connections
- DB2 Access Views
- Style Sheets
- Shared Columns
- Shared Actions
- Files
- Wiring Properties
- Composite Applications
- Components
- iNotes
- XPages
- Custom Controls
- Themes
- Server JavaScript Libraries
- Eclipse Files
Example Script
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<ytriaAutomation Application="scanEZ" Console="True">
<Expand Target="Tree" Category="Documents" Type="Memo"/>
<Unselect>
<SetParam NoteID="h1106"/>
<SetParam NoteID="h110A"/>
</Unselect>
</ytriaAutomation>In the script above, (used on a currently loaded database) the Unselect action will deselect documents with NoteIDs of "h1106" and "h110A".