EventBuildValidAlertFields Class [AX 2012]

The EventBuildValidAlertFields class is used to build a temporary TmpEventAlertField table that holds a record for each valid control in the specified FormRun on the dataset specified by the FormDataSource.

Syntax

class EventBuildValidAlertFields

Run On

Client

Methods

  Method Description
Gg758592.protmethod(en-us,AX.60).gif addEntireTableEntry
Gg758592.protmethod(en-us,AX.60).gif build This is the central method of the class holding the bulk of the run method. This includes initialization, traversing formRun controls, and post treatment of the inserted records.
Gg758592.protmethod(en-us,AX.60).gif buildRecursive Recursively traverses all FormControls in the FormRun. For each control that is hosting an actual database field, the method will insert a record in the TmpEventAlertField table if the control is valid and refers to the specified FormDataSource.
Gg758592.protmethod(en-us,AX.60).gif buildTypes
Gg758592.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif containerHasValidLabel Decides whether the specified FormControl has an appropriate label for context-qualifying a field control.
Gg758592.pubmethod(en-us,AX.60).gif controlId2TmpEventAlertField Converts the ID of a FormControl into its corresponding TmpEventAlertField record.
Gg758592.pubmethod(en-us,AX.60).gif entireTable2TmpEventAlertField
Gg758592.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif first2TmpEventAlertField
Gg758592.pubmethod(en-us,AX.60).gif formDataSourceMap
Gg758592.protmethod(en-us,AX.60).gif getFieldLabel Gets the field label for the specified form control.
Gg758592.protmethod(en-us,AX.60).gif getFormControlArrIdx Retrieves the field array index from a FormControl.
Gg758592.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif init Initializes the class instance and allocates the internal storage structures.
Gg758592.protmethod(en-us,AX.60).gif insertField Inserts a record in the TmpEventAlertField table.
Gg758592.protmethod(en-us,AX.60).gif isControlBasedOnValidRecord Tests whether a FormControl is displaying data from a valid record.
Gg758592.protmethod(en-us,AX.60).gif isControlDateEffective Checks whether the FormControl object is date-effective.
Gg758592.protmethod(en-us,AX.60).gif isControlInCurDataset Tests whether the FormControl is in the current dataset.
Gg758592.protmethod(en-us,AX.60).gif isControlValid Checks whether a FormControl must be represented by using a record in the TmpEventAlertField table.
Gg758592.protmethod(en-us,AX.60).gif isControlValidDatabaseBound Checks whether the FormControl is bound to an actual and valid database field.
Gg758592.protmethod(en-us,AX.60).gif isControlVisible Checks whether the FormControl is visible to the user.
Gg758592.protmethod(en-us,AX.60).gif isDimensionCheckBoxField
Gg758592.protmethod(en-us,AX.60).gif isDimensionComboBoxField
Gg758592.protmethod(en-us,AX.60).gif isDimensionDefaultField
Gg758592.protmethod(en-us,AX.60).gif isDimensionField
Gg758592.pubmethod(en-us,AX.60).gif isPseudoCursor
Gg758592.pubmethod(en-us,AX.60).gif label2TmpEventAlertField Use this method to convert a field label, a UI-hosted name for a FormControl, to its corresponding TmpEventAlertField.
Gg758592.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif nonFieldRelatedTmpEventAlertField
Gg758592.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif parmFindFirstOnly Gets or sets the FindFirstOnly parameter.
Gg758592.pubmethod(en-us,AX.60).gif parmFormDataSource Gets or sets the FormDataSource parameter.
Gg758592.pubmethod(en-us,AX.60).gif parmFormRun Gets or sets the FormRun parameter.
Gg758592.pubmethod(en-us,AX.60).gif parmTmpEventAlertField Gets or sets the TmpEventAlertField parameter.
Gg758592.pubmethod(en-us,AX.60).gif run Contains the actual updating processing of the class. The only exception from the standard implementation is that this method will not throw an error if validate returns false.
Gg758592.protmethod(en-us,AX.60).gif setAggFieldsMap Builds a Map Class where each of the FormDataSources of the current dataset are mapped to a Set class that contains all aggregated fields in the corresponding database pointer.
Gg758592.protmethod(en-us,AX.60).gif setDataSourceMap Collects all FormDataSources from a dataset in a Map. The ID of the FormDataSource is mapped to the actual instance.
Gg758592.protmethod(en-us,AX.60).gif setInvalidTableSet
Gg758592.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg758592.protmethod(en-us,AX.60).gif setUniquePostfix Adds a post-fix to duplicate field labels so that users can distinguish between them.
Gg758592.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif validate
Gg758592.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg758592.pubmethod(en-us,AX.60).gif Gg758592.static(en-us,AX.60).gif ::buildTypesServer
Gg758592.pubmethod(en-us,AX.60).gif Gg758592.static(en-us,AX.60).gif ::construct Initializes a new instance of the EventBuildValidAlertFields class.
Gg758592.pubmethod(en-us,AX.60).gif Gg758592.static(en-us,AX.60).gif ::description Gets the description of the class.
Gg758592.pubmethod(en-us,AX.60).gif Gg758592.static(en-us,AX.60).gif ::isControlTypeValid
Gg758592.pubmethod(en-us,AX.60).gif Gg758592.static(en-us,AX.60).gif ::newFormDataSource

Top

Remarks

The result of the Run method; that is, the temporary table can be retrieved by calling the EventBuildValidAlertFields.parmTmpEventAlertField method.

Only controls that are valid for creating Rules qualify.

The class contains the logic to determine whether a control is valid for creating Rules.

Examples

void MyMethod(FormRun _formRun, FormDataSource _fds) 
{ 
    EventBuildValidAlertFields e =  
        EventBuildValidAlertFields::newFormDataSource(_formRun,_fds); 
    TmpEventAlertField         t; 
 
    t.setTmpData(e.parmTmpEventAlertField()); 
    while select t 
    { 
       // Print field names. 
       print t. refFieldName;  
    } 
}

Inheritance Hierarchy

Object Class
  EventBuildValidAlertFields Class

See Also

TmpEventAlertField Table