CIP C++ documentation for class "pfcParameterSelectionOptions"

Class pfcParameterSelectionOptions

# include <pfcModelItem.h> class pfcParameterSelectionOptions : public virtual xobject { xdeclare(pfcParameterSelectionOptions) ... }; This is a COMPACT class.

Description

This class specifies the parameter selection options.

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Method Summary


`static pfcParameterSelectionOptions_ptr`	`Create ()`
	Creates a ParameterSelectionOptions object.

`optional xbool`	`GetAllowContextSelection ()`
`void`	`SetAllowContextSelection (optional xbool value)`
	Whether or not to allow parameter selection from multiple contexts, or only from the invoking parameter owner.The default is to allow selection only from the invoking parameter owner.

`optional xbool`	`GetAllowMultipleSelections ()`
`void`	`SetAllowMultipleSelections (optional xbool value)`
	Whether or not to allow multiple parameters to be selected from the dialog box, or only a single parameter. By default, it is true, and allows selection of multiple parameters.

`optional pfcParameterSelectionContexts_ptr`	`GetContexts ()`
`void`	`SetContexts (optional pfcParameterSelectionContexts_ptr value)`
	The parameter selection contexts.The default indicates that parameters may be selected from any context.

`optional xstring`	`GetSelectButtonLabel ()`
`void`	`SetSelectButtonLabel (optional xrstring value)`
	Label for the select button.The default is null.

Method Detail

`optional pfcParameterSelectionContexts_ptr`	`GetContexts`	`()`
`void`	`SetContexts`	`(optional pfcParameterSelectionContexts_ptr value)`

The parameter selection contexts.The default indicates that parameters may be selected from any context.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

`optional xbool`	`GetAllowContextSelection`	`()`
`void`	`SetAllowContextSelection`	`(optional xbool value)`

Whether or not to allow parameter selection from multiple contexts, or only from the invoking parameter owner.The default is to allow selection only from the invoking parameter owner.

Manual References:: Dimensions and Parameters: Parameter Selection Options

`optional xbool`	`GetAllowMultipleSelections`	`()`
`void`	`SetAllowMultipleSelections`	`(optional xbool value)`

Whether or not to allow multiple parameters to be selected from the dialog box, or only a single parameter. By default, it is true, and allows selection of multiple parameters.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

`optional xstring`	`GetSelectButtonLabel`	`()`
`void`	`SetSelectButtonLabel`	`(optional xrstring value)`

Label for the select button.The default is null.

Manual References:: Dimensions and Parameters: Parameter Selection Options

static pfcParameterSelectionOptions_ptr Create ()

Creates a ParameterSelectionOptions object.

Manual References:: Dimensions and Parameters: Parameter Selection Options, Dimensions and Parameters: Parameter Selection Options

Returns: