AX3950

Task pane properties

The following properties are available for items in a task pane. If you are editing one of the built-in task panes (such as Explorer), see the following for more information on that task pane: Built-in task panes and ribbon tabs.

Item Description

Display Text / Section Name

The text to display for the item. If the item has a defined shortcut target to an Axiom file or feature, then you can leave this box blank, and the display text will be the name of the file or feature.

If the item is a top-level item, then this property is called Section Name, to indicate that the item will be displayed as a section header in the task pane. Section headers are gray title bars that can be expanded and collapsed.

Tool Tip

The text to display as a tool tip when a user hovers their cursor over the item. This text can be helpful to explain the purpose of the item within the context of the list.

If no tool tip text is defined, then the tooltip displays the full path of the shortcut target (if defined).

Custom Image

The image to display for the item on the task pane. Click the Browse button [...] to select an image that is stored in the Reports Library. If the image is not already saved in the Reports Library, you can right-click a folder and select Import to import the image (if you have the appropriate rights to do so).

The image must be at least 32x32 pixels, and the file format must be JPG or PNG. Larger images will be resized to fit. The image should be square because the aspect ratio will be retained when resizing.

If no custom image is defined, then the default Axiom image for the shortcut target is used. If the item has no shortcut target, the Axiom "dots" icon is used. In either case (custom image or default image), an image will only display next to an item if the parent item has Display child images enabled.

NOTE: End users must have permission to the image file in order to see it rendered in the task pane. It is recommended to create a dedicated Images folder in the Reports Library and store all images in this location. You can grant access to this folder using the Everyone role, or you can create subfolders and grant access to users and roles as needed.

This option is not available for top-level section items.

Display Settings

Item Description

Display child item images

Select this option if you want icons to display on the child items for the current item. This option is selected at the parent item level because all child items must have the same icon settings (enabled or disabled), so that the child items will align appropriately in the task pane.

If enabled, then each child item will display using the associated icon for its shortcut target. For example, if the target is a report file, then the relevant report file icon will display next to the item. If an item does not have a shortcut target, or if the target does not have a specific icon, then the default Axiom Software "dots" icon is used.

If disabled, then no icons will display on child items.

Auto-number child items

Select this option if you want to apply auto-numbering to child items for the current item. If selected, all child items will be auto-numbered by whole numbers (1, 2, 3...).

NOTE: Multi-level auto-numbering is not supported. If auto-numbering is applied at two subsequent levels, the numbering will appear as follows:

Display child items inline

Select this option if you want all of this item's child items to display inline, omitting this item.

For example, this might be used in the following circumstances:

  • When using certain items from the Command Library as targets, to hide the "command line" and only show the contents of the command.
  • When linking to a folder, to hide the "folder" node and instead display the resulting files inline.
  • When linking to a task pane, to hide the file name and instead show the contents of the linked task pane directly within this task pane. The shortcut parameters for the linked task pane must also be configured to enable Embed list items.

NOTE: If this option is selected for an item that does not have any child items (either literal child items in the structure or child items inherent to the shortcut target), then the item will be hidden in the task pane.

Show restricted item

Select this option if you want this item to always display in the task pane, regardless of the user's security permissions and regardless of the current context.

By default if a task pane item is linked to a file or feature that a user does not have access to, then that item is hidden from the user. There are times when that may not be the desired behavior. For example, if the task pane details a set of process steps, you may want the user to be able to see the entire process from start to finish, even if they do not have rights to one or more particular items referenced in the process. For more information, see Task pane design considerations.

If this option is selected, and the user does not have rights to the linked file or feature (or the item is not applicable to the current context), then the item will display as grayed out and the file or feature cannot be launched.

This option only applies to child items; it does not apply to top-level sections. By default, if a user has no access to any items in a section, the entire section will not display.

TIP: As you change appearance options, you can click Apply to view the result of the change within the Axiom Assistant area, without needing to close the Edit Task Pane dialog. This only works if the task pane was opened before editing.

Shortcut settings

Item Description
Shortcut Target

The target file or feature for the item. When a user double-clicks on the item in the task pane, the file or feature will open.

Click the Browse button [...] to select the desired file or feature. You can select any item that you can navigate to within Axiom Explorer. For more information on what types of files and features can be linked to task pane items and their behavior within the task pane, see Linking to Axiom files and features in a task pane or ribbon tab.

Once a target is selected, Axiom Software places the necessary syntax to open the target within the Shortcut Target box. It is best not to manually edit this text, as you may inadvertently render the syntax invalid. If you want to select a different target, use the Browse button to select the target rather than editing the target syntax.

If you no longer want the item to link to a shortcut target, click the Delete button to remove the shortcut.

NOTE: If an item has child items, then that item cannot have a shortcut target. When users work with the task pane, double-clicking an item with children expands or collapses the item, so there is no way for the user to launch the shortcut target.

Shortcut Parameters

Most shortcut targets have one or more associated shortcut parameters that impact the behavior of the linked file or feature when it is opened from the task pane. The available parameters depend on the shortcut target—for example, report files have different parameters than tables.

For more information on available shortcut parameters per shortcut target type, see:

  • Shortcuts

    This section details shortcut behavior and available parameters when linking to various file types.

  • Command Library

    This section details shortcut behavior and available parameters when using items in the Command Library.

Task pane editor settings

The option Limit to Web Client Navigation Items is located underneath the Axiom Explorer section of the dialog. This option should only be used when you are creating a task pane that defines navigation links for the Web Client. If enabled, it filters the dialog so that it only displays options that are relevant to Web Client navigation links. For more information, see Defining content for the Web Client Navigation panel.