<Tool>
This element defines a new tool.
Attributes
|
Attribute |
Description |
|
Determines whether the tool is automatically launched when opening a FLY project. The Auto Start applies for regular panel, popup, and hidden tools. § AutoStart = 0 (Default) – Tool is not automatically launched. § AutoStart = 1 · When NeedProject is set to 0, tool will automatically launch when TerraExplorer starts. · When NeedProject is set to 1, tool is automatically launched only when TerraExplorer project is opened. |
|
|
The name of the tool as it should be displayed on the ribbon command and on the tool window. |
|
|
Id |
Uniquely identifies the ribbon command. |
|
Determines whether the ribbon button is disabled if no project is currently open in TerraExplorer: § NeedProject = 0 (Default) – Ribbon button is enabled even when no project is open. § NeedProject = 1 – Ribbon button is disabled when no project is open. |
|
|
Path |
Path to the HTML page (tool) that opens when the ribbon command is executed. Note: The path should include the group’s folder, e.g. “MyToolFolder\MyTool.html.” |
|
Determines whether the tool is set to run only once. § RunOnce = 0 (Default) – Tool can run every time TerraExplorer is opened. § RunOnce = 1 - Tool runs once. Note: This attribute only applies to TEZ files that are installed using the Add-ons tab in the TerraExplorer Options dialog box. |
|
|
Defines which of the applications in the TerraExplorer family should display this custom tool command. The attribute value can be any combination of the following values: § Display in TerraExplorer Pro = 1 § Display in TerraExplorer Plus = 2 § Display in TerraExplorer Viewer = 4 Use a combination of the values above to display the tool in multiple applications, e.g. to display the tool in both TerraExplorer Pro and Plus, but not Viewer, use ShowOnVersionTypes = 3. This attribute is not mandatory and if it does not appear in the tool.xml, the tool will be displayed in all TerraExplorer applications. |
|
|
Boolean that determines whether the tool opens in the Edge browser. |
Child Elements
|
Element |
Description |
Element’s Attributes |
|
<Icon> |
Defines an icon for the new ribbon command. |
path - Path to the icon that is displayed on the new ribbon button. |