DimensionDefaultingControllerBase Class [AX 2012]

The DimensionDefaultingController class manages the display, user interaction, and storage of default dimension check boxes, combo boxes, and values.

Syntax

class DimensionDefaultingControllerBase extends DimensionControllerObject

Run On

Called

Methods

	Method	Description
	addControlToRootContainer	Adds a new control inside the root container.
	addEditControls	Adds the appropriate edit controls to each dimension attribute line in the correct order.
	addEnumControl	Adds the appropriate enumeration control to a dimension attribute line.
	allowEditRootContainer	Allows or disallows the ability to edit the root container.
	cacheSetupOptions	Caches options to use later to add all of the controls to the container.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	dimensionCheckbox_enter	Explicitly implemented dimensionCheckbox field enter method as this field is dynamically added at runtime, no method can be specified at design time.
	dimensionCheckbox_modified	Explicitly implemented dimensionCheckbox field modified method as this field is dynamically added at runtime, no method can be specified at design time.
	dimensionComboBox_enter	Explicitly implemented dimensionComboBox field enter method as this field is dynamically added at runtime, no method can be specified at design time.
	dimensionComboBox_modified	Explicitly implemented dimensionComboBox field modified method as this field is dynamically added at runtime, no method can be specified at design time.
	DimensionLinkAllowFieldEdit	Rises when a field is being made editable for a specified dimension attribute. (Inherited from DimensionControllerObject.)
	dimensionLinkChangeEnumValue	Rises when an enumeration value is being changed for a specified dimension attribute.
	DimensionLinkMarkFieldOptional	Rises when a field is being made optional for a specified dimension attribute. (Inherited from DimensionControllerObject.)
	DimensionLinkSetFieldValue	Rises when a field value is being set for a specified dimension attribute. (Inherited from DimensionControllerObject.)
	DimensionLinkShowField	Rises when a field is being shown for a specified dimension attribute. (Inherited from DimensionControllerObject.)
	dimensionValue_enter	Explicitly implemented dimensionValue field enter method as this field is dynamically added at runtime, no method can be specified at design time.
	dimensionValue_jumpRef	Provides the go to main table functionality and starts the correct backing form in edit mode with the currently selected value.
	dimensionValue_lookup	Provides the look-up interaction for the individual dimension attribute lookup controls.
	dimensionValue_modified	Explicitly implemented dimensionValue field modified method as this field is dynamically added at runtime, no method can be specified at design time.
	dimensionValueName_enter	Explicitly implemented dimensionValueName field enter method as this field is dynamically added at runtime, no method can be specified at design time.
	ensureControlExists	Ensures the specified dimension control exists in cases where it has not already been created.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	findValueRecIds	Gathers the record IDs of DimensionAttributeValue records before a save, which will not be set when a user enters a new value instead of using a lookup.
	getAttributeSetStorage	Retrieves the dimension attribute storage set that represents the check boxes or combo boxes that the user has selected.
	getAttributeValueSet	Gets a container of all dimension attribute values and backing entity instances for the specified value set. (Inherited from DimensionControllerObject.)
	getAttributeValueSetStorage	Retrieves the dimension attribute value storage set that represents the value controls that the user has selected.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	groupWhereUsed_mouseUp	Explicitly implemented groupWhereUsed field mouseUp method as this field is dynamically added at runtime, no method can be specified at design time.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	handleCheckboxOrComboBoxModified	Caches the change and notifies the parent data source that an enumeration was changed.
	handleFieldEnter	Caches the current control that is entered and optionally updates the where used pane.
	handleValueEnablementForEnumValue	Specifies whether to allow for values to be edited when associated with a change in a enumeration value.
	handleValueModified	Processes the direct entry of a value string.
	loadAttributeSet	Loads the dimension attribute set and populates the check boxes or combo boxes.
	loadAttributeValueSet	Loads the dimension attribute value set and populates the value controls from the saved state.
	lockRootContainer	Locks or unlocks a root container.
	new	Creates a new instance of the DimensionDefaultingController class.
	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.)
	notifyEnumsChanged	Indicates that the check boxes or combo boxes have changed.
	notifyValuesChanged	Indicates that the values have changed.
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pageActivated	Adds all of the controls required by using the constructor and settings specified.
	parmDisplayedDimensionSet	Gets or sets the DisplayedDimensionSet parameter.
	parmIncludeMainAccount	Gets or sets the IncludeMainAccount parameter.
	parmValidateBlockedForManualEntry	Gets or sets the ValidateBlockedForManualEntry parameter.
	reactivate	Removes all controls and reactivates with new controls
	removeWhereUsed	Removes the where used control containers.
	saveAttributeSet	Writes the dimension attribute set that represents the check boxes or combo boxes that the user has selected.
	saveAttributeValueSet	Writes the dimension attribute value set that represents the value controls that the user has selected.
	setAdditionalControlMetadata	Sets additional control metadata that is common to all controls.
	setDimensionAttributeValue	Sets the record ID and natural key string of a record in the DimensionAttributeValue table for the specified dimension attribute.
	setEditability	Updates the status of all visible controls to be enabled or disabled based on a specific editable list of the dimension attribute table.
	setName	Updates the value name field.
	setNonActiveValueTolerance	Specifies the action to perform when the dimension attribute value is entered that is non-active based on the isSuspended field or the range of values in the ActiveFrom and ActiveTo field and the specified date.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	setupEditAreaControls
	setValue	Sets the natural key string and, optionally, the record ID of a DimensionAttributeValue record for the specified DimensionAttribute record.
	setValueData	Updates the value and name fields and internal tracking value and key fields when a value is set or cleared.
	setValueEditabilityForEnums	Specifies a map of enumeration values associated with a Boolean value that indicates whether the associated value can be edited.
	showWhereUsedForAttributeIndex	Updates the where used group super structure by removing any information that already shows and repopulates it with the current information.
	taxBranchChanged	Changes the tax branch.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	updateEnums	Updates the status of the enumeration-based controls to be enabled or disabled and to be set to a specific value.
	updateValues	Updates the status of the value controls to enabled or disabledand whether it should be cleared.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::addHeaderControl	Adds a header control to label the column of form controls that are added underneath it.
	::fillWhereUsedGroup	Updates the where used group for the specified structure type.
	::findBackingEntityInstance	Retrieves a Common table that contains an instance of the backing entity requested by either the surrogate key or natural key.
	::getActiveOrDraftStructures	Retrieves a container that represents a list of all active and draft structures that the specified dimension attribute exists in for either account structures or account rule structures.
	::getAllStructures	Retrieves a container that contains 2 lists of all active and draft structures that the specified dimension attribute exists in for both account structures and account rule structures.
	::getSiblingsOfStructure	Gets a container of the siblings of a DimensionAttribute that are in a DimensionHierarchy.

Top

Inheritance Hierarchy

Object Class
  DimensionControllerObject Class
    DimensionDefaultingControllerBase Class
      DimensionDefaultingController Class
      DimensionDefaultingControllerNoDS Class
      PdsDimensionSelectionController Class