DictTable Class

The DictTable class provides information about a table.

Syntax

class DictTable extends Object

Run On

Called

Methods

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