Class EffectConfigForm
- Namespace
- PaintDotNet.Effects
- Assembly
- PaintDotNet.Effects.Core.dll
public class EffectConfigForm : PdnBaseForm, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IContainerControl, IContainer, IEffectConfigForm, IIsDisposed, IDisposable- Inheritance
-
EffectConfigForm
- Implements
- Derived
- Inherited Members
Properties
- Token
Gets or sets the token that it passed to the effect to configure its rendering parameters.
Methods
- OnCreateInitialToken()
Implemented by the derived class to create the initial token at construction time. The token is usually populated with the default values for the effect.
This method is called before the derived class's constructor, and before the Effect property has been set.
- OnTokenChanged()
Raises the TokenChanged event.
- OnUpdateDialogFromToken(EffectConfigToken)
This method must be overridden in derived classes. Use the data from the given token object to initialize or update the dialog's UI.
- OnUpdateTokenFromDialog(EffectConfigToken)
Called when the Token should be synchronized with the dialog's controls.
- UpdateDialogFromToken()
Called by the derived class to indicate that the Token has been modified, and the dialog should be synchronized with it.
It is not necessary to call this method if you set the Token property; it is only necessary when modifying the token in-place.
- UpdateTokenFromDialog()
Called by the derived class to indicate that the Token should be updated, usually in response to changes the user has made to the dialog's controls (e.g. sliders, checkboxes, etc.).
This will result in a call to the OnUpdateTokenFromDialog(EffectConfigToken) method, followed by a call to OnTokenChanged() which will raise the TokenChanged event.
Events
- TokenChanged
Occurs when the Token property is set or modified.