Click or drag to resize

StyleListControllerTManager, TList, TItem Class

Controller for editing named style lists.
Inheritance Hierarchy

Namespace: Altaxo.Gui.Drawing
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
Copy
public class StyleListController<TManager, TList, TItem> : MVCANControllerEditImmutableDocBase<TList, IStyleListView>, 
	IStyleListController
where TManager : Object, IStyleListManager<TList, TItem>
where TList : Object, IStyleList<TItem>
where TItem : IImmutable

Type Parameters

TManager
The type of the style list manager.
TList
The type of the style list.
TItem
The type of the style list item.

The StyleListControllerTManager, TList, TItem type exposes the following members.

Constructors
 NameDescription
Public methodStyleListControllerTManager, TList, TItem Initializes a new instance of the StyleListControllerTManager, TList, TItem class.
Top
Properties
 NameDescription
Public propertyAvailableItems Gets the available style items.
Public propertyAvailableItemsDragDropHandler Gets the drag-and-drop handler for available items.
Public propertyAvailableLists Gets the available style lists.
Public propertyCmdAvailableItem_AddToCurrent Gets the command that adds selected available items to the current list.
Public propertyCmdCurrentItem_Edit Gets the command that edits the selected current item.
Public propertyCmdCurrentItem_MoveDown Gets the command that moves selected current items down.
Public propertyCmdCurrentItem_MoveUp Gets the command that moves selected current items up.
Public propertyCmdCurrentItem_Remove Gets the command that removes selected current items.
Public propertyCmdCurrentList_Store Gets the command that stores the current list.
Public propertyCurrentItems Gets or sets the items in the current editable list.
Public propertyCurrentItemsDragDropHandler Gets the drag-and-drop handler for current items.
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)
Public propertyNewListNameIsEnabled Gets or sets a value indicating whether the list name can be edited.
Public propertyNewListNameIsMarked Gets or sets a value indicating whether the list name should be highlighted.
Public propertyNewListNameText Gets or sets the proposed name of the current list.
Public propertyNewListNameToolTip Gets or sets the tooltip shown for the list name.
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 propertyStoreInUserSettings Gets or sets a value indicating whether the list should be stored at user level.
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 MVCANControllerEditImmutableDocBaseTModel, TView)
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 MVCANControllerEditImmutableDocBaseTModel, 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 methodController_AvailableItems_Initialize Initializes the collection of available style items.
Protected methodController_CurrentItems_Initialize Initializes the collection of items in the current list.
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)
Protected methodEhAvailableItem_AddToCurrent Adds the currently selected available item to the current list.
Protected methodEhCurrentItem_Edit Edits the currently selected item.
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 Initializes the controller with the document.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodIsItemEditable Determines whether the specified item can be edited.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
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 methodSetListDirty Marks the current list as dirty and updates the associated UI state.
Protected methodThrowIfNotInitializedThrows an exception if the controller is not initialized with a document.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodToDisplayName(TItem) Converts a style item to the display text shown in the UI.
Protected methodToDisplayName(Type) Converts a style item type to the display text shown in the UI.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventPropertyChangedOccurs when a property value changes.
(Inherited from ControllerBase)
Top
Fields
 NameDescription
Protected field_availableItemsRootNode Root node for the tree of available style items.
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_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