MetabaseTreeCombo

Inheritance Hierarchy

          IComponent

          IControl

          ITreeControl

          ITreeCombo

          IMetabaseTreeCombo

          MetabaseTreeCombo

Description

The MetabaseTreeCombo component is used to display the repository object tree as a drop-down list.

Working with the Component

By default the component does not display anything. To define the directory, contents of which should be displayed in the component, use the following property  Root. The list of displayed objects can be changed by defining required filter in the  Filters property. Each tree element is a reference to the corresponding repository object. To get some information on corresponding object, cast the tree node to the  IMetabaseTreeListNode  interface (transform the object using the keyword As) and get the  ObjectDescriptor property.

The main list of properties and methods of this component is inherited from TreeCombo, therefore you work with this component in the same way as you work with the tree of the TreeCombo component. The methods used to change the element hierarchy are not supported in this component.

You can use the button to reset tree elements selection.

NOTE. You can resize the drop-down list of elements by dragging its right, left or bottom border with your mouse. The minimum width of the drop-down list equals to the component width.

Element Search

The following types of search are available from the expanded drop-down list:

• On typing in first several characters of the element name the cursor moves to the first found element. This type of search is performed in cycles, and only by the elements in the expanded part of element tree hierarchy.

• Using the search bar which opens on pressing F3 or CTRL+F. The search is started after the user enters required character string and presses ENTER or clicks . Search is done in cycles by all the element hierarchy.

If search has been successful, the cursor will focus on the found element. Selection state depends on value of the  FindMode property. Depending on the  chosen multiple selection mode  you can add an element to selection either by selecting it using the Space key or selecting it with the mouse cursor while holding down the CTRL key.

You can also search for elements with the component drop-down list collapsed. When the component is focused, entering a set of characters creates a list of elements whose names contain this set of characters:

Elements are selected using the above-given method, depending on the value defined in the  SelectionMode property. Closing this dialog box applies the selection to the component.

You can search for one or several words based on segments in any mode. To do this, separate the search combinations with whitespace character. The word order in the names of search elements is ignored.

Sorting Data

Data sorting is available if the  ShowColumnHeaders, Sorted  and the  ColumnClick  properties have the True value, and the  SortType  property has a value other than None.

When you are in the form executing mode, click the caption of the appropriate column to sort data by it. The data are sorted ascending. Double-clicking changes the sorting direction. To sort data by multiple columns, click the headings of the required columns while holding down CTRL key. The sorting order is as follows: the column whose caption is clicked last is sorted last.

Sorting parameters can also be defined in the Sorting specialized dialog box:

This dialog box opens when selecting the appropriate item from the context menu called from the column heading area.

NOTE. The context menu option is available if the  ShowColumnHeaders  and the  Sorted  properties have the True value, and the  SortType  property should have a value other than None.

Move the columns used to sort by to the selection list. The and buttons are used to change sorting direction by the selected column. The and buttons are used to change the sorting order. Columns at the top of the list are sorted first.

In the Fore language, to apply sorting, you need to set to the  Sorted  property the True value, and the  SortType  property should have a value other than None. The column data of which is sorted is defined in the  SortColumn. Sorting direction is defined in the  SortAscending  property of the corresponding column.

Sorting can also be managed by the  Sort  and  SortDefault methods.

Component Filters

To set up filtering for objects displayed in the component tree, take one of the following steps:

• Select the Filter item in the context menu of the component.

• Under Object Inspector double-click the  Filters property.

This window shows a list of filters applied to the component.

The list is displayed as a table made up of two columns:

• Description. This column presents brief description of a filter.

• Object Class. A list of all classes (subclasses) included in this filter.

In this window, you can create new filters, or edit and delete existing filters. You can select multiple filters in the table, though these selected filters can only be deleted.

You can edit a filter description. To do this, select the required filter and click the description with your mouse. After a few seconds a dialog box for editing a description is opened. You can also use the hot key F2.

Creating Object Filter

To create a new object filter, take one of the following steps:

• Click the Add button.

• Press the INSERT key.

• Double-click a white space in the dialog box.

In the dialog box that opens, select the type of the created filter. The available types are:

• All Objects. When this filter is used, all repository objects are available.

• Specified Object Classes. When this filter is used, only the selected objects are available.

In the class tree, select object classes, which are available when this filter is used. Use the Show Subclasses checkbox to disable displaying of additional object classes in the tree.

In the Create the Following Type of Filter: field, specify how you want the filter to be saved:

• A Separate Filter for Each Selected Class. A separate filter is created for each selected class (subclass). Descriptions of created filters match the names of classes (subclasses).

• A Single Filter for the Selected Classes. One compound filter is created for all selected classes. Use the Description field to specify brief description for a created filter.

Clicking the OK button creates a new filter (filters) for the selected object classes.

Editing an Object Filter

To edit a filter, take one of the following steps:

• Double-click the required filter.

• Select the required filter in the table and click the Edit button.

• Select required filter and press F4.

• Select the Edit item in the context menu of selected filter.

Depending on the type of created filter (a separate filter for a class (subclass) or a compound filter), the dialog box for filter editing appears:

In this dialog box, you can change the object class (subclass or their combination for a compound filter) for which the filter is created, or modify filter description. Clicking OK saves the changes.

Filter Deleting

To delete a filter (filters), select it from the table and take one of the following steps:

• Click the Delete button.

• Press the DELETE key.

• Select the Delete item in the context menu of required filter (filters).

This deletes the filter.

Example

Properties of the MetabaseTreeCombo Component

Methods of the MetabaseTreeCombo Component

Events of the MetabaseTreeCombo Component

See also:

Additional Components