Share via


DictIndex Class

The DictIndex class returns metadata about a table index.

Syntax

class DictIndex extends Object

Run On

Called

Methods

  Method Description
Gg841972.pubmethod(en-us,AX.60).gif allowDuplicates Returns the value of the allowDuplicates property for the index.
Gg841972.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg841972.pubmethod(en-us,AX.60).gif configurationKeyId Returns the ID of the configuration key for the index.
Gg841972.pubmethod(en-us,AX.60).gif enabled Returns a value that indicates whether the index is enabled.
Gg841972.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg841972.pubmethod(en-us,AX.60).gif field Returns the ID of the specified field in the index.
Gg841972.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg841972.pubmethod(en-us,AX.60).gif getValidTimeStateMode
Gg841972.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg841972.pubmethod(en-us,AX.60).gif id Returns the ID of the index.
Gg841972.pubmethod(en-us,AX.60).gif includedColumn
Gg841972.pubmethod(en-us,AX.60).gif isAlternateKey
Gg841972.pubmethod(en-us,AX.60).gif isSql Gets a value that indicates whether the index is in the SQL database.
Gg841972.pubmethod(en-us,AX.60).gif isUniqueAcrossCompanies Gets a value that indicates whether the UniqueAcrossCompanies property is set for the index.
Gg841972.pubmethod(en-us,AX.60).gif isValidTimeStateKey
Gg841972.pubmethod(en-us,AX.60).gif modify Modifies the index.
Gg841972.pubmethod(en-us,AX.60).gif name Returns the name of the index.
Gg841972.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Overrides the new Method.)
Gg841972.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.)
Gg841972.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.)
Gg841972.pubmethod(en-us,AX.60).gif numberOfFields Returns the number of fields in the index definition.
Gg841972.pubmethod(en-us,AX.60).gif numberOfIncludedColumns
Gg841972.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg841972.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg841972.pubmethod(en-us,AX.60).gif setAlternateKey
Gg841972.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg841972.pubmethod(en-us,AX.60).gif setValidTimeStateKey
Gg841972.pubmethod(en-us,AX.60).gif tableid Returns the ID of the table that contains the index.
Gg841972.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg841972.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.)
Gg841972.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg841972.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)

Top

Examples

The following example creates an instance of the DictIndex class.

Dictionary dict; 
DictTable  table; 
DictIndex  idx; 
 
dict = new Dictionary(); 
table = new DictTable(dict.tableName2Id("Address")); 
idx = new DictIndex(table.id(), table.indexName2Id("AddrIdx"));

Inheritance Hierarchy

Object Class
  DictIndex Class
    SysDictIndex Class

See Also

DictField Class

DictTable Class