DimensionHierarchyController Class [AX 2012]

The DimensionHierarchyController class manages the instances of the Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyDesigner class when it is used on a form.

Syntax

class DimensionHierarchyController

Run On

Client

Methods

	Method	Description
	accountRuleEventHandler	Handles the account rule event by passing the account structure as a record to the account rule form
	activateHierarchy	Activates the specified hierarchy.
	activateHierarchyEventHandler	Handles the activate hierarchy event by starting the draft tree that is associated with the currently selected hierarchy.
	addControlToTabPage	Adds an instance of the Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyDesigner class to the specified tab page.
	addDimensionHierarchy	Adds the specified dimension hierarchy to the form to be edited.
	addMainAccountSegment	Adds the main account segment to the dimension hierarchy.
	addNodeRecursive	Adds the specified node to the specified tree and calls this method for each child of the node.
	addRelationships	Adds relationships to the specified Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyDesigner instance.
	addTabPage	Adds a tab page that contains the specified caption.
	attachEventHandlers	Attaches event handlers to the specified instance of the Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyDesigner class.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	clearRelationships	Clears relationships from the specified Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyDesigner instance.
	combinationAddedEventHandler	Handles the combination added event that is raised by the hierarchy designer control.
	combinationMovedEventHandler	Handles the combination moved event that is raised by the hierarchy designer control.
	combinationPastedEventHandler	Handles the combination pasted event that is raised by the hierarchy designer control.
	combinationRemovedEventHandler	Handles the combination removed event that is raised by the hierarchy designer control.
	constraintChangedEventHandler	Handles the constraint changed event by updating the constraint information that is associated with the hierarchy level that is specified in the event information.
	createHierarchySegmentEventHandler	Handles the create dimension event by opening the dimension details form and automatically adding any newly created dimension attributes as segments in the hierarchy that is associated with the designer that is raising the event.
	deleteHierarchy	Deletes the selected hierarchy.
	deleteHierarchyEventHandler	Handles the delete hierarchy event by deleting the currently selected hierarchy or elements.
	deleteSelection	Deletes the current selection in the account structure.
	duplicateStructure	Duplicates the specified tree.
	duplicateStructureEventHandler	Handles the duplicate event by creating a copy of the hierarchy and tree that are associated with the currently selected hierarchy.
	editHierarchyEventHandler	Handles the edit hierarchy event by converting the current hierarchy to a draft state.
	editHierarchySegmentEventHandler	Handles the event to add a dimension that is raised by the hierarchy designer control.
	editRelationshipsEventHandler	Handles the edit relationships event by starting the DimensionRelationshipConstraint form and updates the designer with the changes.
	enableDisable	Enables or disables buttons for the specified DimensionHierarchyDesignerInfo object.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getDefaultNodeId	Retrieves the node ID for the nodes that were automatically created by the DimensionTree class.
	getDesigner	Converts the specified object to an instance of the Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyDesigner class.
	getDesignerFromTabPage	Retrieves the hierarchy designer for the specified tab page.
	getDimensionAttributeForHierarchy
	getHierarchyConstraintNode	Creates a new instance of the Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyConstraintNode class by using the specified constraint node ID.
	getLevelCountFromDesigner	Gets the hierarchy level count from the specified hierarchy designer.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getTreeIdFromDesigner	Retrieves the record ID of the associated tree from the specified designer.
	getTreeIdFromTabPage	Retrieves the record ID of the associated tree from the specified tab page.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hierarchySegmentAddedEventHandler	Handles the level-added event by adding the hierarchy level that is specified in the event information to the hierarchy that is associated with the designer that raised the event.
	hierarchySegmentMovedEventHandler	Handles the level moved event by updating the hierarchy level information for the hierarchy that is associated with the designer that raised the event.
	hierarchySegmentRemovedEventHandler	Handles the level removed event by removing the hierarchy level that is specified in the event information from the hierarchy that is associated with the designer that raised the event.
	initDimensionTreeNode	Initializes an instance of the DimensionTreeNode class based on the specified constraint.
	initializeDimensionHierarchyFromDatabase	Initializes the specified designer based on information currently in the database.
	initializeManagedSegments	Initializes the collection of segments that can be used by the control.
	isHierarchyReadOnly	Determines if the control should let the user change the hierarchy's structure
	isRowOrColumnSelected	Determines whether either a row or column is selected.
	lazyLoadChildren	Creates the child nodes for the specified node.
	loadChildren	Loads the child nodes for the specified node.
	loadChildrenEventHandler	Handles the event for lazy loading in the children of a node that is raised by the hierarchy designer control.
	loadDimensionHierarchyDesigner	Loads dimension hierarchy designer data to the tab page for editing.
	loadRootNodes	Loads the root nodes from the specified tree into the specified instance of the Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyDesigner class.
	makeDraft	Updates the specified designer and committed tree to draft mode if they are not already in draft mode.
	markForDelete	Marks the specified tab page for holding a deleted hierarchy.
	new	Initializes an instance of the DimensionHierarchyController class.
	nodeDescendentHasActiveDatesSet	Determines whether the specified DimensionTreeNode has any descendents with active dates set.
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	openAccountRule	Opens the account rule form, that displays only those account rules that are valid for current account structure.
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pageActivatedEventHandler	Handles the tab page activated event by storing the currently selected tab page.
	parmDimensionHierarchyId	Gets or sets the DimensionHierarchyId parameter.
	parmDuplicateButtonMenuItem	Gets the DuplicateButtonMenuItem parameter.
	parmIsAccountRuleDraft	Gets or sets the IsAccountRuleDraft parameter.
	parmIsAllReadOnly	Gets or sets the IsAllReadOnly parameter.
	parmIsCreateDimensionAllowed	Gets the IsCreateDimensionAllowed parameter.
	parmIsOptionalConstraintAllowed	Gets the IsOptionalConstraintAllowed parameter.
	parmSetActiveButtonVisibility	Gets the SetActiveButtonVisibility parameter.
	parmShowAccountRuleButton	Gets the ShowAccountRuleButton parameter.
	parmShowRelationshipsButton	Gets the ShowRelationshipsButton parameter.
	parmShowRenameButton	Gets the ShowRenameButton parameter.
	parmShowValidateButton	Gets the ShowValidateButton parameter.
	rename	Renames the specified designer and draft tree.
	renameHierarchyEventHandler	Handles the rename hierarchy event by renaming the current hierarchy.
	renameHierarchyOpenedEventHandler	Handles the rename hierarchy event by populating the current hierarchy name and description into the shortcut menu.
	restoreHierarchy	Restores the specified hierarchy.
	restoreHierarchyEventHandler	Handles the restore hierarchy event by reverting the draft state of the currently selected hierarchy.
	setActiveDates	Sets the active dates for the specified DimensionTree and Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyConstraintNode objects.
	setActiveDatesEventHandler	Handles the event to set the active dates that are raised by the hierarchy designer control.
	setErrorMessage	Sets or clears the error message of the specified node.
	setLabels	Sets the labels for the specified instance of the Microsoft.Dynamics.AX.Frameworks.Controls.Dimensions.HierarchyDesigner class.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	setTreeId	Sets the record ID of the associated tree for the specified designer.
	showConstraintNodeDesignerEventHandler	Handles the event that shows the constraint node designer raised by the hierarchy designer control.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	updateParentNodes	Updates the has error in descendant flag of parent nodes with the result of an operation in the tree.
	updateSiblingNodes	Updates the error messages of siblings with the result of an operation in the tree.
	updateTabPageCaption	Updates the caption of the specified tab page.
	updateTreeVersion	Updates the mapping between the original tree and the current version.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validateHierarchy	Validates the specified hierarchy.
	validateHierarchyEventHandler	Handles the validate event by running tree validation on the draft tree that is associated with the currently selected hierarchy.
	validateInterunit	Validates the interunit rules on a hierarchy assigned to the ledger.
	validateTreeVersion	Validates the current tree version is the same version first loaded.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::getErrorMessageForSibling	Retrieves the error message for the specified node.

Top

Inheritance Hierarchy

Object Class
  DimensionHierarchyController Class
    DimensionAccountRuleStructureController Class
    DimensionAccountStructureController Class