IDLitParameter::SetParameterSet

IDLitParameter::SetParameterSet

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitParameter::SetParameterSet function method is used to associate an IDLitParameterSet object with the visualization object's parameter interface. IDLitData objects contained in the parameter set object will be associated with the registered parameters of the visualization object, either based on the parameter names included in the parameter set object or on the iTool data types of the data objects. When the association of the parameter set's data objects with the visualization object's registered parameters is complete, the OnDataChangeUpdate method is called with the IDLitParameterSet object and the string '<PARAMETER SET>' as the arguments.

Note

When this method is called, the IDLitParameterSet object created when the visualization object was initialized will be disassociated from the object's parameter interface. This means that any individual data objects or parameter names previously added to the initial parameter set object will also be disassociated from the visualization object's parameter interface.

This method will not destroy or delete the information contained in the specified IDLitParameterSet object.

Syntax

Result = Obj->[IDLitParameter::]SetParameterSet(ParamSet)

Return Value

Returns 1 if the IDLitParameterSet object was successfully associated with the visualization object's parameter interface, or 0 otherwise.

Arguments

ParamSet

An IDLitParameterSet object to be associated with the visualization object's parameter interface.

Keywords

None

Version History

Introduced: 6.0