IDimSelection

Assembly: Dimensions;

Description

The IDimSelection interface is used to work with dictionary selection.

Inheritance Hierarchy

IDimSelection

Comments

The following comparison selections are available for dictionary selection: comparison for equality and inequality. These comparison types can be applied for:

Examples of selection comparison are available in the Compare dictionary selection section.

NOTE. Working with this interface is not thread secure. If it is expected to be used in threads described by the IForeThread interface, access lock/unlock should be executed on application level. For this purpose, critical sections are used that are described by the IForeCriticalSection interface.

Properties

  Property name Brief description
AdditionalHierarchies The AdditionalHierarchies property returns an object for working with additional alternative hierarchies.
AdditionalHierarchy The AdditionalHierarchy property returns an object for working with an alternative hierarchy.
AllowChangeElementGroup The AllowChangeElementGroup property controls setting a group of elements via dictionary context menu and using the Fore language.
ApplySelectionSchemaOnlyOnce The ApplySelectionSchemaOnlyOnce property determines whether chosen selection schema is applied only when a report opens.
ApplySelectionSchemaOnRebuild The ApplySelectionSchemaOnRebuild property determines whether selection schema must be applied on dimension rebuild.
Dimension The Dimension property returns an object containing dictionary elements.
Element The Element property returns element index in the dictionary by element index in selection.
ElementGroup The ElementGroup property determines a group of dimension elements that includes elements, which should be included into the list of available elements.
FirstDimElement The FirstDimElement property returns the first selected element of the dictionary.
Group The Group property determines a group of dictionary elements set in the selection.
Hierarchy The Hierarchy property determines data of alternative hierarchy of dictionary elements.
Iterator The Iterator property checks if elements are available and returns iterator containing common elements.
LastDimElement The LastDimElement property returns the last selected dictionary element.
MultiSelect The MultiSelect property determines whether multiple elements can be selected.
PredefinedSchema The PredefinedSchema property returns an object for working with predefined selection schema of dimension.
SelectedCount The SelectedCount property returns the number of elements in selection.
SelectedElementArray The SelectedElementArray property checks if elements are available and returns an array containing common elements.
SelectHierarchy The SelectHierarchy property determines and adds alternative hierarchy in dictionary selection.
SelectionSchema The SelectionSchema property determines selection schema for dictionary elements.
SelectionSchemaOnceApplied The SelectionSchemaOnceApplied property determines whether chosen selection schema was applied at least once.

Methods

  Method name Brief description
AttributeToVariant The AttributeToVariant method sets selection value by values of the specified elements' attribute.
AttributeToVariantOI The AttributeToVariantOI method sets selection value by the specified element's attribute values, if a custom hierarchy and a source dictionary are linked.
ChildrenCount The ChildrenCount method returns the number of child elements for the specified dictionary elements.
Compare The Compare method compares selections.
CopyTo The CopyTo method copies selection, selection schemas, or groups of elements of source dimension to consumer dimension.
CopyToEx The CopyToEx method copies the option selected by the Options parameter from source dimension to consumer dimension.
CreateCopy The CreateCopy method creates a copy of dictionary selection.
DeselectAll The DeselectAll method deletes all dictionary elements from selection.
DeselectChildren The DeselectChildren method removes child elements from selection.
DeselectElement The DeselectElement method removes an element from selection.
DeselectSiblings The DeselectSiblings method removes level elements from selection within the same parent element.
ExternalLoad The ExternalLoad method loads selection in the XML format from the string.
ExternalSave The ExternalSave method saves selection in the XML format to the string.
ForceHierarchy The ForceHierarchy method sets an alternative hierarchy in the selection.
InitAdditionalHierarchy The InitAdditionalHierarchy method initializes an alternative hierarchy.
IntersectWith The IntersectWith method leaves selected only the elements included in the intersection with the sent selection.
InvertAll The InvertAll method inverts dictionary selection.
IsAnyChildSelected The IsAnyChildSelected method checks if element's child elements are included into selection.
IsElementSelected The IsElementSelected method checks if a dictionary element is included into selection.
LimitToGroup The LimitToGroup method changes element selection; only the elements that belong to the specified group of dictionary elements remain selected.
LimitToHierarchy The LimitToHierarchy method keeps selection only for elements, which are included in the specified alternative hierarchy.
Parse The Parse method restores selection from the specified value.
ParseAttribute The ParseAttribute method restores selection from the specified value.
ParseAttributeOI The ParseAttributeOI method restores a source hierarchy selection if a custom hierarchy and a source dictionary are not linked.
SaveElementDependencies The SaveElementDependencies method saves a collection of dependencies from elements contained in the selection.
SelectAll The SelectAll method adds all dictionary elements to selection.
SelectAttributeRange The SelectAttributeRange method changes dictionary selection depending on the range of attribute values.
SelectChildren The SelectChildren method adds child elements to selection.
SelectElement The SelectElement method adds an element to selection.
SelectElementWithoutExcep The SelectElementWithoutExcep method adds the specified element to selection without displaying messages about possible exceptions.
SelectLevel The SelectLevel method adds a dimension level to selection.
SelectSiblings The SelectSiblings method adds level elements within the same parent element to selection.
ToString The ToString method sets selection value as a string in accordance with the selected parameters.
ToVariant The ToVariant method sets selection value by the Identifier attribute.

See also:

Dimensions Assembly Interfaces