Click or drag to resize

ActionDocumentController Class

Controls the view of an action document.
Inheritance Hierarchy
SystemObject
  Altaxo.Gui.WorkbenchAbstractViewContent
    Altaxo.Gui.Actions.ViewingActionDocumentController

Namespace: Altaxo.Gui.Actions.Viewing
Assembly: AltaxoDom (in AltaxoDom.dll) Version: 4.8.3618.0 (4.8.3618.0)
Syntax
C#
public class ActionDocumentController : AbstractViewContent, 
	IDisposable, IMVCANController, IMVCAController, IMVCController, IApplyController

The ActionDocumentController type exposes the following members.

Constructors
 NameDescription
Public methodActionDocumentController Initializes a new instance of the ActionDocumentController class.
Public methodActionDocumentController(ActionDocument) Initializes a new instance of the ActionDocumentController class.
Top
Properties
 NameDescription
Public propertyActionController Gets or sets the action controller associated with this document controller.
Public propertyActionDescription Gets or sets the description of the action associated with this document.
Public propertyActionDocument Gets the action document managed by this controller.
Public propertyCloseCommand Gets the command that closes the view content.
(Inherited from AbstractViewContent)
Public propertyCloseWithSolution Gets whether this view content should be closed when the solution is closed.
(Inherited from AbstractViewContent)
Public propertyCmdExecute Gets the command to execute the action associated with this document.
Public propertyContentId Gets or sets the content identifier. Here, the content identifier is calculated of the reference hash of the document. Setting is not implemented here.
(Inherited from AbstractViewContent)
Public propertyIconSource Gets or sets the icon source.
(Inherited from AbstractViewContent)
Public propertyInfoTip Gets or sets the informational tooltip for the view content.
(Inherited from AbstractViewContent)
Public propertyInitiallyFocusedControl Gets the control which has focus initially.
(Inherited from AbstractViewContent)
Public propertyIsActive Gets or sets a value indicating whether the view of this instance is active in the UI.
(Inherited from AbstractViewContent)
Public propertyIsContentVisible Gets a value indicating whether the content of this document window is visible (it is if either IsActive or IsSelected is visible.
(Inherited from AbstractViewContent)
Public propertyIsDirty If this property returns true the content has changed since the last load/save operation.
(Inherited from AbstractViewContent)
Public propertyIsDisposed Gets a value indicating whether the view content has been disposed.
(Inherited from AbstractViewContent)
Public propertyIsDisposeInProgress Gets or sets a value indicating whether disposal is in progress.
(Inherited from AbstractViewContent)
Public propertyIsReadOnly Gets if the view content is read-only (can be saved only when choosing another file name).
(Inherited from AbstractViewContent)
Public propertyIsSelected Gets or sets a value indicating whether the view of this instance is selected (e.g. inside its container).
(Inherited from AbstractViewContent)
Public propertyIsViewOnly Gets if the view content is view-only (cannot be saved at all).
(Inherited from AbstractViewContent)
Public propertyIsVisible Gets or sets the visibility of the document. If false, the document tab header is not visible (but the document itself maybe visible !). If true, the document tab header is visible (if it fits in the bar), and the document is visible, if it is selected, too.
(Inherited from AbstractViewContent)
Public propertyModelObject Gets the model (document) that this controller manages.
(Overrides AbstractViewContentModelObject)
Public propertyServices Gets or sets the service container for the view content.
(Inherited from AbstractViewContent)
Public propertyTitle Gets/Sets the title of the current tab page. This value will be passed through the string parser before being displayed.
(Inherited from AbstractViewContent)
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.
Public propertyViewObject Gets or sets the GUI element that shows the model to the user.
(Overrides AbstractViewContentViewObject)
Top
Methods
 NameDescription
Public methodApply Called when the user input has to be applied to the document being controlled. Returns if apply is successful.
Public methodBuildNavPoint Builds an INavigationPoint for the current position.
(Inherited from AbstractViewContent)
Protected methodCanClose Determines whether the view content can be closed.
(Inherited from AbstractViewContent)
Public methodCanPaste 
Public methodClearIsDirty Clears the dirty state.
(Inherited from AbstractViewContent)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Overrides AbstractViewContentDispose)
Protected methodEhTitleLocalizationChanged Updates the title when the localized title changes.
(Inherited from AbstractViewContent)
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 methodGetService(Type)Gets the service object of the specified type.
(Inherited from AbstractViewContent)
Public methodGetServiceT Gets a required service of the specified type.
(Inherited from AbstractViewContent)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitialize Initializes the view state.
Public methodInitializeDocument Initializes the controller with the document.
Protected methodInternalInitializeDocument Initializes the controller with the provided view options.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodNotifyContentIdChanged Can be used to notify the view content that the ContentId maybe has changed.
(Inherited from AbstractViewContent)
Protected methodOnClose Closes the view content.
(Inherited from AbstractViewContent)
Public methodOnIsDirtyChanged Raises notifications that the dirty state has changed.
(Inherited from AbstractViewContent)
Protected methodOnPropertyChanged Raises the PropertyChanged event.
(Inherited from AbstractViewContent)
Public methodPaste 
Public methodRevert Try to revert changes to the model, i.e. restores the original state of the model.
Public methodSetDirty Sets the dirty state.
(Inherited from AbstractViewContent)
Public methodSetDisposeInProgress Announces that this view content is about to be disposed very soon. The view content should remain passiv (e.g. should not react to events any more), but should not release its resources yet (this is done later in Dispose).
(Inherited from AbstractViewContent)
Protected methodSetLocalizedInfoTip Sets a localized info tip that will update automatically when the language changes.
(Inherited from AbstractViewContent)
Protected methodSetLocalizedTitle Sets a localized title that will update automatically when the language changes.
(Inherited from AbstractViewContent)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventDisposed Occurs when the view content has been disposed.
(Inherited from AbstractViewContent)
Public eventIsDirtyChanged Occurs when the dirty state changes.
(Inherited from AbstractViewContent)
Public eventPropertyChangedOccurs when a property value changes.
(Inherited from AbstractViewContent)
Top
Fields
 NameDescription
Protected field_doc The action document that this controller manages.
Protected field_isActive Stores whether the view content is active.
(Inherited from AbstractViewContent)
Protected field_isSelected Stores whether the view content is selected.
(Inherited from AbstractViewContent)
Protected field_isVisible Stores whether the view content is visible.
(Inherited from AbstractViewContent)
Protected field_title Stores the current title.
(Inherited from AbstractViewContent)
Protected field_titleToBeLocalized Stores the localized title source.
(Inherited from AbstractViewContent)
Protected field_view The view associated with this controller.
Protected field_weakEventHandlerForDoc_TunneledEvent Weak event handler for tunneled document events.
Top
See Also