DimTree.setActiveGroupId

Syntax

setActiveGroupId(groupId: String, limitToGroup: Boolean);

Parameters

groupId. Group identifier.

limitToGroup. If the value is true, elements not included into the group are removed from selection. The default value is true.

Description

The setActiveGroupId property sets identifier of the active group of dictionary elements.

Comments

To create an element group, select the Element Groups item in dictionary context menu, then click Add button in the opened dialog box and select the required group of dictionary elements. To get identifier of an element group, select added selection schema and click the Save As button.

Example

To execute the example, the HTML page must contain the DimCombo component named dimCombo (see Example of the DimCombo Component Layout). The dictionary must contain a group of elements with the OBJ628190 identifier. Set an active element group for dictionary and add a handler of active element group change event:

// Get tree view
dimTree = dimCombo.getTreeView();
// Add handler for the event of active group of elements change
dimTree.GroupChanging.add(function(sender, args) {
    console.log("Active group of elements is changed");
)};
// Set a group of elements
dimTree.setActiveGroupId("OBJ628190");

After executing the example an element group with the specified identifier is set for the dictionary tree.