DictTable Class

  • Article
  • 6 minutes to read

The DictTable class provides information about a table.

Syntax

class DictTable extends Object

Run On

Called

Methods

  Method Description
Gg842579.pubmethod(en-us,AX.60).gif AOSAuthSetting Retrieves an AOSAuthorization system enumeration value that specifies the type of operation that a user can perform on a table, depending on the permissions of the user.
Gg842579.pubmethod(en-us,AX.60).gif cacheLookup Returns the record cache level for the table.
Gg842579.pubmethod(en-us,AX.60).gif cacheSize Returns the cache size for the table, in the number of records.
Gg842579.pubmethod(en-us,AX.60).gif callObject Calls the specified object method for a table.
Gg842579.pubmethod(en-us,AX.60).gif callStatic Calls the specified static method for a table.
Gg842579.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif clusterIndex Returns the ID of the clustered index for the table.
Gg842579.pubmethod(en-us,AX.60).gif configurationKeyId Returns the ID of the configuration key for the table.
Gg842579.pubmethod(en-us,AX.60).gif dataPerPartition Returns a value that indicates whether the data of the table is saved on a per-partition basis, and corresponds to the SaveDataPerPartition property of the table.
Gg842579.pubmethod(en-us,AX.60).gif dataPrCompany Returns a value that indicates whether the data of the table is saved on a per-company basis, and corresponds to the SaveDataPerCompany property of the table.
Gg842579.pubmethod(en-us,AX.60).gif deleteActionCnt Retrieves the number of delete actions for the table.
Gg842579.pubmethod(en-us,AX.60).gif deleteActionRelation
Gg842579.pubmethod(en-us,AX.60).gif deleteActionTableId Returns the table ID of a table's delete action that is specified by an index.
Gg842579.pubmethod(en-us,AX.60).gif deleteActionType Retrieves the type of a delete action for a table.
Gg842579.pubmethod(en-us,AX.60).gif developerDocumentation
Gg842579.pubmethod(en-us,AX.60).gif developerDocumentationLabelId
Gg842579.pubmethod(en-us,AX.60).gif doesMethodExist Checks whether a given method exists on the table.
Gg842579.pubmethod(en-us,AX.60).gif enabled Returns a value that indicates whether the table is enabled.
Gg842579.pubmethod(en-us,AX.60).gif enforceRelationRules
Gg842579.pubmethod(en-us,AX.60).gif entityRelationshipType
Gg842579.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif extendedBy
Gg842579.pubmethod(en-us,AX.60).gif extends Returns the table ID of a base table.
Gg842579.pubmethod(en-us,AX.60).gif fieldCnt Returns the number of fields for a table.
Gg842579.pubmethod(en-us,AX.60).gif fieldCnt2Id Returns the field ID of the field that is specified by an index.
Gg842579.pubmethod(en-us,AX.60).gif fieldGroup Returns the name of a field group that is specified by index.
Gg842579.pubmethod(en-us,AX.60).gif fieldGroupCnt Returns the number of field groups for the table.
Gg842579.pubmethod(en-us,AX.60).gif fieldName Returns the name of the field that is specified by field ID.
Gg842579.pubmethod(en-us,AX.60).gif fieldName2Id Returns the field ID of a field that is specified by name.
Gg842579.pubmethod(en-us,AX.60).gif fieldNext Returns the value of the next field ID during a field iteration of the table.
Gg842579.pubmethod(en-us,AX.60).gif fieldObject Creates an instance of the DictField class for the field that is specified by field ID.
Gg842579.pubmethod(en-us,AX.60).gif fieldOrigin2Id
Gg842579.pubmethod(en-us,AX.60).gif fieldSqlDefault Returns the SQL default value for the field that is specified by field ID.
Gg842579.pubmethod(en-us,AX.60).gif formRef Returns the name of the default form for the table.
Gg842579.pubmethod(en-us,AX.60).gif getCountryRegionCodes
Gg842579.pubmethod(en-us,AX.60).gif getCountryRegionContextField
Gg842579.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif getValidTimeStateValidFromFieldId
Gg842579.pubmethod(en-us,AX.60).gif getValidTimeStateValidToFieldId
Gg842579.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif hasRecidIdx Returns a value that indicates whether a record ID index for the table is in effect.
Gg842579.pubmethod(en-us,AX.60).gif hasSurrogateKey
Gg842579.pubmethod(en-us,AX.60).gif id Returns the ID of the table.
Gg842579.pubmethod(en-us,AX.60).gif indexCnt Returns the number of indexes for the table.
Gg842579.pubmethod(en-us,AX.60).gif indexCnt2Id
Gg842579.pubmethod(en-us,AX.60).gif indexName Returns the name of an index that is specified by the indexId parameter.
Gg842579.pubmethod(en-us,AX.60).gif indexName2Id Returns the ID of an index that is specified by name.
Gg842579.pubmethod(en-us,AX.60).gif indexNext Returns the value of the next index ID during an index iteration of the table.
Gg842579.pubmethod(en-us,AX.60).gif indexObject Creates an instance of the DictTable class for the index that is specified by ID.
Gg842579.pubmethod(en-us,AX.60).gif indexUnique Returns the ID of the unique index for the table.
Gg842579.pubmethod(en-us,AX.60).gif instanceRelationType
Gg842579.pubmethod(en-us,AX.60).gif isAbstract Indicates whether this table is abstract.
Gg842579.pubmethod(en-us,AX.60).gif isBaseData Indicates whether the table content is base data.
Gg842579.pubmethod(en-us,AX.60).gif isDefaultData Indicates whether the table contains default data.
Gg842579.pubmethod(en-us,AX.60).gif isDerivedFrom Indicates whether one table type derives from another.
Gg842579.pubmethod(en-us,AX.60).gif isMap Indicates whether the table is a map.
Gg842579.pubmethod(en-us,AX.60).gif isSql Indicates whether the table is an SQL table.
Gg842579.pubmethod(en-us,AX.60).gif isSystemTable Indicates whether the table is a system table.
Gg842579.pubmethod(en-us,AX.60).gif isTempDb
Gg842579.pubmethod(en-us,AX.60).gif isTmp Indicates whether the table is a temporary table.
Gg842579.pubmethod(en-us,AX.60).gif isUnionAllView
Gg842579.pubmethod(en-us,AX.60).gif isValidTimeStateTable
Gg842579.pubmethod(en-us,AX.60).gif isView Indicates whether the table is a view.
Gg842579.pubmethod(en-us,AX.60).gif label Returns the label text for the table.
Gg842579.pubmethod(en-us,AX.60).gif labelDefined Returns the value of the label property for the table.
Gg842579.pubmethod(en-us,AX.60).gif listPageRef
Gg842579.pubmethod(en-us,AX.60).gif makeRecord Creates a blank record for the table.
Gg842579.pubmethod(en-us,AX.60).gif mapCnt Returns the count of available table mappings for the map that is specified by this DictTable instance.
Gg842579.pubmethod(en-us,AX.60).gif mapObject Creates an instance of the [T: DictTableMap] class for a mapping that is specified by index.
Gg842579.pubmethod(en-us,AX.60).gif maxAccessMode Returns the value of the MaxAccessMode property for a table, as set in the AOT.
Gg842579.pubmethod(en-us,AX.60).gif name Retrieves the name of the table.
Gg842579.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Overrides the new Method.)
Gg842579.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.)
Gg842579.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.)
Gg842579.pubmethod(en-us,AX.60).gif objectMethod Returns the name of an instance method that is specified by index.
Gg842579.pubmethod(en-us,AX.60).gif objectMethodCnt Returns the number of instance methods for the table.
Gg842579.pubmethod(en-us,AX.60).gif objectMethodObject Returns an instance of the MethodInfo class for an object method that is specified by index.
Gg842579.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif occEnabled Indicates whether the optimistic concurrency mode has been enabled for a table.
Gg842579.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif primaryIndex Returns the ID of the primary index for the table.
Gg842579.pubmethod(en-us,AX.60).gif primaryKeyField Returns the ID of the field that is used for the primary key of the table.
Gg842579.pubmethod(en-us,AX.60).gif reindex Performs a reindex of the table.
Gg842579.pubmethod(en-us,AX.60).gif relation Returns the name of a relation that is specified by index.
Gg842579.pubmethod(en-us,AX.60).gif relationCnt Returns the number of relations for the table.
Gg842579.pubmethod(en-us,AX.60).gif reloadSecurity Reloads the feature key system for the table.
Gg842579.pubmethod(en-us,AX.60).gif replacementKey
Gg842579.pubmethod(en-us,AX.60).gif reportRef Returns the name of the default report for the table.
Gg842579.pubmethod(en-us,AX.60).gif rights Returns the access rights of the current user that is specified for the table.
Gg842579.pubmethod(en-us,AX.60).gif searchLinkRefName Retrieves the name of the menu item that links to information on a website about a table record that is listed in the search results in Enterprise Portal for Microsoft Dynamics AX.
Gg842579.pubmethod(en-us,AX.60).gif searchLinkRefType Retrieves the type of the menu item that links to information on a website about a table record that is listed in the Enterprise Portal search results.
Gg842579.pubmethod(en-us,AX.60).gif securityKeyId Returns the ID of the security key for the table.
Gg842579.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif singularLabel
Gg842579.pubmethod(en-us,AX.60).gif staticMethod Returns the name of a static method that is specified by index.
Gg842579.pubmethod(en-us,AX.60).gif staticMethodCnt Returns the number of static methods for the table.
Gg842579.pubmethod(en-us,AX.60).gif staticMethodObject Returns an instance of the MethodInfo class for a static method that is specified by index.
Gg842579.pubmethod(en-us,AX.60).gif supportInheritance
Gg842579.pubmethod(en-us,AX.60).gif tableGroup Returns the table group for a table.
Gg842579.pubmethod(en-us,AX.60).gif tableType Indicates the type of the table.
Gg842579.pubmethod(en-us,AX.60).gif titleField1 Returns the ID of the field that represents the titleField1 property of the table.
Gg842579.pubmethod(en-us,AX.60).gif titleField2 Returns the ID of the field that represents the titleField2 property of the table.
Gg842579.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg842579.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.)
Gg842579.pubmethod(en-us,AX.60).gif validRelationship
Gg842579.pubmethod(en-us,AX.60).gif visible Determines whether the table is visible.
Gg842579.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg842579.pubmethod(en-us,AX.60).gif Gg842579.static(en-us,AX.60).gif ::construct
Gg842579.pubmethod(en-us,AX.60).gif Gg842579.static(en-us,AX.60).gif ::getRelationTypeFromTableName
Gg842579.pubmethod(en-us,AX.60).gif Gg842579.static(en-us,AX.60).gif ::getTableNameFromRelationType

Top

Examples

The following example shows how to create an instance of the DictTable class to determine whether the data in the table is stored on a per-company basis.

DictTable dt; 
 
dt = new DictTable(tablenum(CustTable)); 
 
if (dt) 
{ 
    print (strfmt("The table is saved on a %1 basis.", dt.dataPrCompany() ? 
                      "per company" : "global")); 
}

Inheritance Hierarchy

Object Class
  DictTable Class
    DictView Class
    SysDictTable Class

See Also

DictField Class

DictIndex Class

DictRelation Class

DictClass Class

DictSecurityKey Class