View Selector Tree Properties
The following properties are available for View Selector Tree objects, grouped by the categories shown in the Selectors and Selector Lists editors.
Admin
| Property | Type | Default | Description |
|---|---|---|---|
bool |
false |
Indicates whether the View Metadata Editor can be launched from the context menu. If True, the context menu contains an Edit View item when the right mouse button is clicked on a view in the View Selector. When the item is clicked, the View Metadata Editor is opened and the view’s metadata instance is set as the active instance. If the view is assigned a workbook script, the context menu contains an Edit Workbook Script item, which launches the Workbook Script Metadata Editor. If the view is assigned a view toolbars configuration, the context menu contains an Edit Toolbars Configuration item, which launches the Toolbars Configuration Metadata Editor. If one or more SQLPassthroughDataSets are associated with the view in the DataSetRanges and/or the AutoCompleteRanges property, the context menu contains an SQLPassthroughDataSets from DataSetRanges and/or SQLPassthroughDataSets from AutoCompleteRanges item, which launches the SQLPassthroughDataSets Metadata Editor for the selected instance. This setting should only be True for an application that is used for managing view metadata. |
|
bool |
false |
Indicates whether the Excel template can be exported from the context menu. If True, the context menu contains an Export Excel Template item when the right mouse button is clicked on a view in the View Selector. This setting is typically only set to True for an application that is used for managing Excel template binary artifact metadata. |
|
bool |
false |
Indicates whether the Excel template can be imported from the context menu. If True, the context menu contains an Import Excel Template item when the right mouse button is clicked on a view in the View Selector. This setting should only be True for an application that is used for managing view metadata. |
|
bool |
false |
Indicates whether the Binary Artifacts Editor can be launched from the context menu. If True, the context menu contains an Edit Excel Template item when the right mouse button is clicked on a view with an associated Excel template. When the item is clicked, the Binary Artifacts Editor is opened and the Excel template’s binary artifact instance is set as the active instance. |
|
bool |
false |
Indicates whether the view template designer can be opened for an Excel view from the context menu. If True, the context menu contains an Open View Template Designer item when the right mouse button is clicked on an Excel view in the View Selector. This setting should only be True for an application that is used for managing view metadata. |
|
bool |
false |
Indicates whether the View Wizard can be opened for an Excel view from the context menu. If True, the context menu contains an Open View Wizard item when the right mouse button is clicked on an Excel view in the View Selector. When the item is clicked, the View Wizard is opened. The View Wizard allows editing view properties, adding the view to a view hierarchy, and opening the Excel View Template Designer. This setting should only be True for an application that is used for managing view metadata. |
|
bool |
false |
Indicates whether the View Hierarchy Editor can be opened from the context menu. If True, the context menu contains an Open View Hierarchy Editor item when the right mouse button is clicked. If a single hierarchy is associated with the application, the hierarchy and active item are activated in the editor. This setting should only be True for an application that is used for managing metadata. |
|
bool |
true |
Whether to cache the view selector node expansion states. |
Appearance
| Property | Type | Default | Description |
|---|---|---|---|
Image |
default(Image) |
Image displayed at the top of the view selector. This setting is often used to display a company logo. Or, if you have multiple applications, you may want to use a different logo for each application. To remove the image, click the Image value with the left mouse button, and then press the Delete key on the keyboard. |
|
Color |
0xFFFFFFFF |
The background color of the image. |
|
bool |
false |
Whether to show view thumbnails when hovering over a view. |
Behavior
| Property | Type | Default | Description |
|---|---|---|---|
bool |
true |
Indicates whether the Find functionality is available. If True, the Find dialog is accessed from the context menu or by using the Ctrl+F shortcut keys. Find allows the view hierarchy to be searched for categories and/or views. |
|
bool |
false |
Indicates whether the nodes are automatically expanded when the view selector is initially displayed. When the nodes are expanded, all the hierarchy items are visible. When the application is closed, the node expansion state is cached, and then restored when the application is subsequently restarted. |
Hierarchy
| Property | Type | Default | Description |
|---|---|---|---|
string |
The ID of the hierarchy displayed in the view selector. |
||
string |
The ID of the hierarchy items filter. The filter removes or hides hierarchy items before the hierarchy is displayed by the view selector. The HierarchyItemsFilterObjectTypeID setting is optional. |
||
ViewSelectorTreeRootNodeDisplayPolicy |
Default valueViewSelectorTreeRootNodeDisplayPolicy.TopLevelItemsForSingleHierarchy |
Controls whether a root node is displayed in the tree for each hierarchy OR a root node is displayed in the tree for the top level items of each hierarchy. For example, the Sample application contains a view hierarchy named 'Categorized Views'. The top level hierarchy items are Templates, Input, Scripts, Adhoc, etc. With the HierarchyRootNodeDisplayPolicy set to TopLevelItems, the tree’s root nodes are Templates, Input, Scripts, Adhoc, etc. With the HierarchyRootNodeDisplayPolicy set to Hierarchy, the tree’s root node is 'Categorized Views' and the root node’s child nodes represent the hierarchy’s top level items. When a single hierarchy is presented by the tree, such as when the HierarchyID setting is used, the hierarchy’s top level nodes are typically displayed as the root nodes. When multiple hierarchies are presented by the tree, which is possible when the HierarchyToRoleMapping setting is used in conjunction with an authentication service, you may want the root nodes to represent the actual hierarchies. Alternatively, you may want the root nodes to represent the hierarchies' top level items. Hierarchy - A root node is displayed for each hierarchy. TopLevelItems - The root nodes represent the top level items of each hierarchy. TopLevelItemsForSingleHierarchy - When a single hierarchy is presented by the tree, the root nodes represent the hierarchy’s top level items. When multiple hierarchies are presented by the tree, a root node is displayed for each hierarchy. This is the default setting. |
|
List<RoleHierarchyPair> |
Defines which hierarchy is displayed based on the authenticated user’s role(s). Typically, the mapping includes each possible role with an associated hierarchy. The hierarchy-to-role mapping is evaluated in the order defined. When the user is in the specified role, the hierarchy that is associated with the role is used to populate the view selector. The HierarchyID setting can be used as the default hierarchy. For instance, when the user is not in any role included within the mapping, the hierarchy represented by the HierarchyID setting is used to populate the view selector. The HierarchyToRoleMapping setting is only applicable when an authentication service is configured for the application or when the role associated with an entry is left blank. Refer to the application’s AuthenticationServiceObjectTypeID setting. See also: HierarchyID |
Misc
| Property | Type | Default | Description |
|---|---|---|---|
bool |
false |
Whether to automatically size the width of the selector when a node is expanded. The width will only be changed if it isn’t wide enough to display all nodes. The width will never be made narrower. |
|
int |
0 |
The maximum width, in points, of the control when it is auto-sized. A default value of 0 is applied as no limit. |
|
MruListAllowUserToSetNumberOfViews |
bool |
false |
Whether the user will be able to set the maximum number of views to list. |
MruListMaximumNumberOfViews |
int |
5 |
Limits the number of views that are listed. A minimum value of one should be specified. If no list is desired then the MostRecentlyUsedViewListHierarchyItem should be removed from the view hierarchy. If the MruListAllowUserToSetNumberOfViews is set to "true" then MaximumNumberOfViewsToList will serve as the default and the user will be able to set their own value via the context menu of the most recently used view list. If the MruListAllowUserToSetNumberOfViews is set to "false" then MaximumNumberOfViewsToList will control how many views are listed. |