Class PlugInsCategory<T>

A common view model for a plug ins category.

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 PlugInsCategory<T> : SettingsCategoryBase<T>, ISettingsCategory, IViewModel, INotifyPropertyChanged, INotifyPropertyChanging, IGorgonNamedObject where T : PlugInsCategoryViewModelParameters
Type Parameters
Name Description
T

The type of parameters for the view model.

Constructors

| Edit this page View Source

PlugInsCategory()

Initializes a new instance of the PlugInsCategory<T> class.

Declaration
protected PlugInsCategory()

Properties

| Edit this page View Source

LoadPlugInAssemblyCommand

Property to return the command for loading a plug in assembly.

Declaration
public IEditorCommand<object> LoadPlugInAssemblyCommand { get; }
Property Value
Type Description
IEditorCommand<object>
| Edit this page View Source

OpenCodecDialog

Property to return the dialog used to open plug in assemblies.

Declaration
protected IFileDialogService OpenCodecDialog { get; }
Property Value
Type Description
IFileDialogService
| Edit this page View Source

SettingsFileName

Property to return the file name that will hold the plug ins.

Declaration
protected abstract string SettingsFileName { get; }
Property Value
Type Description
string
| Edit this page View Source

UnloadPlugInAssembliesCommand

Property to return the command to unloading a plug in assembly.

Declaration
public IEditorCommand<object> UnloadPlugInAssembliesCommand { get; }
Property Value
Type Description
IEditorCommand<object>
| Edit this page View Source

WriteSettingsCommand

Property to return the command for writing setting data.

Declaration
public IEditorCommand<object> WriteSettingsCommand { get; }
Property Value
Type Description
IEditorCommand<object>

Methods

| Edit this page View Source

CanUnloadPlugInAssemblies()

Function to determine if the selected plug in assemblies can be unloaded.

Declaration
protected abstract bool CanUnloadPlugInAssemblies()
Returns
Type Description
bool

true if the plug in assemblies can be removed, false if not.
| Edit this page View Source

OnGetSettings()

Function to retrieve the underlying object used to hold the settings.

Declaration
protected abstract object OnGetSettings()
Returns
Type Description
object

The object that holds the settings.
| Edit this page View Source

OnInitialize(T)

Function to inject dependencies for the view model.

Declaration
protected override void OnInitialize(T injectionParameters)
Parameters
Type Name Description
T injectionParameters

The parameters to inject.
Overrides
Remarks

Applications should call this when setting up the view model for complex operations and/or dependency injection. The constructor should only be used for simple set up and initialization of objects.

| Edit this page View Source

OnLoadPlugIns()

Function to load plugins from selected assemblies.

Declaration
protected abstract bool OnLoadPlugIns()
Returns
Type Description
bool

true to indicate that the operation succeeded, or false if it was cancelled.
| Edit this page View Source

OnUnloadPlugIns()

Function to unload previously loaded plug ins.

Declaration
protected abstract bool OnUnloadPlugIns()
Returns
Type Description
bool

true to indicate that the operation succeeded, or false if it was cancelled.

Implements

Extension Methods