DictField Class [AX 2012]
The DictField class provides information about a specified field in a specified table.
| Method | Description | |
|---|---|---|
| aliasFor | Returns the ID of the alias field, if the field is an alias for another field. |
| alignment | |
| allowEdit | |
| allowEditOnCreate | |
| aosAuthorization | |
| arrayIndex | |
| arraySize | Returns the array size for the field (in other words, the array size of the underlying extended data type). |
| baseType | Returns the base type of the field, such as string, real, integer, date, time, enum, or container. |
| cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
| configurationKeyId | Returns the ID of the configuration key for the field. |
| dateTimeTimeZoneRuleFieldName | |
| displayHeight | |
| displayLength | |
| enumId | Returns the ID of the enumeration if the field is based on an enumeration. |
| equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
| flags | Returns an integer that defines the properties of the field. The flag values, such as DBF_MANDATORY, are defined in the DictField macro. |
| getCountryRegionCodes | |
| getCountryRegionContextField | |
| getPrimaryTableForSurrogateField | |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| groupPrompt | Returns the groupPrompt value for the field. |
| groupPromptDefined | Returns the value of the groupPrompt property for the field. |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| help | Returns the Help text that is displayed for the field. |
| helpDefined | Returns the value of the help property for the field. |
| id | Returns the ID of the field. |
| isIgnoreEDTRelation | |
| isMonocased | Returns a value that indicates whether the database requires that the field be monocase. |
| isSql | Returns a value that indicates whether the field is in the SQL database. |
| isSurrogateForeignKey | |
| isSystem | Returns a value that indicates whether the field is a system field. |
| label | Returns the label for the field. |
| labelDefined | Returns the value of the label property for the field. |
| mandatory | |
| name | Returns the name of the field. |
| new | Initializes a new instance of the Object 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.) |
| origin | |
| owner | Returns the instance that owns the object. (Inherited from Object.) |
| qualifiedLabel | |
| relatedTableName | |
| relationContext | |
| relationObject | Returns a DictRelation object for the field if the field is based on an extended data type that has a relation. |
| rights | Returns the access rights for the current user that are specified for the field. |
| setLookupMode | |
| setSFKAutoAuthorizationMode | |
| setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
| stringLen | Returns the string size of the field if the base type of the field is a string. |
| tableid | Returns the ID of the table that contains the field. |
| toString | Returns a string that represents the current object. (Inherited from Object.) |
| type | Returns the data type of the field. |
| typeId | Returns the ID of the extended data type if the field is based on an extended data type. |
| usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
| visible | |
| wait | Pauses a process. (Inherited from Object.) |
| xml | Returns an XML string that represents the current object. (Inherited from Object.) |
The following example shows how to create an instance of the DictField class to determine whether a field is mandatory.
#macrolib.dictfield
DictField df;
int nFlags;
df = new DictField(tablenum(CustTable), fieldnum(CustTable, AccountNum));
if (df)
{
nFlags = df.flags();
if (bitTest(nFlags,#DBF_MANDATORY))
{
print ("The field is mandatory.");
}
else
{
print ("The field is not mandatory.");
}
}
Community Additions
ADD
Show: