Class EditableOptionsBase
Implements
Inherited Members
Namespace: Emby.Web.GenericEdit
Assembly: Emby.Web.GenericEdit.dll
Syntax
public abstract class EditableOptionsBase : EditableObjectBase, IEditableObjectMethods
ApplyOptionValues(PropertyOptionValues)
Assigns previously collected values back onto this instance, which has to be constructed and initialized the same way the baseline they were collected against was.
Declaration
public PropertyOptionValues ApplyOptionValues(PropertyOptionValues optionValues)Parameters
| Type | Name | Description |
|---|---|---|
| PropertyOptionValues | optionValues | The values to apply. |
Returns
| Type | Description |
|---|---|
| PropertyOptionValues | The entries which could not be applied - see ApplyOptionValues(Object, PropertyOptionValues). |
GetOptionValues()
Gets those values of this instance which differ from a default-constructed instance of the same type, for persisting a configuration as only its deviations from the defaults.
Declaration
public PropertyOptionValues GetOptionValues()Returns
| Type | Description |
|---|---|
| PropertyOptionValues |
Remarks
Only applicable to types whose defaults are declared on the properties themselves. Types which receive defaults from an initialization step - the encoder and filter parameter classes, whose defaults depend on the codec or filter they are initialized with - have to use GetOptionValues(EditableOptionsBase) with an identically initialized baseline. A bare instance would differ from the real defaults, and those differences would then be persisted as though the user had chosen them, which would make the defaults impossible to change later.
GetOptionValues(EditableOptionsBase)
Gets those values of this instance which differ from baselineOptions.
Declaration
public PropertyOptionValues GetOptionValues(EditableOptionsBase baselineOptions)Parameters
| Type | Name | Description |
|---|---|---|
| EditableOptionsBase | baselineOptions | An instance of this same type, constructed and initialized the way this instance was but otherwise left untouched, so that only the user's own changes are collected. |
Returns
| Type | Description |
|---|---|
| PropertyOptionValues |