DictEnum Class

The DictEnum class obtains meta-information about the Base Enum enumerations in the Application Object Tree (AOT).

class DictEnum extends Object

Run On

Called

Methods

Method

Description

cancelTimeOut

Cancels a previous method call to the Object.setTimeOut Method. (Inherited from Object.)

configurationKeyId

Returns the configuration key ID for the enumeration.

equal

Determines whether the specified object is equal to the current one. (Inherited from Object.)

getTimeOutTimerHandle

Returns the timer handle for the object. (Inherited from Object.)

handle

Retrieves the handle of the class of the object. (Inherited from Object.)

help

Retrieves the Help text for this enumeration.

id

Returns the enumeration ID of the enumeration.

index2ConfigurationKey

index2Label

Returns the label of the enumeration item that is specified by an index.

index2Name

Returns the label of the enumeration item that is specified by an index.

index2Symbol

Returns the symbol, or name, of the enumeration item that is specified by an index.

index2Value

Returns the value of the enumeration item that is specified by an index.

label

Returns the label text of the enumeration.

name

Returns the name of the enumeration.

name2Value

Returns the enumeration value of the item that is referenced by its label.

new

Overridden. Creates an instance of the DictEnum class.

notify

Releases the hold on an object that has called a wait method on this object. (Inherited from Object.)

notifyAll

Releases a lock on the object that was issued by a wait method on this object. (Inherited from Object.)

objectOnServer

Determines whether the object is on a server. (Inherited from Object.)

owner

Returns the instance that owns the object. (Inherited from Object.)

setTimeOut

Sets up the scheduled execution of a specified method. (Inherited from Object.)

showAsRadio

Returns a value that indicates whether the enumeration should be displayed by using radio buttons instead of a combo box.

symbol2Value

Returns the enumeration value of the item referenced by its symbol or name.

toString

Returns a string that represents the current object. (Inherited from Object.)

usageCount

Returns the current number of references (the value of the reference counter) that the object has. (Inherited from Object.)

value2ConfigurationKey

Returns the configuration key ID of a specified enumeration value.

value2Label

Returns the label of a specified enumeration value.

value2Name

Returns the name of a specified enumeration value.

value2Symbol

Returns the symbol, or value of the Name property, of a specified enumeration value.

values

Returns the number of items in the enumeration.

wait

Pauses a process. (Inherited from Object.)

xml

Returns an XML string that represents the current object. (Inherited from Object.)

::value2id

Returns the enumeration ID of a specified value.

Remarks

For backward compatibility, a special naming convention for methods converting to or from properties is used.

Property

Example of content

Name used in methods

Name

ReqDate

Symbol (typed as string)

Label

@SYS18075 ("Requirement date")

Name or Label

FeatureKey

ReqSchedAction

FeatureKey

EnumValue

0

Value

Position in AOT

First (Index = 0)

Index

This example is from the base enum ActionBasicDateType Enumeration.

For general information on enumerations, see the Developer's Guide.