Knowledge Base - API
Breadcrumbs

SetPropertyChange

The SetPropertyChange class derives from ConfigChange and represents the parameters needed to set a property value in the configuration.

Constructors

SetPropertyChange Create(string categoryId, string optionId, int selectionIndex, string propertyId, object value)

SetPropertyChange Create(string categoryId, string optionId, string propertyId, object value)

SetPropertyChange Create(string optionId, string propertyId, object value)

Properties

Data Type

Property

Description

string

CategoryId

Returns or sets the Category of the option whose Property is being changed. Generally, this parameter is optional as Option IDs are globally unique within a given Series, however, in the event a selection is being made in a runtime Category, the CategoryId is required.

string

OptionId

Returns or sets the ID of the Option whose Property is being changed. For a runtime Category, the OptionId should be the runtime Option ID and not the internal ID of the Option.

string

PropertyId

Returns or sets the ID of the Property to change.

int

SelectionIndex

Returns or sets the zero-based index of the Option whose Property is being changed.

object

Value

Returns or sets the value to be assigned to the given Property.

Inheritance

ConfigChange

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