Text |
Controls the view of a text document.
Inheritance HierarchyNamespace: Altaxo.Gui.Text.Viewing
Assembly: AltaxoDom (in AltaxoDom.dll) Version: 4.8.3572.0 (4.8.3572.0)
SyntaxC#
public class TextDocumentController : AbstractViewContent, IDisposable, IMVCANController, IMVCAController, IMVCController, IApplyController, ITextDocumentController
The TextDocumentController type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TextDocumentController | Initializes a new instance of the TextDocumentController class. |
| TextDocumentController(TextDocument) | Initializes a new instance of the TextDocumentController class. |
Properties| Name | Description | |
|---|---|---|
 | CloseCommand |
Gets the command that closes the view content.
(Inherited from AbstractViewContent) |
| CloseWithSolution |
Gets whether this view content should be closed when the solution is closed.
(Inherited from AbstractViewContent) |
| ContentId |
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) |
| IconSource |
Gets or sets the icon source.
(Inherited from AbstractViewContent) |
| InfoTip |
Gets or sets the informational tooltip for the view content.
(Inherited from AbstractViewContent) |
| InitiallyFocusedControl |
Gets the control which has focus initially.
(Inherited from AbstractViewContent) |
| IsActive |
Gets or sets a value indicating whether the view of this instance is active in the UI.
(Inherited from AbstractViewContent) |
| IsContentVisible |
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) |
| IsDirty |
If this property returns true the content has changed since
the last load/save operation.
(Inherited from AbstractViewContent) |
| IsDisposed |
Gets a value indicating whether the view content has been disposed.
(Inherited from AbstractViewContent) |
| IsDisposeInProgress |
Gets or sets a value indicating whether disposal is in progress.
(Inherited from AbstractViewContent) |
| IsOutlineVisible | Gets or sets a value indicating whether the outline is visible. |
| IsReadOnly |
Gets if the view content is read-only (can be saved only when choosing another file name).
(Inherited from AbstractViewContent) |
| IsSelected |
Gets or sets a value indicating whether the view of this instance is selected (e.g. inside its container).
(Inherited from AbstractViewContent) |
| IsViewOnly |
Gets if the view content is view-only (cannot be saved at all).
(Inherited from AbstractViewContent) |
| IsVisible |
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) |
| ModelObject |
Gets the model (document) that this controller manages.
(Overrides AbstractViewContentModelObject) |
| Services |
Gets or sets the service container for the view content.
(Inherited from AbstractViewContent) |
| TextDocument | Gets the text document managed by this controller. |
| Title |
Gets/Sets the title of the current tab page.
This value will be passed through the string parser before being displayed.
(Inherited from AbstractViewContent) |
| UseDocumentCopy | 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. |
| ViewObject |
Gets or sets the GUI element that shows the model to the user.
(Overrides AbstractViewContentViewObject) |
Methods| Name | Description | |
|---|---|---|
| Apply | Called when the user input has to be applied to the document being controlled. Returns if apply is successful. |
| BuildNavPoint |
Builds an INavigationPoint for the current position.
(Inherited from AbstractViewContent) |
| CanAcceptImageFileName | Tests if the provided file name could be accepted as an image. |
 | CanClose |
Determines whether the view content can be closed.
(Inherited from AbstractViewContent) |
| CanPaste | Determines whether this controller can accept the current clipboard data. If the return value is , the controller is used to paste the clipboard data via Paste; otherwise, pasting is delegated to the source editor. |
| ClearIsDirty |
Clears the dirty state.
(Inherited from AbstractViewContent) |
| CopyTextWithImages | Copies the text with the local images to the clipboard. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Overrides AbstractViewContentDispose) |
| EhBeforeCompleteRendering | Notifies the controller immediately before rendering completes. |
| EhFractionOfEditorWindowChanged | Notifies the controller that the editor window fraction changed. |
| EhIsViewerSelectedChanged | Notifies the controller that the viewer selection state changed. |
| EhReferencedImageUrlsChanged | Notifies the controller that the referenced local image URLs changed. |
| EhTitleLocalizationChanged |
Updates the title when the localized title changes.
(Inherited from AbstractViewContent) |
| EhViewerConfigurationChanged | Notifies the controller that the viewer configuration changed. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExpandTextDocumentIntoNewDocument | Expands the current text document and stores it into a new text document in the same project folder. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetService(Type) | Gets the service object of the specified type. (Inherited from AbstractViewContent) |
| GetServiceT |
Gets a required service of the specified type.
(Inherited from AbstractViewContent) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize | Initializes the view state. |
| InitializeDocument | Initializes the controller with the document. |
| InsertImageInDocumentAndGetUrl(String) | Inserts an image file into the document and returns the inserted image URL. |
| InsertImageInDocumentAndGetUrl(Stream, String) | Inserts an image stream into the document and returns the inserted image URL. |
| InsertSourceTextAtCaretPosition | Inserts the source text at caret position. |
| InternalInitializeDocument | Initializes the controller with the provided view options. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| NotifyContentIdChanged |
Can be used to notify the view content that the ContentId maybe has changed.
(Inherited from AbstractViewContent) |
| OnClose |
Closes the view content.
(Inherited from AbstractViewContent) |
| OnIsDirtyChanged |
Raises notifications that the dirty state has changed.
(Inherited from AbstractViewContent) |
| OnPropertyChanged |
Raises the PropertyChanged event.
(Inherited from AbstractViewContent) |
| Paste | Pastes data from the clipboard in the document managed by this controller. |
| PrintShowDialog | Shows the print dialog for the current document. |
| RenumerateFigures | Renumerates the figures in the current text document. |
| Revert | Try to revert changes to the model, i.e. restores the original state of the model. |
| SetDirty |
Sets the dirty state.
(Inherited from AbstractViewContent) |
| SetDisposeInProgress |
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) |
| SetLocalizedInfoTip |
Sets a localized info tip that will update automatically when the language changes.
(Inherited from AbstractViewContent) |
| SetLocalizedTitle |
Sets a localized title that will update automatically when the language changes.
(Inherited from AbstractViewContent) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | Disposed |
Occurs when the view content has been disposed.
(Inherited from AbstractViewContent) |
| IsDirtyChanged |
Occurs when the dirty state changes.
(Inherited from AbstractViewContent) |
| PropertyChanged | Occurs when a property value changes. (Inherited from AbstractViewContent) |
Fields| Name | Description | |
|---|---|---|
 | _isActive |
Stores whether the view content is active.
(Inherited from AbstractViewContent) |
| _isSelected |
Stores whether the view content is selected.
(Inherited from AbstractViewContent) |
| _isVisible |
Stores whether the view content is visible.
(Inherited from AbstractViewContent) |
| _title |
Stores the current title.
(Inherited from AbstractViewContent) |
| _titleToBeLocalized |
Stores the localized title source.
(Inherited from AbstractViewContent) |
| _view | The view associated with this controller. |
| _weakEventHandlerForDoc_TunneledEvent | Weak event handler for tunneled document events. |
See Also