EnumerationDefinition object

Information about the type of a variable when it is an enumerated datatype. EnumerationDefinition is inherited from TypeDefinition. It has no events.

Properties

EnumerationDefinition property

Datatype

Description

Category

TypeCategory

Specifies whether the type is simple, enumerated, or a class or structure. Values are:

SimpleType!

EnumeratedType!

ClassOrStructureType!

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

DataTypeOf

String

The system class name or simple datatype of the variable. DataTypeOf is a string representation of a value of the Object enumerated datatype. Values are lowercase with no exclamation point. Sample values include:

window

string

any

dropdownlistbox

For objects you have defined, the datatype is the system class from which your object is inherited.

Enumeration[ ]

EnumerationItemDefinition

An array of the name-value pairs for all the items in the enumeration.

IsStructure

Boolean

Indicates whether the type is a structure. Always FALSE.

IsSystemType

Boolean

Indicates whether the class is a system class -- that is, one of the classes defined within PowerBuilder as opposed to a class defined in a PBL by a user.

IsVariableLength

Boolean

Specifies whether the datatype has a fixed size. Always true.

Values are:

TRUE -- The datatype is of variable length, meaning the datatype is a string, any, blob, or unbounded array.

FALSE -- The datatype is a fixed length.

IsVisualType

Boolean

Indicates whether the type is a visual or nonvisual type. Always false.

LibraryName

String

The fully qualified name of the library the class was loaded from. The library can no longer contain the class. If a program manipulates the contents of libraries, the class could have been moved or deleted after it was loaded.

Name

String

The name of the class. For a nested class, the name is returned in the form of libraryEntryName`className.


Functions

EnumerationDefinition function

Datatype returned

Description

ClassName

String

Returns the name assigned to the object.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent

PowerObject

Returns a reference to the name of the parent object.

TypeOf

Object

Returns the type of the object.