Kanzi  3.9.4
Kanzi Studio API
BasePluginEditorViewModel Class Reference

Basic implementation of the plugin editor ViewModel. More...

Inheritance diagram for BasePluginEditorViewModel:
[legend]
Collaboration diagram for BasePluginEditorViewModel:
[legend]

Public Member Functions

 BasePluginEditorViewModel (object initialValue, Action< object > valueSetCallback)
 BasePluginEditorViewModel constructor More...
 
virtual void HandleValueChange (object value)
 Handles the change of a property value when the value changes in Kanzi Studio. More...
 

Protected Member Functions

virtual void OnPropertyChanged (string propertyName)
 

Properties

virtual object PropertyValue [get, set]
 Gets or sets the value of a property. More...
 
Action< object > ValueSetCallback [get, set]
 

Events

PropertyChangedEventHandler PropertyChanged
 PropertyChanged event. More...
 

Detailed Description

Basic implementation of the plugin editor ViewModel.

Constructor & Destructor Documentation

◆ BasePluginEditorViewModel()

BasePluginEditorViewModel ( object  initialValue,
Action< object >  valueSetCallback 
)
inline

BasePluginEditorViewModel constructor

Parameters
initialValueInitial value of the property when Kanzi Studio creates the editor.
valueSetCallbackAction to run when the editor changes the value of the property. This is how Kanzi Studio knows that the user changed the value of a property using the editor.

Member Function Documentation

◆ HandleValueChange()

virtual void HandleValueChange ( object  value)
inlinevirtual

Handles the change of a property value when the value changes in Kanzi Studio.

Kanzi Studio calls this method when the value of a property changes. Kanzi Studio calls it also when the user changes the value using the editor.

Parameters
valueCurrent value of the property.

Property Documentation

◆ PropertyValue

virtual object PropertyValue
getset

Gets or sets the value of a property.

Represents the value of a property. You can bind a property editor to this value.

Event Documentation

◆ PropertyChanged

PropertyChangedEventHandler PropertyChanged

PropertyChanged event.

INotifyPropertyChanged implementation.