Interface IPlugInViewModel

Namespace: Phoenix.ComponentPlugInSDK.ViewModels
Assembly: Phoenix.ComponentPlugInSDK.dll

An Interface for plugin ViewModels that provides common properties and methods.

public interface IPlugInViewModel

Properties

BuilderName

The Name of the Builder, this will be used to build the WindowTitle and titles of other dialogs.

InputVariables

List of input variables in the component.

IsBusy

Whether the view model is currently busy.

IsDirty

Whether there are any unsaved changes in the editor.

IsReadOnly

If the pacz is read only

OkCommand

Command to apply changes and close the dialog.

OutputVariables

List of output variables in the component.

SaveCommand

Command to perform an apply operation.

WindowIcon

The icon of the view's window. If null, the default Windows icon will be used.

WindowTitle

The Title of the View's Window, should indicate state(IsDirty, IsBusy)

Methods

CloneInputVariablesFrom(IEnumerable<IRuntimeVariable>)

Sets Phoenix.ComponentPlugInSDK.ViewModels.IPlugInViewModel.InputVariables based on the passed in values

CloneOutputVariablesFrom(IEnumerable<IRuntimeVariable>)

Sets Phoenix.ComponentPlugInSDK.ViewModels.IPlugInViewModel.OutputVariables based on the passed in values

GetVariablesAsPHXVariable(VariableValueScope)

Retrieves the Phoenix.ComponentPlugInSDK.ViewModels.IPlugInViewModel.InputVariables and Phoenix.ComponentPlugInSDK.ViewModels.IPlugInViewModel.OutputVariables converted to an enumerable of PHXVariable objects.

MoveInputVariablesFrom(IEnumerable<IRuntimeVariable>)

Sets Phoenix.ComponentPlugInSDK.ViewModels.IPlugInViewModel.InputVariables based on the passed in values

MoveOutputVariablesFrom(IEnumerable<IRuntimeVariable>)

Sets Phoenix.ComponentPlugInSDK.ViewModels.IPlugInViewModel.OutputVariables based on the passed in values

SaveAsync()

Saves the current state of the component to the Pacz.

SetVariablesAsPHXVariable(IEnumerable<PHXVariable>)

Reads a list of PHXVariable objects and replaces the Phoenix.ComponentPlugInSDK.ViewModels.IPlugInViewModel.InputVariables and Phoenix.ComponentPlugInSDK.ViewModels.IPlugInViewModel.OutputVariables parameters based on this content, converted to IRuntimeVariables.

PropertyChanged

An INotifyPropertyChanged Event Handler that will handle the PropertyChanged event raised when a property is changed.