II3IDParameters Interface

Overview

Derived From:        IDispatch

Interface ID:          {3F23D3FA-9DF6-44EB-849E-35CC4D521D35}

II3IDParameters implements a collection of parameter objects and is obtained when you call II3IDStep::get_Parameters.   Interaction Designer regards all parameters added using Add methods as custom parameters.  When dealing with custom parameters, there are a few things to consider:

Input/output parameters created as part of the tool definition are not custom parameters.  Tool definition refers to parameters defined for the tool during the InitializeTools callout. Non-custom parameters are guaranteed to be the first elements of the II3IDParameters collection for a tool step.

You can get the number of non-custom parameters for a step by calling the II3IDParameters::get_RegisteredCount method.  You can examine any parameter to see if it is custom by calling the II3IDParameter::get_IsCustom method. Custom parameters must be inserted after all non-custom parameters.

The II3IDParameters::RemoveParameter method does not remove non-custom parameters.  To append a parameter to a parameter collection, specify -1 for the index when calling the II3IDParameters::AddXXX method.  For example, suppose that a tool registers 2 inputs and 1 output in InitializeTools.  It could be represented as the following for a tool step:

ToolStep

Parm1 - Input

Parm2 - Input

Parm3 - Output

Note that Parm1, Parm2 and Parm3 are part of the tool definition and are not custom parameters.  In the II3IDParameters collection for a tool step, it is possible to add a new input parameter:

ToolStep

Parm1 - Input

Parm2 - Input

Parm3 - Output

    NewCustomParm - Input But you could not add a new input parameter here:

ToolStep

Parm1 - Input

-> NewCustomParm - Input No good.  It must be after all non-custom parameters.

Parm2 - Input

Parm3 - Output

Likewise, in the example toolstep below, you could not remove Parm1, Parm2 or Parm3, but you could remove NewCustomParm.

ToolStep

Parm1 - Input

Parm2 - Input

Parm3 - Output

NewCustomParm - Input

Methods

AddHiddenParameter	Implements functionality defined in I3IDToolReg.h's I3IDAddToolHiddenParameter method.
AddInputCheckBox	Implements functionality defined in I3IDToolReg.h's I3IDAddToolInputCheckBox method.
AddInputComboBox	Implements functionality defined in I3IDToolReg.h's I3IDAddToolInputComboBox method.
AddInputMultiLine	Implements functionality defined in I3IDToolReg.h's I3IDAddToolInputMultiLine method.
AddOutput	Implements functionality defined in I3IDToolReg.h's I3IDAddToolOutput method.
AddParameterFromParameterDefinition	Adds a parameter to the collection based off of the parameter definition.
ApplyToStep	Takes a cloned parameter collection and applies it to the original step where the collection came from.
Clone	Returns a cloned set of parameters for the step.
Item	Retrieves a parameter by its index in the collection.
Remove	Removes a parameter from the step.

Properties

Count	Returns the number of items in the collection.
IsClone	Indicates whether or not the parameter collection is a cloned collection.
IsModifiable	Returns whether or not the parameter collection is modifiable.
RegisteredCount	Number of parameters defined by the tool.  This number may be different than the total number of parameters available in the step.