LedgerDimensionController Class [AX 2012]
The LedgerDimensionController class is used as a base for specialized classes that use the segmented entry control for transaction entry.
| Method | Description | |
|---|---|---|
| addCombinationToMRU | Adds the current combination to an instance of the DimensionMRUProvider class. |
| addExcludedDimensionValues | Adds the provided dimension value exclusion set to the existing set. |
| addHierarchyCombinationToMRU | Adds the specified combination of values to the most recently used list for the specified hierarchy. |
| addSegmentToControl | Adds the specified segment to the control. |
| applyBothPagingAndAutoFilterRanges | Applies both paging and auto filter ranges on the supplied backing entity datasource. |
| applyDimensionAttributeValuesRestriction | Restricts dimension attribute values based on the total, suspended and inactive date range. |
| applyOnlyAutoFilterRange | Applies only auto filter ranges on the supplied backing entity datasource. |
| applyOnlyPagingRange | Applies only paging ranges on the supplied backing entity datasource. |
| applyPagingAndAutoFilterRanges | Applies paging and auto filter ranges on the supplied backing entity datasource. |
| applyPagingAndAutoFilterRangesLanguage | Applies paging and auto filter ranges on the supplied backing entity datasource when there is a dimension value language id. |
| buildExcludedDimensionValues | Builds the excluded dimension values set. |
| cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
| canPerformValidValuesQuery | Determines whether a valid values query can be performed for the specified dimension attribute. |
| checkForBlockedValue | Determines whether the specified value is blocked and cannot be entered. (Inherited from DimensionController.) |
| clearInvalidSegment | Clears the specified control segment, marks it as invalid, and prevents the user from leaving the segment. (Inherited from DimensionController.) |
| clearReference | Clears the record ID of the DimensionAttributeValueCombination record that is referenced by the dialog field or the table field and reloads a blank control. (Inherited from DimensionController.) |
| clearTrackingArrays | Clears the arrays for tracking dimension attributes in the control and dimension storage. |
| control_segmentEntered | Explicitly implemented segmented entry control segmentEntered method not to require the method to be specified at design time on all uptake forms. (Overrides the control_segmentEntered Method.) |
| DimensionLinkAllowFieldEdit | Rises when a field is being made editable for a specified dimension attribute. (Inherited from DimensionControllerObject.) |
| 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.) |
| displayStructureChangedMessage | Displays the message to inform the user that the structure has changed. |
| doIncludeSuspendedDimAttributeValues | Determines whether the suspended dimension attribute values are included in the lookup. |
| doIncludeTotalDimAttributeValues | Determines whether the total dimension attribute values are included in the lookup. |
| equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
| getAccountStructure | Retrieves the current account structure. (Inherited from DimensionController.) |
| getAttributeValueSet | Gets a container of all dimension attribute values and backing entity instances for the specified value set. (Inherited from DimensionControllerObject.) |
| getAutoCompleteAllQuery | Adds the appropriate restrictions to retrieve all the AutoComplete fields from the database. |
| getAutoCompleteDataFromDatabase | Retrieves the appropriate the AutoComplete from the database. |
| getAutoCompleteDataFromMRU | Retrieves the appropriate the AutoComplete field from the most recently used provider. |
| getAutoCompleteValidQuery | Adds the appropriate restrictions to retrieve all valid the AutoComplete field from the database. |
| getCombinationsForMRU | Retrieves a map of the current combination formatted for storage in the DimensionMRUProvider object. |
| getControlIndexByDimensionAttribute | Retrieves the index in the control of the specified dimension attribute. |
| getDimAttributeValueRestrictionDate | The date by which the dimension attribute values need to be restricted to. |
| getDimAttributeViewContract | Gets an instance of the DimensionAttributeViewContract class for the specified dimension attribute record ID. |
| getDimensionAttributeByControlIndex | Retrieves the dimension attribute ID of the specified index in the control. |
| getDimensionAttributeValue | |
| getReference | Gets the record ID of the DimensionAttributeValueCombination record that is referenced by the dialog field or the table field. (Inherited from DimensionController.) |
| getSegmentNames | Retrieves an array of the dimension attribute names for each segment that is displayed in the control. |
| getStorageIndexArrayByDimensionAttribute | Retrieves an array that contains the indexes where the specified dimension attribute is used in the DimensionStorage object. |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| getValue | Gets the value of the specified dimension attribute. (Overrides the getValue Method.) |
| getValuesForHierarchyFromMRU | Gets the most recently used values for a specified segment based on the segment values that have been entered. |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| hasValue | |
| isAccountStructureForced | Indicates whether to only search for values for the current account structure before the point of disambiguation. |
| isControlEmpty | Indicates whether the control is empty. |
| jumpRef | Uses the currently selected segment to provide functionality to go to main table to start the correct backing form in edit mode. (Overrides the jumpRef Method.) |
| jumpRefDialogField | Jumps to the dialog field when the dialog fields are dynamically added at runtime. (Inherited from DimensionController.) |
| loadAutoCompleteData | Retrieves the AutoComplete data for segment lookup purposes. (Inherited from DimensionController.) |
| loadAutoCompleteDataDialogField | Jumps to the dialog field when the dialog fields are dynamically added at runtime. (Inherited from DimensionController.) |
| loadEmptySegments | Allows subclasses to define the behavior of the control when an identifier of a DimensionAttributeValueComination record is not provided. |
| loadFromDimensionHierarchy | |
| loadFromDimensionStorage | Loads an instance of the DimensionStorage class into the control. (Overrides the loadFromDimensionStorage Method.) |
| loadFromDimensionStorageSegments | |
| loadFromDimensionStructureInformation | |
| loadSegments | Loads a previously stored DimensionAttributeValueComination record into the control. (Overrides the loadSegments Method.) |
| loadSegmentsDialogField | Loads the segments from the specified FormSegmentedEntryControl object. (Inherited from DimensionController.) |
| new | Initializes a new instance of the LedgerDimensionController class. (Overrides the new Method.) |
| 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.) |
| owner | Returns the instance that owns the object. (Inherited from Object.) |
| parmControl | Gets or sets the Control parameter. (Overrides the parmControl Method.) |
| parmDataAreaId | Gets or sets the DataAreaId parameter. (Overrides the parmDataAreaId Method.) |
| parmDataSource | Sets a reference to the data source and field name that link to a DimensionAttributeValueCombination table. (Overrides the parmDataSource Method.) |
| parmDate | Gets or sets the Date parameter. |
| parmDialogField | Sets a reference to and initializes the override methods on the DialogField class that contain a value reference to a DimensionAttributeValueCombination record. (Inherited from DimensionController.) |
| parmDimensionAccountStorageUsage | Gets or sets the DimensionAccountStorageUsage parameter. |
| parmDimensionAutocompleteFilter | Gets or sets the DimensionAutocompleteFilter parameter. |
| parmDisableMRU | Gets or sets the DisableMRU parameter. (Inherited from DimensionController.) |
| parmIsChildController | Checks whether the controller is a root-level controller or a child-level controller. (Inherited from DimensionController.) |
| parmProcessExcludedDAVLedgerOverrides | Gets or sets the ProcessExcludedDAVLedgerOverrides parameter. |
| parmSkipSuspendedAndActiveDateValidation | Gets or sets the SkipSuspendedAndActiveDateValidation parameter. (Inherited from DimensionController.) |
| parmValidateBlockedForManualEntry | Gets or sets the ValidateBlockedForManualEntry parameter. (Inherited from DimensionController.) |
| raiseSetFieldValueForDimensionStorage | Raises the DimensionLinkSetFieldValue event for each value in the DimensionStorage object. |
| removeCombinationFromMRU | Removes the current combination from the instancec of the DimensionMRUProvider class. |
| removeHierarchyCombinationFromMRU | Removes the specified combination of values from the most recently used list for the specified hierarchy. |
| resolveReference | Saves the current combination. (Overrides the resolveReference Method.) |
| resolveReferenceDialogField | Saves the segmented value combination. (Inherited from DimensionController.) |
| retrieveDimensionHierarchy | Loads a dimension hierarchy into the control when the exact hierarchy to use is not known. |
| segmentValueChanged | Updates the controller when the value of a segment changes. (Inherited from DimensionController.) |
| segmentValueChangedDialogField | Updates the controller when the value of a segment changes. (Inherited from DimensionController.) |
| setDataAreaId | Sets an instance of the DataAreaId class that is used by the controller. (Overrides the setDataAreaId Method.) |
| setDimensionSpecifierValues | Sets the current dimension values that are based on the specified values. |
| setDimensionStorageSegments | Sets the DimensionStorageSegment objects backing the specified control segment with the specified value. |
| setReference | Sets the record ID of the DimensionAttributeValueCombination referenced by the dialog field or table field. (Inherited from DimensionController.) |
| setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
| setValue | Sets the value of the specified control segment by using the specified DimensionAttributeValue record. |
| setValues | Sets the current dimension values, depending on the specified set. |
| toString | Returns a string that represents the current object. (Inherited from Object.) |
| updateStorageForStructureChange | |
| usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
| validate | Validates the current combination. (Overrides the validate Method.) |
| validateCombination | Determines the DimensionValidationStatus enumeration value for the dimension value combination currently in the control. |
| validateDialogField | Validates the fields. (Inherited from DimensionController.) |
| validateUsedDimensionAttributeValue | Validates the specified dimension attribute value. |
| wait | Pauses a process. (Inherited from Object.) |
| xml | Returns an XML string that represents the current object. (Inherited from Object.) |
| ::applyTotalSuspendedDateRanges | Restricts the query to dimension attribute values that meet the specified criteria. |
| ::doRestrictQueryToTreeValuesForHierarchy | Determines whether restrictions are to be applied from the specified hierarchy. |
| ::getExcludedValuesFromDAVLedgerOverride | Builds a Set containing the dimension value record ID's which need to be excluded from the lookup. |
| ::getFilterSuspendTotalDateQueryCriteria | Generates the query range criteria for filtering suspended, total and inactive date dimension attribute values. |
| ::getLastPagedValue | Retrieves the last paged value from the tag on the specified tag. |
| ::getStorageAndStructure | Gets an instance of the DimensionStorage and DimensionStructureInformation classes that are associated with the specified ID. |
| ::getStructureForDimensionStorage | Gets the structural information for the specified dimension storage instance. |
| ::restrictQueryDimensionAttributeValues | Restricts the query to dimension attribute values that meet the specified criteria. |
| ::restrictQueryForRelationshipConstraints | Restricts the query to dimension attribute values that are based on the relationships for the current account structure. |
| ::restrictQueryToCategorizedValues | Restricts the query to dimension attribute values for the category associated with the specified dimension attribute. |
| ::restrictQueryToTreeValues | Restricts the query to dimension attribute values by using the constraint trees. |
| ::restrictQueryToTreeValuesForHierarchy | Restricts the query to dimension attribute values by using the constraint trees for the specfied hierarchy. |
Community Additions
ADD
Show: