Share via


DictField Class

The DictField class provides information about a specified field in a specified table.

Syntax

class DictField extends Object

Run On

Called

Methods

  Method Description
Gg822960.pubmethod(en-us,AX.60).gif aliasFor Returns the ID of the alias field, if the field is an alias for another field.
Gg822960.pubmethod(en-us,AX.60).gif alignment
Gg822960.pubmethod(en-us,AX.60).gif allowEdit
Gg822960.pubmethod(en-us,AX.60).gif allowEditOnCreate
Gg822960.pubmethod(en-us,AX.60).gif aosAuthorization
Gg822960.pubmethod(en-us,AX.60).gif arrayIndex
Gg822960.pubmethod(en-us,AX.60).gif arraySize Returns the array size for the field (in other words, the array size of the underlying extended data type).
Gg822960.pubmethod(en-us,AX.60).gif baseType Returns the base type of the field, such as string, real, integer, date, time, enum, or container.
Gg822960.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif configurationKeyId Returns the ID of the configuration key for the field.
Gg822960.pubmethod(en-us,AX.60).gif dateTimeTimeZoneRuleFieldName
Gg822960.pubmethod(en-us,AX.60).gif displayHeight
Gg822960.pubmethod(en-us,AX.60).gif displayLength
Gg822960.pubmethod(en-us,AX.60).gif enumId Returns the ID of the enumeration if the field is based on an enumeration.
Gg822960.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif flags Returns an integer that defines the properties of the field. The flag values, such as DBF_MANDATORY, are defined in the DictField macro.
Gg822960.pubmethod(en-us,AX.60).gif getCountryRegionCodes
Gg822960.pubmethod(en-us,AX.60).gif getCountryRegionContextField
Gg822960.pubmethod(en-us,AX.60).gif getPrimaryTableForSurrogateField
Gg822960.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif groupPrompt Returns the groupPrompt value for the field.
Gg822960.pubmethod(en-us,AX.60).gif groupPromptDefined Returns the value of the groupPrompt property for the field.
Gg822960.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif help Returns the Help text that is displayed for the field.
Gg822960.pubmethod(en-us,AX.60).gif helpDefined Returns the value of the help property for the field.
Gg822960.pubmethod(en-us,AX.60).gif id Returns the ID of the field.
Gg822960.pubmethod(en-us,AX.60).gif isIgnoreEDTRelation
Gg822960.pubmethod(en-us,AX.60).gif isMonocased Returns a value that indicates whether the database requires that the field be monocase.
Gg822960.pubmethod(en-us,AX.60).gif isSql Returns a value that indicates whether the field is in the SQL database.
Gg822960.pubmethod(en-us,AX.60).gif isSurrogateForeignKey
Gg822960.pubmethod(en-us,AX.60).gif isSystem Returns a value that indicates whether the field is a system field.
Gg822960.pubmethod(en-us,AX.60).gif label Returns the label for the field.
Gg822960.pubmethod(en-us,AX.60).gif labelDefined Returns the value of the label property for the field.
Gg822960.pubmethod(en-us,AX.60).gif mandatory
Gg822960.pubmethod(en-us,AX.60).gif name Returns the name of the field.
Gg822960.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Overrides the new Method.)
Gg822960.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.)
Gg822960.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.)
Gg822960.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif origin
Gg822960.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif qualifiedLabel
Gg822960.pubmethod(en-us,AX.60).gif relatedTableName
Gg822960.pubmethod(en-us,AX.60).gif relationContext
Gg822960.pubmethod(en-us,AX.60).gif relationObject Returns a DictRelation object for the field if the field is based on an extended data type that has a relation.
Gg822960.pubmethod(en-us,AX.60).gif rights Returns the access rights for the current user that are specified for the field.
Gg822960.pubmethod(en-us,AX.60).gif setLookupMode
Gg822960.pubmethod(en-us,AX.60).gif setSFKAutoAuthorizationMode
Gg822960.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif stringLen Returns the string size of the field if the base type of the field is a string.
Gg822960.pubmethod(en-us,AX.60).gif tableid Returns the ID of the table that contains the field.
Gg822960.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif type Returns the data type of the field.
Gg822960.pubmethod(en-us,AX.60).gif typeId Returns the ID of the extended data type if the field is based on an extended data type.
Gg822960.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.)
Gg822960.pubmethod(en-us,AX.60).gif visible
Gg822960.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg822960.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)

Top

Examples

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."); 
    } 
 
}

Inheritance Hierarchy

Object Class
  DictField Class
    SysDictField Class

See Also

DictTable Class

DictType Class