Knowledge Base - API
Breadcrumbs

SelectionChange

The SelectionChange class derives from ConfigChange and represents the parameters needed to add or remove a selection from the configuration.

Constructors

SelectionChange Add(string optionId, string categoryId = null)

SelectionChange Remove(string optionId, int selectionIndex = 0, string categoryId = null)

Methods

Method

Returns

Description

Add(sting optionId)

SelectionChange

Static method that constructs and returns an instance of the SelectionChange for adding a selection to the configuration.

Remove(string optionId, in selectionIndex = 0)

SelectionChange

Static method that constructs and returns an instance of the SelectionChange for removing a specific selection from the configuration.

Properties

Data Type

Property

Description

string

CategoryId

Returns or sets the Category to which the Option applies. This is generally not needed as option ids are usually unique; however, Runtime Categories can contain options whose IDs are in conflict with others defined in the system.

string

OptionId

Returns or sets the ID of the Option to affect in the configuration.

ObjectChangeType

ChangeType

Returns or sets the type of operation to perform with the specified Option. This property controls whether a selection is made (i.e. added) in the configuration or removed.

 

Valid values include:

  • Add

  • Remove

int

SelectionIndex

Returns or sets the zero-based index of the selection to affect in the configuration.

Inheritance

ConfigChange

The ConfigChange class represents the base class for configuration updates. There are no properties defined on the ConfigChange class.