IDimInstance

Description

The IDimInstance interface contains properties and methods used to access dictionary data.

Comments

Classes of repository objects that support IDimInstance interface:

• MetabaseObjectClass.KE_CLASS_ADOMDDIM. ADOMD dictionary.

• MetabaseObjectClass.KE_CLASS_METADICTIONARYRDS. Table MDM dictionary.

• MetabaseObjectClass.KE_CLASS_RDS_DICTIONARY. MDM dictionary.

• MetabaseObjectClass.KE_CLASS_RDS_COMPDICTIONARY. Composite MDM dictionary.

• MetabaseObjectClass.KE_CLASS_STDDIM. Table dictionary.

• MetabaseObjectClass.KE_CLASS_CLNDIM. Calendar dictionary.

• MetabaseObjectClass.KE_CLASS_USERDIM. Calculated dictionary.

To get dictionary data, for the corresponding repository object execute the  IMetabaseObjectDescriptor.Open  or  IMetabaseObjectDescriptor.OpenWithParam  method, and cast the execution result to the IDimInstance type.

Properties

	Property name	Brief description
	AttributeHierarchies	The AttributeHierarchies property returns data collection of dictionary alternative hierarchies.
	Attributes	The Attributes property returns an object that contains a collection of dictionary attributes' values.
	Blocks	The Blocks property returns an object that contains a collection of dictionary blocks.
	BuilderException	The BuilderException property returns information on errors that may occur while opening the dictionary.
	DefaultElement	The DefaultElement property returns the default text index.
	Dimension	The Dimension property returns an object containing dictionary structure.
	Elements	The Elements property returns a collection of elements of a dictionary instance.
	ElementsByOrder	The ElementsByOrder property returns iterator to the dictionary element tree built taking into account custom sorting.
	Ident	The Ident property returns identifier of a repository dictionary.
	Indexes	The Indexes property returns an object that contains a collection of dictionary indexes.
	InstanceModel	The InstanceModel property returns a general model of dictionary.
	Key	The Key property returns key of repository dictionary.
	Levels	The Levels property returns an object that contains a collection of dictionary elements' levels.
	MetabaseObject	The MetabaseObject property returns dictionary data as repository object data.
	Name	The Name property returns name of repository dictionary.
	RootElements	The RootElements property returns an object that contains an array of dictionary elements stored at zero level.

Methods

	Method name	Brief description
	CreateSelection	The CreateSelection method creates an object containing dictionary selection.
	NewElement	The NewElement method creates an object that enables to work with a dimension element.
	NewElementsOrderSetup	The NewElementsOrderSetup method returns settings of dictionary elements custom sorting.
	SaveCache	The SaveCache method saves cache of an open dictionary.

See also:

Dimensions Assembly Interfaces