IDimensionViewerBase.Collapse

Fore Syntax

Collapse(Node: Integer; [Recursively: Boolean = False ]);

Fore.NET Syntax

Collapse(Node: uinteger; Recursively: boolean);

Parameters

Node. Node, for which the method collapses children hierarchy.

Recursively. Determines whether children hierarchy is recursively collapsed.

Description

The Collapse method collapses hierarchies of tree children of the specified node.

Comments

Available values of the Recursively parameter:

True. The entire hierarchy of all children is collapsed.
Flase. Hierarchy of the selected element is collapsed.

To expand tree children hierarchy of the specified node, use the IDimensionViewerBase.Expand method.

Fore Example

Executing the example requires a form with the Button1 button and the MetaAttributesBreadcrumb component named MetaAttributesBreadcrumb1. MetaAttributesBreadcrumb1 is connected to a time series database.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Var
    DV: IDimensionViewerBase;
Begin
    DV := MetaAttributesBreadcrumb1.DimensionViewer;
    //Collapse children hierarchy
    DV.Collapse(0, True);
End Sub Button1OnClick;

Clicking the button in the drop-down list of the MetaAtrributesBreadCrumb1 component the children hierarchy is collapsed at the element with the 0 index.

Fore.NET Example

The requirements and result of the Fore.NET Example execution match with those in the Fore Example. Use Fore.NET analogs instead of Fore components.

Imports Prognoz.Platform.Interop.ExtCtrls;

Private Sub button1_Click(sender: System.Object; e: System.EventArgs);
Var
    DV: IDimensionViewerBase;
Begin
    DV := MetaAttributesBreadcrumbNet1.CtrlBox.DimensionViewer;
    //Collapse children hierarchy
    DV.Collapse(0, True);
End Sub;