Share via


DictTable Class

Definition

The DictTable class provides information about a table.

public ref class DictTable : Microsoft::Dynamics::Ax::Xpp::XppObjectBase
[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class DictTable : Microsoft.Dynamics.Ax.Xpp.XppObjectBase
[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type DictTable = class
    inherit XppObjectBase
Public Class DictTable
Inherits XppObjectBase
Inheritance
Microsoft.Dynamics.AX.KernelInterop.ProxyBase
DictTable
Derived
Attributes

Remarks

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

Constructors

DictTable()
DictTable(Int32)
DictTable(IntPtr)

Fields

kernelClass (Inherited from XppObjectBase)

Properties

AxClassId

Methods

__shouldCallNew(Type) (Inherited from XppObjectBase)
addXppProxyReference(Type, Object) (Inherited from XppObjectBase)
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.

Call(String, Object[], Type[], Object[]) (Inherited from XppObjectBase)
Callobject(String, Common, Object[])

Calls the specified object method for a table.

Callstatic(String, Object[])

Calls the specified static method for a table.

cancelTimeOut(Int32) (Inherited from XppObjectBase)
Clusterindex()

Returns the ID of the clustered index for the table.

Clusterindex(Boolean)
Configurationkeyid()

Returns the ID of the configuration key for the table.

construct(String)
createKernelClass(Object[], Type[], Object[]) (Inherited from XppObjectBase)
Createrecord(String)
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(Int32)
Deleteactiontableid(Int32)

Returns the table ID of a table's delete action that is specified by an index.

Deleteactiontype(Int32)

Retrieves the type of a delete action for a table.

Developerdocumentation()
Developerdocumentationlabelid()
Doesmethodexist(String)

Checks whether a given method exists on the table.

DoesMethodExist(String)
Enabled()

Returns a value that indicates whether the table is enabled.

Enforcerelationrules()
Entityrelationshiptype()
equal(XppObjectBase) (Inherited from XppObjectBase)
Extendedby()
Extendedby(Boolean)
Extends()

Returns the table ID of a base table.

Fieldcnt()

Returns the number of fields for a table.

Fieldcnt(TableScope)
Fieldcnt2id(Int32, TableScope)
Fieldcnt2id(Int32)

Returns the field ID of the field that is specified by an index.

Fieldgroup(Int32, TableScope)
Fieldgroup(Int32)

Returns the name of a field group that is specified by index.

Fieldgroupcnt()

Returns the number of field groups for the table.

Fieldgroupcnt(TableScope)
Fieldname(Int32, DbBackend, Int32, FieldNameGenerationMode, String)
Fieldname(Int32, DbBackend, Int32, FieldNameGenerationMode)
Fieldname(Int32, DbBackend, Int32)
Fieldname(Int32, DbBackend)
Fieldname(Int32)

Returns the name of the field that is specified by field ID.

Fieldname2id(String)

Returns the field ID of a field that is specified by name.

Fieldnext(Int32, TableScope)
Fieldnext(Int32)

Returns the value of the next field ID during a field iteration of the table.

Fieldobject(Int32)

Creates an instance of the DictField class for the field that is specified by field ID.

Fieldorigin2id(Guid, TableScope)
Fieldorigin2id(Guid)
Fieldsqldefault(Int32)

Returns the SQL default value for the field that is specified by field ID.

finalize() (Inherited from XppObjectBase)
Formref()

Returns the name of the default form for the table.

Getcountryregioncodes()
Getcountryregioncontextfield()
GetExtendedBy(Int32, Boolean)
GetExtendedByList(String, Boolean)
GetExtendedByXppList(String, Boolean)
GetIntPtr() (Inherited from XppObjectBase)
GetKernelInstanceUniqueId() (Inherited from XppObjectBase)
Getrelationtypefromtablename(String)
Gettablenamefromrelationtype(Int64)
getTimeOutTimerHandle() (Inherited from XppObjectBase)
Getvalidtimestatevalidfromfieldid()
Getvalidtimestatevalidtofieldid()
getXppProxyReference(Type) (Inherited from XppObjectBase)
handle()
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(Int32)
Indexname(Int32, DbBackend)
Indexname(Int32)

Returns the name of an index that is specified by the indexId parameter.

Indexname2id(String)

Returns the ID of an index that is specified by name.

Indexnext(Int32)

Returns the value of the next index ID during an index iteration of the table.

Indexobject(Int32)

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.

IsDataEntity()
Isdefaultdata()

Indicates whether the table contains default data.

Isderivedfrom(String)

Indicates whether one table type derives from another.

IsManagedValid() (Inherited from XppObjectBase)
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.

IsXdsPolicyApplicable()
kernelhandle()
KernelInstanceDisposed() (Inherited from XppObjectBase)
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.

MakeReflectionCall(String, Object[]) (Inherited from XppObjectBase)
Mapcnt()

Returns the count of available table mappings for the map that is specified by this DictTable instance.

Mapobject(Int32)

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.

Name(DbBackend, Boolean)
Name(DbBackend)
newmethod() (Inherited from XppObjectBase)
newmethod(Int32)

Initializes a new instance of the Object class.

notify() (Inherited from XppObjectBase)
notifyAll() (Inherited from XppObjectBase)
Objectmethod(Int32, TableScope)
Objectmethod(Int32)

Returns the name of an instance method that is specified by index.

Objectmethodcnt()

Returns the number of instance methods for the table.

Objectmethodcnt(TableScope)
Objectmethodobject(Int32, TableScope)
Objectmethodobject(Int32)

Returns an instance of the MethodInfo class for an object method that is specified by index.

objectOnServer()
Obsolete.
(Inherited from XppObjectBase)
Occenabled()

Indicates whether the optimistic concurrency mode has been enabled for a table.

OperationalDomain()
Primaryindex()

Returns the ID of the primary index for the table.

Primaryindex(Boolean)
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(Int32, TableScope)
Relation(Int32)

Returns the name of a relation that is specified by index.

Relationcnt()

Returns the number of relations for the table.

Relationcnt(TableScope)
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.

Rights(Boolean)
Securitykeyid()

Returns the ID of the security key for the table.

setTimeOut(String, Int32, Boolean)
Obsolete.
(Inherited from XppObjectBase)
setTimeOut(String, Int32)
Obsolete.
(Inherited from XppObjectBase)
Singularlabel()
Singularlabel(Boolean)
Staticmethod(Int32)

Returns the name of a static method that is specified by index.

Staticmethodcnt()

Returns the number of static methods for the table.

Staticmethodobject(Int32)

Returns an instance of the MethodInfo class for a static method that is specified by index.

SubscriberAccessLevel()
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.

Titlefield1(Boolean, Boolean)
Titlefield1(Boolean)
Titlefield2()

Returns the ID of the field that represents the titleField2 property of the table.

Titlefield2(Boolean, Boolean)
Titlefield2(Boolean)
usageCount() (Inherited from XppObjectBase)
Validrelationship()
VerifyKernelClass() (Inherited from XppObjectBase)
Visible()

Determines whether the table is visible.

wait() (Inherited from XppObjectBase)
Xml() (Inherited from XppObjectBase)
Xml(Int32) (Inherited from XppObjectBase)

Applies to