Skip to main content
Skip table of contents

Set Focus on Tree Entry

Tag: Focus

The self-closing tag Focus is used to automate the setting of focus within the Selection Tree.

Detailed Description

The Focus action uses the same logic as the Select action. But unlike the Select action, this will not make a checkbox selection next to the tree entry; this will only place the focus (highlight) on the specified tree entry.

For example, <Focus Target="Tree" Category="Designs" Type="Folders" Name="($Trash)"/>would set the focus (highlight) the Folder ($Trash) as seen below.



Focus can be set at the Category level, the Type level, or the Name level.

For more information about compatible Attributes see Select.

Tag Attributes

AttributesAttribute ValueValue Description
TargetTree
N/A Required
CategoryUser defined My Selection name
Access Control List
Designs
Documents
Profile Documents
Deletion Stubs
Conflicts
ByNoteID
Detailed Type values for the Designs category can be found in the Select page - Required
TypeDisplayed tree name

N/A - Not applicable when using category 'ByNoteID'

NameDisplayed document title

N/A - Not applicable when using category 'ByNoteID'

ValueDecimal or hexadecimal value of NoteID

N/A - Not applicable when using category 'ByNoteID'

Example Scripts

XML
<Focus Target="Tree" Category="Designs" Type="Agents" Name="My Agent"/>
XML
<?xml version="1.0" encoding="UTF-8"?>
<ytriaAutomation Application="scanEZ" ApplicationVersion="16.5">
	<Load Server="ACME01/ACME">
		<Load Database="mail\daltmann.nsf" Select="True"/>
	</Load>
	<Expand Target="Tree" Category="Designs" Type="Folders"/>
	<Focus Target="Tree" Category="Designs" Type="Folders" Name="($Inbox) [en]"/>
	<Select Target="ItemsGrid" lines="all"/>
</ytriaAutomation>

In the script above, the database "daltmann.nsf" on ACME01/ACME will be loaded into scanEZ. The selection tree will be expanded to allow the action Focus to place the focus (highlight) on the folder named "($Inbox) [en]". All entries within the Items grid will be selected.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.