IDocumentEditorPresenterContainer
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 IDocumentEditorPresenterContainerDerived Classes:
Properties
Gets a value indicating whether the document editor presenter can accept a return key input.
bool AcceptsReturn { get; set; }Gets a value indicating whether the document editor presenter container accepts the Tab key for navigation.
bool AcceptsTab { get; set; }Gets or sets a value indicating whether scaling is allowed in the document editor presenter container.
bool AllowScaling { get; set; }true if scaling is allowed; otherwise, false.
Gets or sets a value indicating whether hyperlinks should be automatically inserted.
bool AutoInsertHyperlinks { get; set; }true if hyperlinks should be automatically inserted; otherwise, false.
CaretColor
Color
Gets or sets the color of the caret in the document editor.
Color CaretColor { get; set; }A Color representing the caret's color. The default value is typically black.
Gets the caret factory used to create caret instances for the document editor presenter container.
ICaretFactory CaretFactory { get; }Retrieves the appearance settings for the specified comment.
int CaretWidthScaleFactor { get; set; }Gets the minimum width of the comment pane in the document editor presenter container.
double CommentPaneMinWidth { get; set; }CommentTemplateContentMargin
Thickness
Gets or sets the margin for the content of the comment template.
Thickness CommentTemplateContentMargin { get; set; }A Thickness value that represents the margin for the comment template content.
Gets the current editing context of the document editor presenter container.
EditingContext CurrentEditingContext { get; }Gets or sets the current editing style for the document editor presenter.
StyleDefinition CurrentEditingStyle { get; }The current editing style applied to the document editor presenter.
Gets the document associated with the document editor presenter container.
RadDocument Document { get; }The document that is currently being edited within the container.
Gets the Document Editor associated with the presenter container.
IDocumentEditor DocumentEditor { get; }Gets the email pattern used for validating email addresses within the document editor.
string EmailPattern { get; set; }Gets or sets the brush used to visually represent the enforced permission range in the document editor.
Brush EnforcedPermissionRangeBrush { get; set; }A Brush object that represents the color and style of the enforced permission range.
Gets or sets the field shading mode for the document editor presenter container.
FieldShadingType FieldShadingMode { get; set; }A value representing the field shading mode, which determines how fields are visually represented in the document editor.
Represents the context for the header and footer user interface in the document editor.
HeaderFooterUIContext HeaderFooterUIContext { get; }Gets the hyperlink pattern associated with the document editor presenter container.
string HyperlinkPattern { get; set; }Gets the list of words that are ignored during editing.
IIgnoredWordDictionary IgnoredWords { get; set; }Gets or sets the settings for the image selection adorner.
ImageSelectionAdornerSettings ImageSelectionAdornerSettings { get; }The settings that define the appearance and behavior of the image selection adorner.
Gets or sets a value indicating whether the document editor presenter container is focusable.
bool IsFocusable { get; set; }true if the container is focusable; otherwise, false.
Gets a value indicating whether the document editor is currently in header or footer edit mode.
bool IsInHeaderFooterEditMode { get; set; }Gets a value indicating whether the document editor presenter is in read-only mode.
bool IsReadOnly { get; set; }Gets or sets a value indicating whether spell checking is enabled for the document editor presenter.
bool IsSpellCheckingEnabled { get; set; }true if spell checking is enabled; otherwise, false.
ScaleFactor
Size
Gets or sets the scale factor applied to the document editor presenter container.
Size ScaleFactor { get; set; }A Size structure representing the horizontal and vertical scale factors.
Gets or sets the currently selected comment in the document editor presenter container.
Comment SelectedComment { get; set; }Gets the currently selected note in the document editor presenter container.
Note SelectedNote { get; set; }SelectionFill
Brush
Gets or sets the selection fill of the document editor presenter container.
Brush SelectionFill { get; set; }SelectionStroke
Brush
Represents the stroke used for the selection in the document editor presenter container.
Brush SelectionStroke { get; set; }Gets a value indicating whether selection markers should be shown in the document editor.
bool ShouldShowSelectionMarkers { get; }Displays the comments associated with the document in the presenter container.
bool ShowComments { get; set; }Displays formatting symbols within the document editor, allowing users to see the underlying structure of the document's formatting.
bool ShowFormattingSymbols { get; set; }Gets the spell checker associated with the document editor presenter container.
ISpellChecker SpellChecker { get; set; }Gets the UI layers builder responsible for constructing UI layers in the document editor presenter container.
UILayersBuilder UILayersBuilder { get; }Gets or sets a value indicating whether the previous version of Microsoft IME should be used.
bool UsePreviousVersionOfMicrosoftIme { get; set; }true to use the previous version of Microsoft IME; otherwise, false.
Methods
Invoked when a note reference is clicked within the document editor.
void CallOnNoteReferenceClicked(MouseButtonEventArgs args)The mouse button event arguments containing details about the click event.
CommentAppearanceSettings GetApperanceSettingsForComment(Comment comment)Retrieves the registry of UI providers associated with the document editor presenter container.
UIProviderRegistry GetUIProviderRegistry()An instance of the UIProviderRegistry that contains the available UI providers.
Hides the selection markers in the document editor presenter container.
void HideSelectionMarkers()Invalidates the arrangement of the editor, prompting a re-evaluation of its layout.
void InvalidateEditorArrange()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.
Invalidates the measurement of the editor, causing it to recalculate its layout and size.
void InvalidateEditorMeasure()Scrolls the document view to the specified note, bringing it into view.
void ScrollToNote(Note note)The note to which the document view should scroll.
Sets the active document editor for the presenter container.
void SetActiveDocumentEditor(IDocumentEditor documentEditor, DocumentEditorType documentEditorType)The document editor to be set as active.
documentEditorTypeDocumentEditorTypeThe type of the document editor being set.
Displays the selection markers in the document editor presenter container.
void ShowSelectionMarkers()Tracks the current editing styles in the document editor presenter container.
void TrackCurrentEditingStyles()Updates the current editing style of the document editor presenter.
void UpdateCurrentEditingStyle()Updates the currently visible page in the document editor presenter container.
void UpdateCurrentVisiblePage(int newValue)The index of the page to be made visible.
Updates the layout of the document editor within the presenter container.
void UpdateEditorLayout()Events
event EventHandler ProtectionStateChangedevent EventHandler ScaleFactorChanged