IDLitParameter::RegisterParameter

Syntax | Arguments | Keywords | Version History

The IDLitParameter::RegisterParameter procedure method registers a parameter with the visualization object. Registered parameters are displayed in the iTool parameter editor dialog, allowing users to interactively assign data values to individual visualization parameters.

Syntax

Obj->[IDLitParameter::]RegisterParameter, Name [, /BY_VALUE] [, DESCRIPTION=string] [, /INPUT] [, /OPTARGET] [, /OPTIONAL] [, /OUTPUT] [, TYPES=string]

Arguments

Name

Set this argument to a string specifying the name of the parameter.

Keywords

BY_VALUE

Set this keyword to indicate that this parameter is a by-value parameter. If a parameter is marked as by value, when data is associated with it a copy of the data is made and managed by this class.

DESCRIPTION

Set this keyword to a string giving the full name or description of this object.

INPUT

Set this keyword to indicate that this is an input parameter.

OPTARGET

Set this keyword to indicate that this parameter may be the target of any operations.

OPTIONAL

If this keyword is set, then this parameter is an optional parameter, and it is not required to be set. The default is OPTIONAL=0, indicating that it is required to be set.

OUTPUT

Set this keyword to indicate that this is an output parameter.

TYPES

Set this keyword to a scalar string or string array giving the data types that correspond to this parameter. See iTool Data Types (iTool Developer's Guide) for more on parameter data types.

Version History