The ResetPropertyChange class derives from ConfigChange and represents the parameters needed to reset a property to its default or calculated value.
Structurally and functionally, the ResetPropertyChange is identical to the SetPropertyChange, apart from not having a Value parameter. ResetPropertyChange is intended to be used on calculated properties that have been overridden to reset them back to their calculated values, or on editable properties to restore them back to their defaults values.
Constructors
ResetPropertyChange Create(string categoryId, string optionId, int selectionIndex, string propertyId)
ResetPropertyChange Create(string categoryId, string optionId, string propertyId)
ResetPropertyChange Create(string optionId, string propertyId)
Properties
|
Data Type |
Property |
Description |
|---|---|---|
|
string |
CategoryId |
Returns or sets the Category of the option whose Property is being reset. 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 reset. 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 reset. |
|
int |
SelectionIndex |
Returns or sets the zero-based index of the Option whose Property is being reset. |