PrintMgmtSetupDocInstance Class [AX 2012]
The PrintMgmtSetupDocInstance class represents a collection of settings for a generated document.
| Method | Description | |
|---|---|---|
| addConditionalSetting | Adds a conditional setting. |
| canAddChild | Determines whether adding a child is permitted. |
| cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
| deepCopy | Creates a new copy of the document instance and all its members. |
| delete | Deletes the document instance. |
| deleteHigherInstanceDoc_BR | |
| equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
| findNonInherited | Finds the non-inherited ancestor for an inherited document instance. |
| getConditionalSettingByName | Retrieves a conditional setting by its name. |
| getConditionalSettingByPos | Gets a conditional setting by its position. |
| getConditionalSettingPos | Gets the position of a conditional setting. |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| initFromRec | Initializes a document instance from its persisted state. |
| moveConditionalSetting | Moves a conditional setting in the collection. |
| new | Creates a new instance of the PrintMgmtSetupDocInstance 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.) |
| numConditionalSettings | Retrieves the count of conditional settings. |
| objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
| owner | Returns the instance that owns the object. (Inherited from Object.) |
| parmBlockOverride_BR | Gets or sets the BlockOverride_BR parameter. |
| parmDefaultSetting | Gets the DefaultSetting parameter. |
| parmDepth | Gets the Depth parameter. |
| parmIsLeaf | Gets the IsLeaf parameter. |
| parmName | Gets or sets the Name parameter. |
| parmParent | Gets or sets the Parent parameter. |
| parmPriority | Gets the Priority parameter. |
| parmRecId | Gets the RecId parameter. |
| parmRecVersion | Gets or sets the RecVersion parameter. |
| parmSource | Gets or sets the Source parameter. |
| parmSuppress | Gets or sets the Suppress parameter. |
| parmType | Gets or sets the Type parameter. |
| refresh | Refreshes data from the underlying table. |
| removeConditionalByName | Removes the conditional setting based on the specified name parameter. |
| save | Saves the state of the document instance. |
| saveTableFields | |
| setDefaultSettings | Sets the default setting for this document instance. |
| setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
| shallowCopy | Creates another document instance that refers to the same underlying values. |
| swapPriority | Microsoft internal use only. |
| toString | Returns a string that represents the current object. (Inherited from Object.) |
| 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.) |
| ::construct | Creates a new document instance where one did not previously exist. |
| ::constructFromRec | Creates a document by using values from the persisted state. |
| ::constructRec | Creates a new record for a document instance. |
| ::constructRecOnServer | |
| ::deepCopyOnServer | Creates a new copy of the document instance and all of the members by running on the server tier. |
| ::deleteHigherInstanceDocOnServer_BR | Deletes all the document instances that overrides the current one |
| ::deleteOnServer | |
| ::nextName | Generates an available name based on a prefix and sequence number. |
| ::nextPriorityId | Retrieves the next priority number available for a document instance. |
| ::parmMaxChildren | Provides the maximum number of children permitted. |
| ::saveOnServer | |
| ::swapPriorityOnServer |
There are three sources of document instances:
-
Inherited - an instance from a higher level in the hierarchy
-
Override - an instance that matches (by name) another instance higher in the hierarchy
-
New - an instance that does not exist (based on name) at any higher level in the hierarchy
There are two types of the settings associated with a document instance:
-
Conditional - used based on evaluation of a query in the condition property
-
Default - used if "use default" is marked and no conditional setting is used
The order of conditional settings is significant. The first setting with a condition property which selects a record is used.