Home | Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]

IDLitComponent Properties


IDLitComponent objects have the following properties. Properties with the word "Yes" in the "Get" column of the property table can be retrieved via IDLitComponent::GetProperty. Properties with the word "Yes" in the "Init" column of the property table can be set via IDLitComponent::Init. Properties with the word "Yes" in the "Set" column in the property table can be set via IDLitComponent::SetProperty.

Note
For a discussion of the property description tables shown below, see About Object Property Descriptions.

COMPONENT_VERSION

A integer value representing the version of the component object. This value is set by RSI and is intended to aid in determining how a component object should be restored by the Restore method.

Property Type
Integer
Name String
not displayed
Get: Yes
Set: No
Init: No
Registered: No

DESCRIPTION

A string giving the full name or description of this object.

Property Type
STRING
Name String
Description
Get: Yes
Set: Yes
Init: Yes
Registered: Yes

HELP

A scalar string representing the help topic associated with this object. If this property is not set, or is set to a null string, then the object class name will be used as the default help topic.

Property Type
String
Name String
not displayed
Get: Yes
Set: Yes
Init: Yes
Registered: No

ICON

A string specifying the name of an icon to be associated with this object. Typically, this property is the name of a bitmap file used when displaying this object in a tree view. See System Resources for details.

Property Type
String
Name String
not displayed
Get: Yes
Set: Yes
Init: Yes
Registered: No

IDENTIFIER

A string containing the object identifier for this object. If this property is not specified, then the NAME property is used as the identifier. See iTool Object Identifiers for details about how identifiers are named.

Property Type
String
Name String
not displayed
Get: Yes
Set: Yes
Init: Yes
Registered: No

NAME

A string giving the human-readable name of this object.

Property Type
STRING
Name String
Name
Get: Yes
Set: Yes
Init: Yes
Registered: Yes

PRIVATE

A boolean value that indicates whether the object should be marked as private. Objects marked private (and all of their children) are not displayed in the graphical iTool browser windows.

Property Type
Boolean
Name String
not displayed
Get: Yes
Set: Yes
Init: Yes
Registered: No

UVALUE

A value of any type containing any information you wish. If you set this user value equal to a pointer or object reference that does not belong to a container, you should explicitly destroy that pointer or object reference when destroying the object of which this property is a user value.

Property Type
User Defined
Name String
not displayed
Get: Yes
Set: Yes
Init: Yes
Registered: No

Version History

COMPONENT_VERSION property added: 6.1


Home | Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]