Class SettingsCategoryBase<T>

A base class for a content settings category view model for a SettingsBaseControl.

Inheritance
object
PropertyMonitor
ViewModelBase<T, IHostContentServices>
SettingsCategoryBase<T>
PlugInsCategory<T>
Implements
Inherited Members
Namespace: Gorgon.Editor.UI
Assembly: Gorgon.Editor.API.dll
Syntax
public abstract class SettingsCategoryBase<T> : ViewModelBase<T, IHostContentServices>, ISettingsCategory, IViewModel, INotifyPropertyChanged, INotifyPropertyChanging, IGorgonNamedObject where T : SettingsCategoryViewModelParameters
Type Parameters
Name Description
T

The type of parameters for this view model. Must implement ISettingsCategory.
Remarks

This is a view model that is used provide a settings interface for a plug in. The editor will pick these up and present your custom settings view (along with the view model) so that users can make changes to plug in settings. These settings objects are returned to the host editor application by way of the OnGetSettings() method.

To register a settings panel, the developer must inherit this view model type, and create a settings view model for the plug in settings they wish to update. A view must be registered to the the view model by using the ViewFactory.Register<T>(Func<Control>) method.

Any parameters for this view model must inherit from the SettingsCategoryViewModelParameters class.

Properties

| Edit this page View Source

ID

Property to return the unqiue ID for the panel.

Declaration
public Guid ID { get; }
Property Value
Type Description
Guid
Remarks

This ID value is generated when the object is created, and does not need to be generated by the user.

See Also
| Edit this page View Source

Name

Property to return the name of this object.

Declaration
public abstract string Name { get; }
Property Value
Type Description
string
See Also

Implements

Extension Methods

See Also