IDocumentEditorPresenterContainer
Exposes document, view, and editing state consumed by document presenters and UI layers.
Definition
Namespace:Telerik.WinForms.Documents.UI
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public interface IDocumentEditorPresenterContainer
Properties
Gets or sets whether pressing Enter inserts a paragraph break in the document.
bool AcceptsReturn { get; set; }
Gets or sets whether pressing Tab inserts a tab in the document instead of moving focus.
bool AcceptsTab { get; set; }
Gets or sets whether changes to ScaleFactor are applied.
bool AllowScaling { get; set; }
Gets or sets whether text matching HyperlinkPattern or EmailPattern is automatically inserted as a hyperlink.
bool AutoInsertHyperlinks { get; set; }
Gets or sets the color used to render the document caret.
Color CaretColor { get; set; }
Gets the factory used to create the document caret.
ICaretFactory CaretFactory { get; }
Gets or sets the minimum width reserved for the comment pane in document layouts.
double CommentPaneMinWidth { get; set; }
Gets or sets the space reserved around content in a comment template.
Thickness CommentTemplateContentMargin { get; set; }
Gets the editing context for the currently active document editor.
EditingContext CurrentEditingContext { get; }
Gets the style object that reflects the current editing position and selection.
StyleDefinition CurrentEditingStyle { get; }
Gets the document displayed and edited through this container.
RadDocument Document { get; }
Gets the editor abstraction used to perform operations on the active document.
IDocumentEditor DocumentEditor { get; }
Gets or sets the regular expression used to recognize email addresses during automatic hyperlink insertion.
string EmailPattern { get; set; }
Gets or sets the brush used to highlight ranges with enforced editing permissions.
Brush EnforcedPermissionRangeBrush { get; set; }
Gets or sets when document fields are shaded: always, only while selected, or never.
FieldShadingType FieldShadingMode { get; set; }
Gets the shared interaction state used to coordinate header and footer presenters.
HeaderFooterUIContext HeaderFooterUIContext { get; }
Gets or sets the regular expression used to recognize hyperlink text during automatic insertion.
string HyperlinkPattern { get; set; }
Gets or sets the word dictionary consulted to suppress spell-checking results.
IIgnoredWordDictionary IgnoredWords { get; set; }
Gets the settings shared with presenter-owned image-selection adorners.
ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }
Gets or sets whether the document area can receive keyboard focus.
bool IsFocusable { get; set; }
Gets or sets whether the active editor is editing a document header or footer.
bool IsInHeaderFooterEditMode { get; set; }
Gets or sets whether editing commands are disabled while navigation and non-editing operations remain available.
bool IsReadOnly { get; set; }
Gets or sets whether spell-checking decorations are enabled for the document.
bool IsSpellCheckingEnabled { get; set; }
Gets or sets the horizontal and vertical scale applied to the document view. Assignments are ignored when AllowScaling is false.
Size ScaleFactor { get; set; }
Gets or sets the comment selected for editing. Setting this property clears the current selection and selects the comment's annotation range when the value is non-null.
Comment SelectedComment { get; set; }
The assigned comment does not belong to the current document.
Gets or sets the note selected in the document.
Note SelectedNote { get; set; }
Gets or sets the brush used to fill selected document content.
Brush SelectionFill { get; set; }
Gets or sets the brush used to outline selected document content.
Brush SelectionStroke { get; set; }
Gets whether the selection layer should display markers at the selection endpoints.
bool ShouldShowSelectionMarkers { get; }
Gets or sets whether comment annotations are displayed in the document.
bool ShowComments { get; set; }
Gets or sets whether nonprinting formatting marks are displayed in the document.
bool ShowFormattingSymbols { get; set; }
Gets or sets the spell checker used to proofread the document.
ISpellChecker SpellChecker { get; set; }
Gets the builder that supplies the visual layers used by document presenters.
UILayersBuilder UILayersBuilder { get; }
Methods
Forwards a click on a note reference to the editor's note-reference event.
void CallOnNoteReferenceClicked(MouseButtonEventArgs args)
The mouse input associated with the click.
Creates the display settings for a comment and exposes them to the comment-showing customization event.
CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)
The comment whose display settings are being created.
Returns:The settings used to display the comment after customization.
Gets the shared registry used by presenters to create and release document UI providers.
Hides selection endpoint markers and invalidates the editor layout.
void HideSelectionMarkers()
Requests an arrange pass from the active document presenter.
void InvalidateEditorArrange()
Requests a measure pass from the active document presenter.
void InvalidateEditorMeasure()
Scrolls the active presenter until the specified note is visible.
Activates the editor associated with the specified document area.
void SetActiveDocumentEditor(IDocumentEditor documentEditor, DocumentEditorType documentEditorType)
The editor instance to activate.
documentEditorTypeDocumentEditorTypeThe document area associated with the editor.
Exceptions: InvalidOperationExceptionThe main document is assigned to an editor other than this container's editor.
NotSupportedExceptionThe editor is not a RadRichTextBox instance.
Shows selection endpoint markers and invalidates the editor layout.
void ShowSelectionMarkers()
This operation currently has no effect in the WinForms editor implementation.
void TrackCurrentEditingStyles()
Refreshes the current editing style from the active document selection.
void UpdateCurrentEditingStyle()
Updates the current visible page value reported by the active presenter.
void UpdateCurrentVisiblePage(int newValue)
The visible page value reported by the presenter.
Forces the active document view to recalculate its layout and refresh its visuals.
void UpdateEditorLayout()
Events
Occurs when the document's protection or permission state changes.
event EventHandler ProtectionStateChanged
Occurs when the document view scale changes.
event EventHandler ScaleFactorChanged