DictField Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The DictField class provides information about a specified field in a specified table.
public ref class DictField : Microsoft::Dynamics::Ax::Xpp::XppObjectBase[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class DictField : Microsoft.Dynamics.Ax.Xpp.XppObjectBase[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type DictField = class
inherit XppObjectBasePublic Class DictField
Inherits XppObjectBase- Inheritance
- Derived
- Attributes
Remarks
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.");
}
}
Constructors
| DictField() | |
| DictField(Int32, Int32) | |
| DictField(Int32, Int32, Int32) | |
| DictField(IntPtr) |
Fields
| __k_DictFieldId | |
| kernelClass | (Inherited from XppObjectBase) |
Methods
| __shouldCallNew(Type) | |
| addXppProxyReference(Type, Object) | (Inherited from XppObjectBase) |
| 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. |
| Call(String, Object[], Type[], Object[]) | (Inherited from XppObjectBase) |
| cancelTimeOut(Int32) | (Inherited from XppObjectBase) |
| configurationKeyId() |
Returns the ID of the configuration key for the field. |
| createKernelClass(Object[], Type[], Object[]) | (Inherited from XppObjectBase) |
| dateTimeTimeZoneRuleFieldName() | |
| dateTimeTimeZoneRuleFieldName(Int32) | |
| displayHeight() | |
| displayHeight(Boolean) | |
| displayLength() | |
| displayLength(Boolean) | |
| enumId() |
Returns the ID of the enumeration if the field is based on an enumeration. |
| equal(XppObjectBase) | (Inherited from XppObjectBase) |
| finalize() | (Inherited from XppObjectBase) |
| flags() |
Returns an integer that defines the properties of the field. The flag values, such as DBF_MANDATORY, are defined in the DictField macro. |
| flags(String) | |
| flags(String, Common) | |
| getCountryRegionCodes() | |
| getCountryRegionContextField() | |
| getFeatureClassName() | |
| GetIntPtr() | (Inherited from XppObjectBase) |
| GetKernelInstanceUniqueId() | (Inherited from XppObjectBase) |
| getPrimaryTableForSurrogateField() | |
| getTimeOutTimerHandle() | (Inherited from XppObjectBase) |
| getXppProxyReference(Type) | (Inherited from XppObjectBase) |
| groupPrompt() |
Returns the groupPrompt value for the field. |
| groupPromptDefined() |
Returns the value of the groupPrompt property for the field. |
| handle() | |
| help() |
Returns the Help text that is displayed for the field. |
| help(Int32) | |
| help(Int32, Boolean) | |
| helpDefined() |
Returns the value of the help property for the field. |
| id() |
Returns the ID of the field. |
| isIgnoreEDTRelation() | |
| IsManagedValid() | (Inherited from XppObjectBase) |
| 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. |
| kernelhandle() | |
| KernelInstanceDisposed() | (Inherited from XppObjectBase) |
| label() |
Returns the label for the field. |
| label(Int32) | |
| labelDefined() |
Returns the value of the label property for the field. |
| MakeReflectionCall(String, Object[]) | (Inherited from XppObjectBase) |
| mandatory() | |
| name() |
Returns the name of the field. |
| name(DbBackend) | |
| name(DbBackend, Int32) | |
| name(DbBackend, Int32, FieldNameGenerationMode) | |
| name(DbBackend, Int32, FieldNameGenerationMode, String) | |
| newmethod() | (Inherited from XppObjectBase) |
| newmethod(Int32, Int32) |
Initializes a new instance of the Object class. |
| newmethod(Int32, Int32, Int32) | |
| notify() | (Inherited from XppObjectBase) |
| notifyAll() | (Inherited from XppObjectBase) |
| objectOnServer() |
Obsolete.
(Inherited from XppObjectBase)
|
| origin() | |
| qualifiedLabel() | |
| qualifiedLabel(Int32) | |
| relatedTableName() | |
| relationContext() | |
| relationObject() |
Returns a DictRelation object for the field if the field is based on an extended data type that has a relation. |
| relationObject(Int32) | |
| rights() |
Returns the access rights for the current user that are specified for the field. |
| rights(Boolean) | |
| setLookupMode(Boolean) | |
| setSFKAutoAuthorizationMode(Boolean) | |
| setTimeOut(String, Int32) |
Obsolete.
(Inherited from XppObjectBase)
|
| setTimeOut(String, Int32, Boolean) |
Obsolete.
(Inherited from XppObjectBase)
|
| 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. |
| 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() | (Inherited from XppObjectBase) |
| VerifyKernelClass() | (Inherited from XppObjectBase) |
| visible() | |
| wait() | (Inherited from XppObjectBase) |
| Xml() | (Inherited from XppObjectBase) |
| Xml(Int32) | (Inherited from XppObjectBase) |