Interface IDocumentEditorPresenterContainer

Defines an interface for a container that presents document editors within a UI context.

Namespace: Telerik.Windows.Documents.UI
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public interface IDocumentEditorPresenterContainer
Remarks

Implementations of this interface should manage the lifecycle and display of document editors, providing functionalities to interact with documents and their editing capabilities.

Properties

AcceptsReturn

Gets a value indicating whether the document editor presenter can accept a return key input.

Declaration
bool AcceptsReturn { get; set; }
Property Value
System.Boolean

AcceptsTab

Gets a value indicating whether the document editor presenter container accepts the Tab key for navigation.

Declaration
bool AcceptsTab { get; set; }
Property Value
System.Boolean

AllowScaling

Gets or sets a value indicating whether scaling is allowed in the document editor presenter container.

Declaration
bool AllowScaling { get; set; }
Property Value
System.Boolean

true if scaling is allowed; otherwise, false.

CaretColor

Gets or sets the color of the caret in the document editor.

Declaration
Color CaretColor { get; set; }
Property Value
System.Windows.Media.Color

A System.Windows.Media.Color representing the caret's color. The default value is typically black.

CaretFactory

Gets the caret factory used to create caret instances for the document editor presenter container.

Declaration
ICaretFactory CaretFactory { get; }
Property Value
ICaretFactory

CaretWidthScaleFactor

Retrieves the appearance settings for the specified comment.

Declaration
int CaretWidthScaleFactor { get; set; }
Property Value
System.Int32

CommentPaneMinWidth

Gets the minimum width of the comment pane in the document editor presenter container.

Declaration
double CommentPaneMinWidth { get; set; }
Property Value
System.Double

CommentTemplateContentMargin

Gets or sets the margin for the content of the comment template.

Declaration
Thickness CommentTemplateContentMargin { get; set; }
Property Value
System.Windows.Thickness

A System.Windows.Thickness value that represents the margin for the comment template content.

CurrentEditingContext

Gets the current editing context of the document editor presenter container.

Declaration
EditingContext CurrentEditingContext { get; }
Property Value
EditingContext

CurrentEditingStyle

Gets or sets the current editing style for the document editor presenter.

Declaration
StyleDefinition CurrentEditingStyle { get; }
Property Value
StyleDefinition

The current editing style applied to the document editor presenter.

Document

Gets the document associated with the document editor presenter container.

Declaration
RadDocument Document { get; }
Property Value
RadDocument

The document that is currently being edited within the container.

DocumentEditor

Gets the Document Editor associated with the presenter container.

Declaration
IDocumentEditor DocumentEditor { get; }
Property Value
IDocumentEditor

EmailPattern

Gets the email pattern used for validating email addresses within the document editor.

Declaration
string EmailPattern { get; set; }
Property Value
System.String

EnforcedPermissionRangeBrush

Gets or sets the brush used to visually represent the enforced permission range in the document editor.

Declaration
Brush EnforcedPermissionRangeBrush { get; set; }
Property Value
System.Windows.Media.Brush

A System.Windows.Media.Brush object that represents the color and style of the enforced permission range.

FieldShadingMode

Gets or sets the field shading mode for the document editor presenter container.

Declaration
FieldShadingType FieldShadingMode { get; set; }
Property Value
FieldShadingType

A value representing the field shading mode, which determines how fields are visually represented in the document editor.

HeaderFooterUIContext

Represents the context for the header and footer user interface in the document editor.

Declaration
HeaderFooterUIContext HeaderFooterUIContext { get; }
Property Value
HeaderFooterUIContext

HyperlinkPattern

Gets the hyperlink pattern associated with the document editor presenter container.

Declaration
string HyperlinkPattern { get; set; }
Property Value
System.String

IgnoredWords

Gets the list of words that are ignored during editing.

Declaration
IIgnoredWordDictionary IgnoredWords { get; set; }
Property Value
IIgnoredWordDictionary

ImageSelectionAdornerSettings

Gets or sets the settings for the image selection adorner.

Declaration
ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }
Property Value
ImageSelectionAdornerSettings

The settings that define the appearance and behavior of the image selection adorner.

IsFocusable

Gets or sets a value indicating whether the document editor presenter container is focusable.

Declaration
bool IsFocusable { get; set; }
Property Value
System.Boolean

true if the container is focusable; otherwise, false.

IsInHeaderFooterEditMode

Gets a value indicating whether the document editor is currently in header or footer edit mode.

Declaration
bool IsInHeaderFooterEditMode { get; set; }
Property Value
System.Boolean

IsReadOnly

Gets a value indicating whether the document editor presenter is in read-only mode.

Declaration
bool IsReadOnly { get; set; }
Property Value
System.Boolean

IsSpellCheckingEnabled

Gets or sets a value indicating whether spell checking is enabled for the document editor presenter.

Declaration
bool IsSpellCheckingEnabled { get; set; }
Property Value
System.Boolean

true if spell checking is enabled; otherwise, false.

ScaleFactor

Gets or sets the scale factor applied to the document editor presenter container.

Declaration
Size ScaleFactor { get; set; }
Property Value
System.Windows.Size

A System.Windows.Size structure representing the horizontal and vertical scale factors.

SelectedComment

Gets or sets the currently selected comment in the document editor presenter container.

Declaration
Comment SelectedComment { get; set; }
Property Value
Comment

SelectedNote

Gets the currently selected note in the document editor presenter container.

Declaration
Note SelectedNote { get; set; }
Property Value
Note

SelectionFill

Gets or sets the selection fill of the document editor presenter container.

Declaration
Brush SelectionFill { get; set; }
Property Value
System.Windows.Media.Brush

SelectionStroke

Represents the stroke used for the selection in the document editor presenter container.

Declaration
Brush SelectionStroke { get; set; }
Property Value
System.Windows.Media.Brush

ShouldShowSelectionMarkers

Gets a value indicating whether selection markers should be shown in the document editor.

Declaration
bool ShouldShowSelectionMarkers { get; }
Property Value
System.Boolean

ShowComments

Displays the comments associated with the document in the presenter container.

Declaration
bool ShowComments { get; set; }
Property Value
System.Boolean

ShowFormattingSymbols

Displays formatting symbols within the document editor, allowing users to see the underlying structure of the document's formatting.

Declaration
bool ShowFormattingSymbols { get; set; }
Property Value
System.Boolean

SpellChecker

Gets the spell checker associated with the document editor presenter container.

Declaration
ISpellChecker SpellChecker { get; set; }
Property Value
ISpellChecker

UILayersBuilder

Gets the UI layers builder responsible for constructing UI layers in the document editor presenter container.

Declaration
UILayersBuilder UILayersBuilder { get; }
Property Value
UILayersBuilder

UsePreviousVersionOfMicrosoftIme

Gets or sets a value indicating whether the previous version of Microsoft IME should be used.

Declaration
bool UsePreviousVersionOfMicrosoftIme { get; set; }
Property Value
System.Boolean

true to use the previous version of Microsoft IME; otherwise, false.

Methods

CallOnNoteReferenceClicked(MouseButtonEventArgs)

Invoked when a note reference is clicked within the document editor.

Declaration
void CallOnNoteReferenceClicked(MouseButtonEventArgs args)
Parameters
System.Windows.Input.MouseButtonEventArgs args

The mouse button event arguments containing details about the click event.

GetApperanceSettingsForComment(Comment)

Declaration
CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)
Parameters
Comment comment

Returns
CommentAppearanceSettings

GetUIProviderRegistry()

Retrieves the registry of UI providers associated with the document editor presenter container.

Declaration
UIProviderRegistry GetUIProviderRegistry()
Returns
UIProviderRegistry

An instance of the UIProviderRegistry that contains the available UI providers.

HideSelectionMarkers()

Hides the selection markers in the document editor presenter container.

Declaration
void HideSelectionMarkers()

InvalidateEditorArrange()

Invalidates the arrangement of the editor, prompting a re-evaluation of its layout.

Declaration
void InvalidateEditorArrange()
Remarks

This method is typically used when changes have occurred that may affect the layout of the editor and require a refresh to ensure that all elements are displayed correctly.

InvalidateEditorMeasure()

Invalidates the measurement of the editor, causing it to recalculate its layout and size.

Declaration
void InvalidateEditorMeasure()

ScrollToNote(Note)

Scrolls the document view to the specified note, bringing it into view.

Declaration
void ScrollToNote(Note note)
Parameters
Note note

The note to which the document view should scroll.

SetActiveDocumentEditor(IDocumentEditor, DocumentEditorType)

Sets the active document editor for the presenter container.

Declaration
void SetActiveDocumentEditor(IDocumentEditor documentEditor, DocumentEditorType documentEditorType)
Parameters
IDocumentEditor documentEditor

The document editor to be set as active.
DocumentEditorType documentEditorType

The type of the document editor being set.

ShowSelectionMarkers()

Displays the selection markers in the document editor presenter container.

Declaration
void ShowSelectionMarkers()

TrackCurrentEditingStyles()

Tracks the current editing styles in the document editor presenter container.

Declaration
void TrackCurrentEditingStyles()

UpdateCurrentEditingStyle()

Updates the current editing style of the document editor presenter.

Declaration
void UpdateCurrentEditingStyle()

UpdateCurrentVisiblePage(Int32)

Updates the currently visible page in the document editor presenter container.

Declaration
void UpdateCurrentVisiblePage(int newValue)
Parameters
System.Int32 newValue

The index of the page to be made visible.

UpdateEditorLayout()

Updates the layout of the document editor within the presenter container.

Declaration
void UpdateEditorLayout()

Events

ProtectionStateChanged

Declaration
event EventHandler ProtectionStateChanged
Event Type
System.EventHandler

ScaleFactorChanged

Declaration
event EventHandler ScaleFactorChanged
Event Type
System.EventHandler

Extension Methods