Click or drag to resize

BrushControllerAdvanced Class

Controller for editing advanced BrushX settings.
Inheritance Hierarchy

Namespace: Altaxo.Gui.Common.Drawing
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
Copy
public class BrushControllerAdvanced : MVCANDControllerEditImmutableDocBase<BrushX, IBrushViewAdvanced>

The BrushControllerAdvanced type exposes the following members.

Constructors
 NameDescription
Public methodBrushControllerAdvancedInitializes a new instance of the BrushControllerAdvanced class
Top
Properties
 NameDescription
Public propertyAdditionalPropertiesController Gets the controller for additional image properties.
Public propertyBackColor Gets or sets the background color.
Public propertyBackColorEnable Gets or sets a value indicating whether the background color editor is enabled.
Public propertyBrushDocument Gets the current brush document.
Public propertyBrushType Gets or sets the brush type.
Public propertyExchangeColors Gets or sets a value indicating whether foreground and background colors are exchanged.
Public propertyExchangeColorsEnable Gets or sets a value indicating whether the color exchange option is enabled.
Public propertyForeColor Gets or sets the foreground color.
Public propertyForeColorEnable Gets or sets a value indicating whether the foreground color editor is enabled.
Public propertyGradientAngle Gets or sets the gradient angle.
Public propertyGradientAngleEnable Gets or sets a value indicating whether the gradient angle editor is enabled.
Public propertyGradientAngleEnvironment Gets or sets the unit environment for the gradient angle.
Public propertyGradientColorScale Gets or sets the gradient color scale.
Public propertyGradientColorScaleEnable Gets or sets a value indicating whether the gradient color scale editor is enabled.
Public propertyGradientColorScaleEnvironment Gets or sets the unit environment for the gradient color scale.
Public propertyGradientFocus Gets or sets the gradient focus.
Public propertyGradientFocusEnable Gets or sets a value indicating whether the gradient focus editor is enabled.
Public propertyGradientFocusEnvironment Gets or sets the unit environment for the gradient focus.
Public propertyIsDisposed Gets a value indicating whether this controller is already disposed.
(Inherited from ControllerBase)
Public propertyModelObject Gets the model (document) that this controller manages.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected propertyNoDocumentException Gets an exception that is thrown when a controller was not initialized with a document.
(Inherited from ControllerBase)
Protected propertyNotInitializedException Gets an exception that is thrown when a controller is not properly initialized.
(Inherited from ControllerBase)
Protected propertyNoViewException Gets an exception that is thrown when a controller currently has no view.
(Inherited from ControllerBase)
Public propertyProvisionalModelObject Gets the provisional model object. This is the model object that is based on the current user input.
(Inherited from MVCANDControllerEditImmutableDocBaseTModel, TView)
Public propertyShowPlotColorsOnly Gets or sets a value indicating whether only plot colors are shown.
Public propertyTextureImage Gets or sets the texture image.
Public propertyTextureImageEnable Gets or sets a value indicating whether the texture image editor is enabled.
Public propertyTextureOffsetX Gets or sets the x texture offset.
Public propertyTextureOffsetXEnable Gets or sets a value indicating whether the x texture offset editor is enabled.
Public propertyTextureOffsetXEnvironment Gets the unit environment for the x texture offset.
Public propertyTextureOffsetY Gets or sets the y texture offset.
Public propertyTextureOffsetYEnable Gets or sets a value indicating whether the y texture offset editor is enabled.
Public propertyTextureOffsetYEnvironment Gets the unit environment for the y texture offset.
Public propertyTextureScalingController Gets the texture scaling controller.
Public propertyTextureScalingEnable Gets or sets a value indicating whether texture scaling is enabled.
Public propertyUseDocumentCopy Sets whether or not a copy of the document is used. If set to true, a copy of the document is used, so if the controller is not applied, all changes can be reverted. If set to false, no copy must be made. The document is directly changed by the controller, and changes cannot be reverted. Use the last option if a controller higher in the hierarchy has already made a copy of the document.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public propertyViewObject Gets or sets the GUI element that shows the model to the user.
(Inherited from MVCANDControllerEditImmutableDocBaseTModel, TView)
Public propertyWrapMode Gets or sets the wrap mode.
Public propertyWrapModeEnable Gets or sets a value indicating whether the wrap mode editor is enabled.
Top
Methods
 NameDescription
Public methodApply Called when the user input has to be applied to the document being controlled. Returns if applying succeeded.
(Overrides MVCANControllerEditImmutableDocBaseTModel, TViewApply(Boolean))
Protected methodApplyEnd Helper that performs the final steps of the apply operation, optionally disposing the controller.
(Inherited from MVCANDControllerEditImmutableDocBaseTModel, TView)
Protected methodAttachView Override this function to attach the view to the controller, either by subscribing to events of the view, or by setting the controller object on the view.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodCheckDocumentInitializedT Checks whether the document has been initialized and throws an exception if it is null.
(Inherited from ControllerBase)
Protected methodDetachView Override this function to detach the view from the controller, either by unsubscribing from events of the view or by setting the controller object on the view to null.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from ControllerBase)
Public methodDispose(Boolean) Releases unmanaged and, optionally, managed resources.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetSubControllers Enumerates the sub controllers. This function is called on Dispose(Boolean) of this controller to dispose the sub controllers too. By overriding this function, there is no need to override Dispose(Boolean).
(Overrides MVCANControllerEditImmutableDocBaseTModel, TViewGetSubControllers)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitialize Basic initialization of the document.
(Overrides MVCANControllerEditImmutableDocBaseTModel, TViewInitialize(Boolean))
Public methodInitializeDocument Initialize the controller with the document. If successful, the function has to return true.
(Inherited from MVCANDControllerEditImmutableDocBaseTModel, TView)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnMadeDirty Fires the MadeDirty event (if it is not suppressed).
(Overrides MVCANDControllerEditImmutableDocBaseTModel, TViewOnMadeDirty)
Public methodOnPropertyChanged Raises the PropertyChanged event.
(Inherited from ControllerBase)
Public methodRevert Tries to revert changes to the model, i.e. restores the original state of the model.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodThrowIfNotInitializedThrows an exception if the controller is not initialized with a document.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventMadeDirty Event fired when the user changed some data that will change the model.
(Inherited from MVCANDControllerEditImmutableDocBaseTModel, TView)
Public eventPropertyChangedOccurs when a property value changes.
(Inherited from ControllerBase)
Top
Fields
 NameDescription
Protected field_doc The document to edit. If _useDocumentCopy is , this is a copy of the original document; otherwise, it is the original document itself.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected field_originalDoc The original document. If _useDocumentCopy is , it may have been edited by this controller.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected field_setModelInParentModel If not null, this action is invoked during the apply stage to set the model of this controller in the parent object.
(Inherited from MVCANDControllerEditImmutableDocBaseTModel, TView)
Protected field_suppressDirtyEvent Used to suppress the MadeDirty event of this controller.
(Inherited from MVCANDControllerEditImmutableDocBaseTModel, TView)
Protected field_useDocumentCopy If , a copy of the document is made before editing; this copy can later be used to revert the state of the document to the original state.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected field_view The GUI view of this controller.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Top
See Also