Portal_Tool

Tool

Tools appear in the Global Actions section of the Application Toolbar.

Properties

augment : uiIdentifier

Name of a tool in the augmented portal to insert after.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter. Case and length are not restricted. Letters and numbers are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

caption : string

The name of the tool in hover text and for screen readers.

Should be a string id for internationalization.

event : uiIdentifier

The item event name.

Refers to a UIEvent raised when the global action is selected i.e. the icon button is clicked. A common related configuration is a Drawer event handler to pop out some functionality from the Right Nav.

See

UIEvent UIAction

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter. Case and length are not restricted. Letters and numbers are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

icon : string

The icon to represent the action in the Global Actions section.

Example

icon:smile

menu : string

The parent menu tool name.

name : string

The identifier of the tool.

May be used for lookup in scripting.

parameter : string

Parameter supplied to the handler when event is fired.

Example

<Tool name="toolPreview" caption="ids.preview" icon="icon:remove_red_eye" event="sysPreview"/>

Parents

• Portal - Declares the application's structure, including its set of workspaces. Model Server serves the application at *serverRoot*/ui/portal/*portalName*.

Parent topic: Portal