InterfaceIDocumentEditorPresenterContainer
Defines an interface for a container that presents document editors within a UI context.
Definition
Namespace:Telerik.Windows.Documents.UI
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public interface IDocumentEditorPresenterContainerProperties
AcceptsReturn
Gets a value indicating whether the document editor presenter can accept a return key input.
AcceptsTab
Gets a value indicating whether the document editor presenter container accepts the Tab key for navigation.
AllowScaling
Gets or sets a value indicating whether scaling is allowed in the document editor presenter container.
Declaration
bool AllowScaling { get; set; }Property Value
true if scaling is allowed; otherwise, false.
AutoInsertHyperlinks
Gets or sets a value indicating whether hyperlinks should be automatically inserted.
Declaration
bool AutoInsertHyperlinks { get; set; }Property Value
true if hyperlinks should be automatically inserted; otherwise, false.
CaretColor
Gets or sets the color of the caret in the document editor.
Declaration
Color CaretColor { get; set; }Property Value
Color
A 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.
CaretWidthScaleFactor
Retrieves the appearance settings for the specified comment.
CommentPaneMinWidth
Gets the minimum width of the comment pane in the document editor presenter container.
CommentTemplateContentMargin
Gets or sets the margin for the content of the comment template.
Declaration
Thickness CommentTemplateContentMargin { get; set; }Property Value
Thickness
A 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
CurrentEditingStyle
Gets or sets the current editing style for the document editor presenter.
Declaration
StyleDefinition CurrentEditingStyle { get; }Property Value
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
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
EmailPattern
Gets the email pattern used for validating email addresses within the document editor.
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
Brush
A 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
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
HyperlinkPattern
Gets the hyperlink pattern associated with the document editor presenter container.
IgnoredWords
Gets the list of words that are ignored during editing.
Declaration
IIgnoredWordDictionary IgnoredWords { get; set; }Property Value
ImageSelectionAdornerSettings
Gets or sets the settings for the image selection adorner.
Declaration
ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }Property Value
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
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.
IsReadOnly
Gets a value indicating whether the document editor presenter is in read-only mode.
IsSpellCheckingEnabled
Gets or sets a value indicating whether spell checking is enabled for the document editor presenter.
Declaration
bool IsSpellCheckingEnabled { get; set; }Property Value
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
Size
A Size structure representing the horizontal and vertical scale factors.
SelectedComment
Gets or sets the currently selected comment in the document editor presenter container.
SelectedNote
Gets the currently selected note in the document editor presenter container.
SelectionFill
Gets or sets the selection fill of the document editor presenter container.
Declaration
Brush SelectionFill { get; set; }Property Value
Brush
SelectionStroke
Represents the stroke used for the selection in the document editor presenter container.
Declaration
Brush SelectionStroke { get; set; }Property Value
Brush
ShouldShowSelectionMarkers
Gets a value indicating whether selection markers should be shown in the document editor.
ShowComments
Displays the comments associated with the document in the presenter container.
ShowFormattingSymbols
Displays formatting symbols within the document editor, allowing users to see the underlying structure of the document's formatting.
SpellChecker
Gets the spell checker associated with the document editor presenter container.
UILayersBuilder
Gets the UI layers builder responsible for constructing UI layers in the document editor presenter container.
Declaration
UILayersBuilder UILayersBuilder { get; }Property Value
UsePreviousVersionOfMicrosoftIme
Gets or sets a value indicating whether the previous version of Microsoft IME should be used.
Declaration
bool UsePreviousVersionOfMicrosoftIme { get; set; }Property Value
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
args
MouseButtonEventArgs
The mouse button event arguments containing details about the click event.
GetApperanceSettingsForComment(Comment)
Declaration
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Apperance")]
CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)Parameters
comment
Returns
GetUIProviderRegistry()
Retrieves the registry of UI providers associated with the document editor presenter container.
Declaration
UIProviderRegistry GetUIProviderRegistry()Returns
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
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
documentEditor
The document editor to be set as active.
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(int)
Updates the currently visible page in the document editor presenter container.
Declaration
void UpdateCurrentVisiblePage(int newValue)Parameters
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()