Class SfRichTextBoxAdv

Represents the root element of a rich text editing control which operates on DocumentAdv objects.

Inheritance

System.Object

SfRichTextBoxAdv

Namespace: Syncfusion.UI.Xaml.RichTextBoxAdv

Assembly: Syncfusion.SfRichTextBoxAdv.UWP.dll

Syntax

public class SfRichTextBoxAdv : Control

Examples

The following code example demonstrates how to define the SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" ManipulationMode="All" xmlns:RichTextBoxAdv="using:Syncfusion.UI.Xaml.RichTextBoxAdv">
        <RichTextBoxAdv:DocumentAdv>
        <RichTextBoxAdv:SectionAdv>
            <RichTextBoxAdv:ParagraphAdv>
                <RichTextBoxAdv:SpanAdv>Hello World.</RichTextBoxAdv:SpanAdv>
            </RichTextBoxAdv:ParagraphAdv>
        </RichTextBoxAdv:SectionAdv>
    </RichTextBoxAdv:DocumentAdv>
</RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the control.
Syncfusion.UI.Xaml.RichTextBoxAdv.SfRichTextBoxAdv richTextBoxAdv = new Syncfusion.UI.Xaml.RichTextBoxAdv.SfRichTextBoxAdv();
richTextBoxAdv.ManipulationMode = ManipulationMode.All;
DocumentAdv documentAdv = new DocumentAdv();
SectionAdv sectionAdv = new SectionAdv();
ParagraphAdv paragraphAdv = new ParagraphAdv();
SpanAdv spanAdv = new SpanAdv();
spanAdv.Text = "Hello world.";
paragraphAdv.Inlines.Add(spanAdv);
sectionAdv.Blocks.Add(paragraphAdv);
documentAdv.Sections.Add(sectionAdv);
// Defines the document for SfRichTextBoxAdv control.
richTextBoxAdv.Document = documentAdv;

' Defines the control.
Dim richTextBoxAdv As New Syncfusion.UI.Xaml.RichTextBoxAdv.SfRichTextBoxAdv()
richTextBoxAdv.ManipulationMode = ManipulationMode.All

Dim documentAdv As New DocumentAdv()
Dim sectionAdv As New SectionAdv()
Dim paragraphAdv As New ParagraphAdv()
Dim spanAdv As New SpanAdv()
spanAdv.Text = "Hello world."

paragraphAdv.Inlines.Add(spanAdv)
sectionAdv.Blocks.Add(paragraphAdv)
documentAdv.Sections.Add(sectionAdv)

' Defines the document for SfRichTextBoxAdv control.
richTextBoxAdv.Document = documentAdv

Constructors

SfRichTextBoxAdv()

Initializes a new instance of the SfRichTextBoxAdv class.

Declaration

public SfRichTextBoxAdv()

Fields

AcceptsTabProperty

Identifies the AcceptsTab dependency property.

Declaration

public static readonly DependencyProperty AcceptsTabProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the AcceptsTab dependency property.

AddToDictionaryCommandProperty

Identifies the AddToDictionaryCommand dependency property.

Declaration

public static readonly DependencyProperty AddToDictionaryCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the AddToDictionaryCommand dependency property.

AfterSpacingCommandProperty

Identifies the AfterSpacingCommand dependency property.

Declaration

public static readonly DependencyProperty AfterSpacingCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the AfterSpacingCommand dependency property.

ApplyStyleCommandProperty

Identifies the ApplyStyleCommand dependency property.

Declaration

public static readonly DependencyProperty ApplyStyleCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ApplyStyleCommand dependency property.

AutoFitTableCommandProperty

Identifies the AutoFitTableCommand dependency property.

Declaration

public static readonly DependencyProperty AutoFitTableCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the AutoFitTableCommand dependency property.

BaselineAlignmentCommandProperty

Identifies the BaselineAlignmentCommand dependency property.

Declaration

public static readonly DependencyProperty BaselineAlignmentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the BaselineAlignmentCommand dependency property.

BeforeSpacingCommandProperty

Identifies the BeforeSpacingCommand dependency property.

Declaration

public static readonly DependencyProperty BeforeSpacingCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the BeforeSpacingCommand dependency property.

BoldCommandProperty

Identifies the BoldCommand dependency property.

Declaration

public static readonly DependencyProperty BoldCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the BoldCommand dependency property.

CaretBrushProperty

Identifies the CaretBrush dependency property.

Declaration

public static readonly DependencyProperty CaretBrushProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CaretBrush dependency property.

CaretWidthProperty

Identifies the CaretWidth dependency property.

Declaration

public static readonly DependencyProperty CaretWidthProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CaretWidth dependency property.

CellBottomMarginCommandProperty

Identifies the CellBottomMarginCommand dependency property.

Declaration

public static readonly DependencyProperty CellBottomMarginCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CellBottomMarginCommand dependency property.

CellContentAlignmentCommandProperty

Identifies the CellContentAlignmentCommand dependency property.

Declaration

public static readonly DependencyProperty CellContentAlignmentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CellContentAlignmentCommand dependency property.

CellLeftMarginCommandProperty

Identifies the CellLeftMarginCommand dependency property.

Declaration

public static readonly DependencyProperty CellLeftMarginCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CellLeftMarginCommand dependency property.

CellRightMarginCommandProperty

Identifies the CellRightMarginCommand dependency property.

Declaration

public static readonly DependencyProperty CellRightMarginCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CellRightMarginCommand dependency property.

CellSpacingCommandProperty

Identifies the CellSpacingCommand dependency property.

Declaration

public static readonly DependencyProperty CellSpacingCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CellSpacingCommand dependency property.

CellTopMarginCommandProperty

Identifies the CellTopMarginCommand dependency property.

Declaration

public static readonly DependencyProperty CellTopMarginCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CellTopMarginCommand dependency property.

CellVerticalAlignmentCommandProperty

Identifies the CellVerticalAlignmentCommand dependency property.

Declaration

public static readonly DependencyProperty CellVerticalAlignmentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CellVerticalAlignmentCommand dependency property.

ChangeAllSpellingCommandProperty

Identifies the ChangeAllSpellingCommand dependency property.

Declaration

public static readonly DependencyProperty ChangeAllSpellingCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ChangeAllSpellingCommand dependency property.

ChangeSpellingCommandProperty

Identifies the ChangeSpellingCommand dependency property.

Declaration

public static readonly DependencyProperty ChangeSpellingCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ChangeSpellingCommand dependency property.

CheckSpellingCommandProperty

Identifies the CheckSpellingCommand dependency property.

Declaration

public static readonly DependencyProperty CheckSpellingCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CheckSpellingCommand dependency property.

ClearFormattingCommandProperty

Identifies the ClearFormattingCommand dependency property.

Declaration

public static readonly DependencyProperty ClearFormattingCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ClearFormattingCommand dependency property.

CopyCommandProperty

Identifies the CopyCommand dependency property.

Declaration

public static readonly DependencyProperty CopyCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CopyCommand dependency property.

CopyHyperlinkCommandProperty

Identifies the CopyHyperlinkCommand dependency property.

Declaration

public static readonly DependencyProperty CopyHyperlinkCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CopyHyperlinkCommand dependency property.

CutCommandProperty

Identifies the CutCommand dependency property.

Declaration

public static readonly DependencyProperty CutCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the CutCommand dependency property.

DecreaseIndentCommandProperty

Identifies the DecreaseIndentCommand dependency property.

Declaration

public static readonly DependencyProperty DecreaseIndentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DecreaseIndentCommand dependency property.

DefaultCellBottomMarginCommandProperty

Identifies the DefaultCellBottomMarginCommand dependency property.

Declaration

public static readonly DependencyProperty DefaultCellBottomMarginCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DefaultCellBottomMarginCommand dependency property.

DefaultCellLeftMarginCommandProperty

Identifies the DefaultCellLeftMarginCommand dependency property.

Declaration

public static readonly DependencyProperty DefaultCellLeftMarginCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DefaultCellLeftMarginCommand dependency property.

DefaultCellRightMarginCommandProperty

Identifies the DefaultCellRightMarginCommand dependency property.

Declaration

public static readonly DependencyProperty DefaultCellRightMarginCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DefaultCellRightMarginCommand dependency property.

DefaultCellTopMarginCommandProperty

Identifies the DefaultCellTopMarginCommand dependency property.

Declaration

public static readonly DependencyProperty DefaultCellTopMarginCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DefaultCellTopMarginCommand dependency property.

DeleteAllCommentsCommandProperty

Identifies the DeleteAllCommentsCommand dependency property.

Declaration

public static readonly DependencyProperty DeleteAllCommentsCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DeleteAllCommentsCommand dependency property.

DeleteColumnCommandProperty

Identifies the DeleteColumnCommand dependency property.

Declaration

public static readonly DependencyProperty DeleteColumnCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DeleteColumnCommand dependency property.

DeleteCommandProperty

Identifies the DeleteCommand dependency property.

Declaration

public static readonly DependencyProperty DeleteCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DeleteCommand dependency property.

DeleteCommentCommandProperty

Identifies the DeleteCommentCommand dependency property.

Declaration

public static readonly DependencyProperty DeleteCommentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DeleteCommentCommand dependency property.

DeleteRowCommandProperty

Identifies the DeleteRowCommand dependency property.

Declaration

public static readonly DependencyProperty DeleteRowCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DeleteRowCommand dependency property.

DeleteTableCommandProperty

Identifies the DeleteTableCommand dependency property.

Declaration

public static readonly DependencyProperty DeleteTableCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DeleteTableCommand dependency property.

DocumentProperty

Identifies the Document dependency property.

Declaration

public static readonly DependencyProperty DocumentProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the Document dependency property.

DocumentTitleProperty

Identifies the DocumentTitle dependency property.

Declaration

public static readonly DependencyProperty DocumentTitleProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the DocumentTitle dependency property.

EditorSettingsProperty

Identifies the EditorSettings dependency property.

Declaration

public static readonly DependencyProperty EditorSettingsProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the EditorSettings dependency property.

EnableCopyIconProperty

Identifies the EnableCopyIcon dependency property.

Declaration

public static readonly DependencyProperty EnableCopyIconProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the EnableCopyIcon dependency property.

EnableRadialMenuProperty

Identifies the EnableRadialMenu dependency property.

Declaration

public static readonly DependencyProperty EnableRadialMenuProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the EnableRadialMenu dependency property.

ExportSettingsProperty

Identifies the ExportSettings dependency property.

Declaration

public static readonly DependencyProperty ExportSettingsProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ExportSettings dependency property.

FontColorCommandProperty

Identifies the FontColorCommand dependency property.

Declaration

public static readonly DependencyProperty FontColorCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the FontColorCommand dependency property.

FontFamilyCommandProperty

Identifies the FontFamilyCommand dependency property.

Declaration

public static readonly DependencyProperty FontFamilyCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the FontFamilyCommand dependency property.

FontNamesProperty

Identifies the FontNames dependency property.

Declaration

public static readonly DependencyProperty FontNamesProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the FontNames dependency property.

FontSizeCommandProperty

Identifies the FontSizeCommand dependency property.

Declaration

public static readonly DependencyProperty FontSizeCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the FontSizeCommand dependency property.

FontSizeScaleFactorProperty

Identifies the FontSizeScaleFactor dependency property.

Declaration

public static readonly DependencyProperty FontSizeScaleFactorProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the FontSizeScaleFactor dependency property.

GripperSizeProperty

Identifies the GripperSize dependency property.

Declaration

public static readonly DependencyProperty GripperSizeProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the GripperSize dependency property.

HighlightColorCommandProperty

Identifies the HighlightColorCommand dependency property.

Declaration

public static readonly DependencyProperty HighlightColorCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the HighlightColorCommand dependency property.

HorizontalScrollBarVisibilityProperty

Identifies the HorizontalScrollBarVisibility dependency property.

Declaration

public static readonly DependencyProperty HorizontalScrollBarVisibilityProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the HorizontalScrollBarVisibility dependency property.

HtmlImportExportSettingsProperty

Identifies the HtmlImportExportSettings dependency property.

Declaration

public static readonly DependencyProperty HtmlImportExportSettingsProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the HtmlImportExportSettings dependency property.

IgnoreAllSpellingErrorsCommandProperty

Identifies the IgnoreAllSpellingErrorsCommand dependency property.

Declaration

public static readonly DependencyProperty IgnoreAllSpellingErrorsCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the IgnoreAllSpellingErrorsCommand dependency property.

IncreaseIndentCommandProperty

Identifies the IncreaseIndentCommand dependency property.

Declaration

public static readonly DependencyProperty IncreaseIndentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the IncreaseIndentCommand dependency property.

InsertBreakCommandProperty

Identifies the InsertBreakCommand dependency property.

Declaration

public static readonly DependencyProperty InsertBreakCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the InsertBreakCommand dependency property.

InsertColumnCommandProperty

Identifies the InsertColumnCommand dependency property.

Declaration

public static readonly DependencyProperty InsertColumnCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the InsertColumnCommand dependency property.

InsertHyperlinkCommandProperty

Identifies the InsertHyperlinkCommand dependency property.

Declaration

public static readonly DependencyProperty InsertHyperlinkCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the InsertHyperlinkCommand dependency property.

InsertPictureCommandProperty

Identifies the InsertPictureCommand dependency property.

Declaration

public static readonly DependencyProperty InsertPictureCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the InsertPictureCommand dependency property.

InsertRowCommandProperty

Identifies the InsertRowCommand dependency property.

Declaration

public static readonly DependencyProperty InsertRowCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the InsertRowCommand dependency property.

InsertTableCommandProperty

Identifies the InsertTableCommand dependency property.

Declaration

public static readonly DependencyProperty InsertTableCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the InsertTableCommand dependency property.

IsReadOnlyProperty

Identifies the IsReadOnly dependency property.

Declaration

public static readonly DependencyProperty IsReadOnlyProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the IsReadOnly dependency property.

IsTextPredictionEnabledProperty

Identifies the IsTextPredictionEnabled dependency property.

Declaration

public static readonly DependencyProperty IsTextPredictionEnabledProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the IsTextPredictionEnabled dependency property.

IsVirtualizingProperty

Identifies the IsVirtualizing dependency property.

Declaration

public static readonly DependencyProperty IsVirtualizingProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the IsVirtualizing dependency property.

IsZoomEnabledProperty

Identifies the IsZoomEnabled dependency property.

Declaration

public static readonly DependencyProperty IsZoomEnabledProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the IsZoomEnabled dependency property.

ItalicCommandProperty

Identifies the ItalicCommand dependency property.

Declaration

public static readonly DependencyProperty ItalicCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ItalicCommand dependency property.

LayoutTypeCommandProperty

Identifies the LayoutTypeCommand dependency property.

Declaration

public static readonly DependencyProperty LayoutTypeCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the LayoutTypeCommand dependency property.

LayoutTypeProperty

Identifies the LayoutType dependency property.

Declaration

public static readonly DependencyProperty LayoutTypeProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the LayoutType dependency property.

LeftIndentCommandProperty

Identifies the LeftIndentCommand dependency property.

Declaration

public static readonly DependencyProperty LeftIndentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the LeftIndentCommand dependency property.

LineSpacingCommandProperty

Identifies the LineSpacingCommand dependency property.

Declaration

public static readonly DependencyProperty LineSpacingCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the LineSpacingCommand dependency property.

LineSpacingTypeCommandProperty

Identifies the LineSpacingTypeCommand dependency property.

Declaration

public static readonly DependencyProperty LineSpacingTypeCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the LineSpacingTypeCommand dependency property.

LoadAsyncSettingsProperty

Identifies the LoadAsyncSettings dependency property.

Declaration

public static readonly DependencyProperty LoadAsyncSettingsProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the LoadAsyncSettings dependency property.

LostFocusBehaviorProperty

Identifies the LostFocusBehavior dependency property.

Declaration

public static readonly DependencyProperty LostFocusBehaviorProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty

MergeSelectedCellsCommandProperty

Identifies the MergeSelectedCellsCommand dependency property.

Declaration

public static readonly DependencyProperty MergeSelectedCellsCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the MergeSelectedCellsCommand dependency property.

NewCommentCommandProperty

Identifies the NewCommentCommand dependency property.

Declaration

public static readonly DependencyProperty NewCommentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the NewCommentCommand dependency property.

NewDocumentCommandProperty

Identifies the NewDocumentCommand dependency property.

Declaration

public static readonly DependencyProperty NewDocumentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the NewDocumentCommand dependency property.

NextCommentCommandProperty

Identifies the NextCommentCommand dependency property.

Declaration

public static readonly DependencyProperty NextCommentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the NextCommentCommand dependency property.

OpenDocumentCommandProperty

Identifies the OpenDocumentCommand dependency property.

Declaration

public static readonly DependencyProperty OpenDocumentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the OpenDocumentCommand dependency property.

OverridesDocumentBackgroundProperty

Identifies the OverridesDocumentBackground dependency property.

Declaration

public static readonly DependencyProperty OverridesDocumentBackgroundProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the OverridesDocumentBackground dependency property.

PageFitCommandProperty

Identifies the PageFitCommand dependency property.

Declaration

public static readonly DependencyProperty PageFitCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the PageFitCommand dependency property.

ParagraphCountProperty

Identifies the ParagraphCount dependency property.

Declaration

public static readonly DependencyProperty ParagraphCountProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ParagraphCount dependency property.

PasteAsyncCommandProperty

Identifies the PasteAsyncCommand dependency property.

Declaration

public static readonly DependencyProperty PasteAsyncCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the PasteAsyncCommand dependency property.

PasteCommandProperty

Identifies the PasteCommand dependency property.

Declaration

public static readonly DependencyProperty PasteCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the PasteCommand dependency property.

PreviousCommentCommandProperty

Identifies the PreviousCommentCommand dependency property.

Declaration

public static readonly DependencyProperty PreviousCommentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the PreviousCommentCommand dependency property.

PrintDocumentCommandProperty

Identifies the PrintDocumentCommand dependency property.

Declaration

public static readonly DependencyProperty PrintDocumentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the PrintDocumentCommand dependency property.

RedoCommandProperty

Identifies the RedoCommand dependency property.

Declaration

public static readonly DependencyProperty RedoCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the RedoCommand dependency property.

RemoveHyperlinkCommandProperty

Identifies the RemoveHyperlinkCommand dependency property.

Declaration

public static readonly DependencyProperty RemoveHyperlinkCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the RemoveHyperlinkCommand dependency property.

RightIndentCommandProperty

Identifies the RightIndentCommand dependency property.

Declaration

public static readonly DependencyProperty RightIndentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the RightIndentCommand dependency property.

SaveAsDocumentCommandProperty

Identifies the SaveAsDocumentCommand dependency property.

Declaration

public static readonly DependencyProperty SaveAsDocumentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SaveAsDocumentCommand dependency property.

SaveDocumentCommandProperty

Identifies the SaveDocumentCommand dependency property.

Declaration

public static readonly DependencyProperty SaveDocumentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SaveDocumentCommand dependency property.

ScrollBarIndicatorModeProperty

Identifies the ScrollBarIndicatorMode dependency property.

Declaration

public static readonly DependencyProperty ScrollBarIndicatorModeProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ScrollBarIndicatorMode dependency property.

SelectAllCommandProperty

Identifies the SelectAllCommand dependency property.

Declaration

public static readonly DependencyProperty SelectAllCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SelectAllCommand dependency property.

SelectCellCommandProperty

Identifies the SelectCellCommand dependency property.

Declaration

public static readonly DependencyProperty SelectCellCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SelectCellCommand dependency property.

SelectColumnCommandProperty

Identifies the SelectColumnCommand dependency property.

Declaration

public static readonly DependencyProperty SelectColumnCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SelectColumnCommand dependency property.

SelectionBrushProperty

Identifies the SelectionBrush dependency property.

Declaration

public static readonly DependencyProperty SelectionBrushProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SelectionBrush dependency property.

SelectRowCommandProperty

Identifies the SelectRowCommand dependency property.

Declaration

public static readonly DependencyProperty SelectRowCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SelectRowCommand dependency property.

SelectTableCommandProperty

Identifies the SelectTableCommand dependency property.

Declaration

public static readonly DependencyProperty SelectTableCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SelectTableCommand dependency property.

ShowCommentsCommandProperty

Identifies the ShowCommentsCommand dependency property.

Declaration

public static readonly DependencyProperty ShowCommentsCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ShowCommentsCommand dependency property.

ShowHyperlinkDialogCommandProperty

Identifies the ShowHyperlinkDialogCommand dependency property.

Declaration

public static readonly DependencyProperty ShowHyperlinkDialogCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ShowHyperlinkDialogCommand dependency property.

ShowHyperlinkDialogProperty

Identifies the ShowHyperlinkDialogCommand dependency property.

Declaration

public static readonly DependencyProperty ShowHyperlinkDialogProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ShowHyperlinkDialogCommand dependency property.

ShowOptionsPaneCommandProperty

Identifies the ShowOptionsPaneCommand dependency property.

Declaration

public static readonly DependencyProperty ShowOptionsPaneCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ShowOptionsPaneCommand dependency property.

ShowSpellingPaneCommandProperty

Identifies the ShowSpellingPaneCommand dependency property.

Declaration

public static readonly DependencyProperty ShowSpellingPaneCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ShowSpellingPaneCommand dependency property.

SpellCheckerProperty

Identifies the SpellChecker dependency property.

Declaration

public static readonly DependencyProperty SpellCheckerProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the SpellChecker dependency property.

StrikeThroughCommandProperty

Identifies the StrikeThroughCommand dependency property.

Declaration

public static readonly DependencyProperty StrikeThroughCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the StrikeThroughCommand dependency property.

TableAlignmentCommandProperty

Identifies the TableAlignmentCommand dependency property.

Declaration

public static readonly DependencyProperty TableAlignmentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the TableAlignmentCommand dependency property.

TableLeftIndentCommandProperty

Identifies the TableLeftIndentCommand dependency property.

Declaration

public static readonly DependencyProperty TableLeftIndentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the TableLeftIndentCommand dependency property.

TextAlignmentCommandProperty

Identifies the TextAlignmentCommand dependency property.

Declaration

public static readonly DependencyProperty TextAlignmentCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the TextAlignmentCommand dependency property.

TextWrappingProperty

Identifies the TextWrapping dependency property.

Declaration

public static readonly DependencyProperty TextWrappingProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the TextWrapping dependency property.

UnderlineCommandProperty

Identifies the UnderlineCommand dependency property.

Declaration

public static readonly DependencyProperty UnderlineCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the UnderlineCommand dependency property.

UndoCommandProperty

Identifies the UndoCommand dependency property.

Declaration

public static readonly DependencyProperty UndoCommandProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the UndoCommand dependency property.

UseCtrlClickToFollowHyperlinkProperty

Identifies the UseCtrlClickToFollowHyperlink​​​ property.

Declaration

public static readonly DependencyProperty UseCtrlClickToFollowHyperlinkProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the UseCtrlClickToFollowHyperlink​​​ dependency property.

VerticalScrollBarVisibilityProperty

Identifies the VerticalScrollBarVisibility dependency property.

Declaration

public static readonly DependencyProperty VerticalScrollBarVisibilityProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the VerticalScrollBarVisibility dependency property.

WordCountProperty

Identifies the WordCount dependency property.

Declaration

public static readonly DependencyProperty WordCountProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the WordCount dependency property.

ZoomFactorProperty

Identifies the ZoomFactor dependency property.

Declaration

public static readonly DependencyProperty ZoomFactorProperty

Field Value

Type	Description
Windows.UI.Xaml.DependencyProperty	The identifier for the ZoomFactor dependency property.

Properties

AcceptsTab

Gets or sets a value that indicates how the SfRichTextBoxAdv control responds when the user presses the TAB key.

Declaration

public bool AcceptsTab { get; set; }

Property Value

Type	Description
System.Boolean	True if pressing the TAB key inserts a tab character at the current cursor position or navigates to the next cell if current cursor position is within a table cell. False if pressing the TAB key moves the focus to the next control that is marked as a tab stop and does not insert a tab character or perform cell navigation. The default value is false.

Examples

The following code example demonstrates how to specify the SfRichTextBoxAdv control to accept Tab character as input.

<!-- Defines the SfRichTextBoxAdv control that accepts Tab character as input. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" AcceptsTab="True"/>

// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.AcceptsTab = true;

' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.AcceptsTab = True

AddToDictionaryCommand

Gets or Sets a value that represents the AddToDictionaryCommand.

Declaration

public AddToDictionaryCommand AddToDictionaryCommand { get; set; }

Property Value

Type	Description
AddToDictionaryCommand	The AddToDictionaryCommand instance associated with the SfRichTextBoxAdv.

AfterSpacingCommand

Gets or Sets a value that represents the AfterSpacingCommand.

Declaration

public AfterSpacingCommand AfterSpacingCommand { get; set; }

Property Value

Type	Description
AfterSpacingCommand	The AfterSpacingCommand instance associated with the SfRichTextBoxAdv.

AllowDownloadingImages

Gets or sets a value indicating whether the SfRichTextBoxAdv control can download the images from the internet.

Declaration

public static bool AllowDownloadingImages { get; set; }

Property Value

Type	Description
System.Boolean	True, if the SfRichTextBoxAdv control can download the images from the internet. Otherwise False. The default is True.

ApplyStyleCommand

Gets or Sets a value that represents the ApplyStyleCommand.

Declaration

public ApplyStyleCommand ApplyStyleCommand { get; set; }

Property Value

Type	Description
ApplyStyleCommand	The ApplyStyleCommand instance associated with the SfRichTextBoxAdv.

AutoFitTableCommand

Gets or Sets a value that represents the AutoFitTableCommand. This command fits the columns width of selected table in SfRichTextBoxAdv control based on commmand parameter of type AutoFitType. Default value for command parameter is FitToContents.

Declaration

public AutoFitTableCommand AutoFitTableCommand { get; set; }

Property Value

Type	Description
AutoFitTableCommand	The AutoFitTableCommand instance associated with the SfRichTextBoxAdv.

Examples

The following code example demonstrates how to bind the AutoFitTableCommand to perform the auto fit to window on selected table of SfRichTextBoxAdv control.

<Button Content="AutoFitContents" Command="{Binding ElementName=richTextBoxAdv, Path=AutoFitTableCommand, Mode=TwoWay}" CommandParameter="FitToWindow" />
<!-- Defines the SfRichTextBoxAdv control --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" />

// Checks whether the command can be executed in current context.
if (richTextBoxAdv.AutoFitTableCommand.CanExecute(AutoFitType.FitToWindow))
    // Executes the command.
    richTextBoxAdv.AutoFitTableCommand.Execute(AutoFitType.FitToWindow);

BaselineAlignmentCommand

Gets or Sets a value that represents the BaselineAlignmentCommand.

Declaration

public BaselineAlignmentCommand BaselineAlignmentCommand { get; set; }

Property Value

Type	Description
BaselineAlignmentCommand	The BaselineAlignmentCommand instance associated with the SfRichTextBoxAdv.

BeforeSpacingCommand

Gets or Sets a value that represents the BeforeSpacingCommand.

Declaration

public BeforeSpacingCommand BeforeSpacingCommand { get; set; }

Property Value

Type	Description
BeforeSpacingCommand	The BeforeSpacingCommand instance associated with the SfRichTextBoxAdv.

BoldCommand

Gets or Sets a value that represents the BoldCommand.

Declaration

public BoldCommand BoldCommand { get; set; }

Property Value

Type	Description
BoldCommand	The BoldCommand instance associated with the SfRichTextBoxAdv.

CaretBrush

Gets or sets the caret brush of the SfRichTextBoxAdv.

Declaration

public Brush CaretBrush { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	The caret brush of the SfRichTextBoxAdv. The default value is a SolidColorBrush with auto color.

Examples

The following code example demonstrates how to define the caret brush for SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with caret brush as Blue. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" CaretBrush="#FF0000FF"/>

// Defines the SfRichTextBoxAdv control with caret brush as Blue.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.CaretBrush = new SolidColorBrush(Color.FromArgb(0xFF, 0x00, 0x00, 0xFF));

' Defines the SfRichTextBoxAdv control with caret brush as Blue.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.CaretBrush = New SolidColorBrush(Color.FromArgb(&HFF, &H0, &H0, &HFF))

CaretWidth

Gets or sets the caret width of the SfRichTextBoxAdv.

Declaration

public double CaretWidth { get; set; }

Property Value

Type	Description
System.Double	The caret width of the SfRichTextBoxAdv.

Remarks

The default value is 0.5 Pixel.

Examples

The following code example demonstrates how to define the caret width for SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with caret brush as Blue. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" CaretWidth="2"/>

// Defines the SfRichTextBoxAdv control with caret brush as Blue.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.CaretWidth = 2;

' Defines the SfRichTextBoxAdv control with caret brush as Blue.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.CaretWidth = 2

CellBottomMarginCommand

Gets or Sets a value that represents the CellBottomMarginCommand.

Declaration

public CellBottomMarginCommand CellBottomMarginCommand { get; set; }

Property Value

Type	Description
CellBottomMarginCommand	The CellBottomMarginCommand instance associated with the SfRichTextBoxAdv.

CellContentAlignmentCommand

Gets or Sets a value that represents the CellContentAlignmentCommand.

Declaration

public CellContentAlignmentCommand CellContentAlignmentCommand { get; set; }

Property Value

Type	Description
CellContentAlignmentCommand	The CellContentAlignmentCommand instance associated with the SfRichTextBoxAdv.

CellLeftMarginCommand

Gets or Sets a value that represents the CellLeftMarginCommand.

Declaration

public CellLeftMarginCommand CellLeftMarginCommand { get; set; }

Property Value

Type	Description
CellLeftMarginCommand	The CellLeftMarginCommand instance associated with the SfRichTextBoxAdv.

CellRightMarginCommand

Gets or Sets a value that represents the CellRightMarginCommand.

Declaration

public CellRightMarginCommand CellRightMarginCommand { get; set; }

Property Value

Type	Description
CellRightMarginCommand	The CellRightMarginCommand instance associated with the SfRichTextBoxAdv.

CellSpacingCommand

Gets or Sets a value that represents the CellSpacingCommand.

Declaration

public CellSpacingCommand CellSpacingCommand { get; set; }

Property Value

Type	Description
CellSpacingCommand	The CellSpacingCommand instance associated with the SfRichTextBoxAdv.

CellTopMarginCommand

Gets or Sets a value that represents the CellTopMarginCommand.

Declaration

public CellTopMarginCommand CellTopMarginCommand { get; set; }

Property Value

Type	Description
CellTopMarginCommand	The CellTopMarginCommand instance associated with the SfRichTextBoxAdv.

CellVerticalAlignmentCommand

Gets or Sets a value that represents the CellVerticalAlignmentCommand.

Declaration

public CellVerticalAlignmentCommand CellVerticalAlignmentCommand { get; set; }

Property Value

Type	Description
CellVerticalAlignmentCommand	The CellVerticalAlignmentCommand instance associated with the SfRichTextBoxAdv.

ChangeAllSpellingCommand

Gets or Sets a value that represents the ChangeAllSpellingCommand.

Declaration

public ChangeAllSpellingCommand ChangeAllSpellingCommand { get; set; }

Property Value

Type	Description
ChangeAllSpellingCommand	The ChangeAllSpellingCommand instance associated with the SfRichTextBoxAdv.

ChangeSpellingCommand

Gets or Sets a value that represents the ChangeSpellingCommand.

Declaration

public ChangeSpellingCommand ChangeSpellingCommand { get; set; }

Property Value

Type	Description
ChangeSpellingCommand	The ChangeSpellingCommand instance associated with the SfRichTextBoxAdv.

CheckSpellingCommand

Gets or Sets a value that represents the CheckSpellingCommand.

Declaration

public CheckSpellingCommand CheckSpellingCommand { get; set; }

Property Value

Type	Description
CheckSpellingCommand	The CheckSpellingCommand instance associated with the SfRichTextBoxAdv.

ClearFormattingCommand

Gets or Sets a value that represents the ClearFormattingCommand.

Declaration

public ClearFormattingCommand ClearFormattingCommand { get; set; }

Property Value

Type	Description
ClearFormattingCommand	The ClearFormattingCommand instance associated with the SfRichTextBoxAdv.

CopyCommand

Gets or Sets a value that represents the CopyCommand.

Declaration

public CopyCommand CopyCommand { get; set; }

Property Value

Type	Description
CopyCommand	The CopyCommand instance associated with the SfRichTextBoxAdv.

CopyHyperlinkCommand

Gets or Sets a value that represents the CopyHyperlinkCommand.

Declaration

public CopyHyperlinkCommand CopyHyperlinkCommand { get; set; }

Property Value

Type	Description
CopyHyperlinkCommand	The CopyHyperlinkCommand instance associated with the SfRichTextBoxAdv.

CurrentPageNumber

Gets the current page number.

Declaration

public int CurrentPageNumber { get; }

Property Value

Type	Description
System.Int32	If the SfRichTextBoxAdv control is loaded, then returns the page number of the first page in visible region. Otherwise returns zero.

CutCommand

Gets or Sets a value that represents the CutCommand.

Declaration

public CutCommand CutCommand { get; set; }

Property Value

Type	Description
CutCommand	The CutCommand instance associated with the SfRichTextBoxAdv.

DecreaseIndentCommand

Gets or Sets a value that represents the DecreaseIndentCommand.

Declaration

public DecreaseIndentCommand DecreaseIndentCommand { get; set; }

Property Value

Type	Description
DecreaseIndentCommand	The DecreaseIndentCommand instance associated with the SfRichTextBoxAdv.

DefaultCellBottomMarginCommand

Gets or Sets a value that represents the DefaultCellBottomMarginCommand.

Declaration

public DefaultCellBottomMarginCommand DefaultCellBottomMarginCommand { get; set; }

Property Value

Type	Description
DefaultCellBottomMarginCommand	The DefaultCellBottomMarginCommand instance associated with the SfRichTextBoxAdv.

DefaultCellLeftMarginCommand

Gets or Sets a value that represents the DefaultCellLeftMarginCommand.

Declaration

public DefaultCellLeftMarginCommand DefaultCellLeftMarginCommand { get; set; }

Property Value

Type	Description
DefaultCellLeftMarginCommand	The DefaultCellLeftMarginCommand instance associated with the SfRichTextBoxAdv.

DefaultCellRightMarginCommand

Gets or Sets a value that represents the DefaultCellRightMarginCommand.

Declaration

public DefaultCellRightMarginCommand DefaultCellRightMarginCommand { get; set; }

Property Value

Type	Description
DefaultCellRightMarginCommand	The DefaultCellRightMarginCommand instance associated with the SfRichTextBoxAdv.

DefaultCellTopMarginCommand

Gets or Sets a value that represents the DefaultCellTopMarginCommand.

Declaration

public DefaultCellTopMarginCommand DefaultCellTopMarginCommand { get; set; }

Property Value

Type	Description
DefaultCellTopMarginCommand	The DefaultCellTopMarginCommand instance associated with the SfRichTextBoxAdv.

DeleteAllCommentsCommand

Gets or Sets a value that represents the DeleteAllCommentsCommand.

Declaration

public DeleteAllCommentsCommand DeleteAllCommentsCommand { get; set; }

Property Value

Type	Description
DeleteAllCommentsCommand	The DeleteAllCommentsCommand instance associated with the SfRichTextBoxAdv.

DeleteColumnCommand

Gets or Sets a value that represents the DeleteColumnCommand.

Declaration

public DeleteColumnCommand DeleteColumnCommand { get; set; }

Property Value

Type	Description
DeleteColumnCommand	The DeleteColumnCommand instance associated with the SfRichTextBoxAdv.

DeleteCommand

Gets or Sets a value that represents the command which deletes the selected content in SfRichTextBoxAdv control.

Declaration

public ICommand DeleteCommand { get; set; }

Property Value

Type	Description
System.Windows.Input.ICommand

Remarks

This command can execute only when the selection is non-empty. It deletes the selected content, like Delete key. For example, when some cells of a table or an entire table is selected it deletes only the cell contents.

DeleteCommentCommand

Gets or Sets a value that represents the DeleteCommentCommand.

Declaration

public DeleteCommentCommand DeleteCommentCommand { get; set; }

Property Value

Type	Description
DeleteCommentCommand	The DeleteCommentCommand instance associated with the SfRichTextBoxAdv.

DeleteRowCommand

Gets or Sets a value that represents the DeleteRowCommand.

Declaration

public DeleteRowCommand DeleteRowCommand { get; set; }

Property Value

Type	Description
DeleteRowCommand	The DeleteRowCommand instance associated with the SfRichTextBoxAdv.

DeleteTableCommand

Gets or Sets a value that represents the DeleteTableCommand.

Declaration

public DeleteTableCommand DeleteTableCommand { get; set; }

Property Value

Type	Description
DeleteTableCommand	The DeleteTableCommand instance associated with the SfRichTextBoxAdv.

Document

Gets or Sets the DocumentAdv.

Declaration

public DocumentAdv Document { get; set; }

Property Value

Type	Description
DocumentAdv	The DocumentAdv instance loaded in the SfRichTextBoxAdv.

Examples

The following code example demonstrates how to define the document for SfRichTextBoxAdv

<!-- Defines the SfRichTextBoxAdv control. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv">
    <RichTextBoxAdv:DocumentAdv>
        <!-- Add any number of sections here. -->
        <RichTextBoxAdv:SectionAdv>
            <!-- Add any number of paragraphs and tables here. -->
            <RichTextBoxAdv:ParagraphAdv>
                <!-- Add any number of spans, images, comments and hyperlink fields here. -->
                <RichTextBoxAdv:SpanAdv>Hello World.</RichTextBoxAdv:SpanAdv>
            </RichTextBoxAdv:ParagraphAdv>
        </RichTextBoxAdv:SectionAdv>
    </RichTextBoxAdv:DocumentAdv>
 </RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
// Defines the document.
DocumentAdv documentAdv = new DocumentAdv();
// Defines and adds a section to the document.
SectionAdv sectionAdv = new SectionAdv();
// Add any number of sections here.
documentAdv.Sections.Add(sectionAdv);
// Defines and adds a paragraph to the section.
ParagraphAdv paragraphAdv = new ParagraphAdv();
// Add any number of paragraphs, tables here.
sectionAdv.Blocks.Add(paragraphAdv);
// Defines and add a span to the paragraph.
SpanAdv spanAdv = new SpanAdv();
spanAdv.Text = "Hello world.";
// Add any number of spans, images, comments and hyperlink fields here.
paragraphAdv.Inlines.Add(spanAdv);
// Defines the document for SfRichTextBoxAdv control.
richTextBoxAdv.Document = documentAdv;

' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()

' Defines the document.
Dim documentAdv As New DocumentAdv()

' Defines and adds a section to the document.
Dim sectionAdv As New SectionAdv()

' Add any number of sections here.
documentAdv.Sections.Add(sectionAdv)

' Defines and adds a paragraph to the section.
Dim paragraphAdv As New ParagraphAdv()

' Add any number of paragraphs, tables here.
sectionAdv.Blocks.Add(paragraphAdv)

' Defines and add a span to the paragraph.
Dim spanAdv As New SpanAdv()
spanAdv.Text = "Hello world."

' Add any number of spans, images, comments and hyperlink fields here.
paragraphAdv.Inlines.Add(spanAdv)

' Defines the document for SfRichTextBoxAdv control.
richTextBoxAdv.Document = documentAdv

See Also

DocumentAdv

DocumentTitle

Gets or sets the title of the document.

Declaration

public string DocumentTitle { get; set; }

Property Value

Type	Description
System.String	The title of the document

Examples

The following code example demonstrates how to define the tile for the document in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with title for document. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" DocumentTitle="My Notes"/>

// Defines the SfRichTextBoxAdv control with title for document.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.DocumentTitle = "My Notes";

' Defines the SfRichTextBoxAdv control with title for document.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.DocumentTitle = "My Notes"

EditorSettings

Gets or sets the settings for editing operations.

Declaration

public EditorSettings EditorSettings { get; set; }

Property Value

Type	Description
EditorSettings

Examples

The following code example demonstrates how to define editor settings for a SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Pages">
    <RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
        <!-- Defines editor settings with live resizing -->
        <RichTextBoxAdv:EditorSettings ResizingMode="Live" />
    </RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
//Defines the editor settings with live resizing.
EditorSettings editorSettings = new EditorSettings();
editorSettings.ResizingMode = ResizingMode.Live;
richTextBoxAdv.EditorSettings = editorSettings;

/// ' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()

'Defines the editor settings with live resizing.
Dim loadAsyncSettings As New EditorSettings()
editorSettings.ResizingMode = ResizingMode.Live

richTextBoxAdv.EditorSettings = editorSettings

EnableCopyIcon

Gets or sets a value that indicates whether built-in copy icon of the SfRichTextBoxAdv control needs to be enabled. The default is true.

Declaration

public bool EnableCopyIcon { get; set; }

Property Value

Type	Description
System.Boolean	The built-in copy icon of the SfRichTextBoxAdv control needs to be enabled or not.

Remarks

The copy icon will be shown for all layouts in mobile mode and block layout in desktop mode.

Examples

The following code example demonstrates how to enable or disable built-in copy icon of the SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with built-in radial menu disabled. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" EnableCopyIcon="False"/>

// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.EnableCopyIcon = false;

' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.EnableCopyIcon = False

EnableRadialMenu

Gets or sets a value that indicates whether built-in radial menu of the SfRichTextBoxAdv control needs to be enabled.

Declaration

public bool EnableRadialMenu { get; set; }

Property Value

Type	Description
System.Boolean	The built-in radial menu of the SfRichTextBoxAdv control needs to be enabled or not.

Remarks

This property has no effect in Windows Phone device, since the built-in radial menu is not supported in Windows Phone device.

Examples

The following code example demonstrates how to enable or disable built-in radial menu of the SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with built-in radial menu disabled. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" EnableRadialMenu="False"/>

// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.EnableRadialMenu = false;

' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.EnableRadialMenu = False

ExportSettings

Gets or sets the settings for export operation.

Declaration

public ExportSettings ExportSettings { get; set; }

Property Value

Type	Description
ExportSettings

FontColorCommand

Gets or Sets a value that represents the FontColorCommand.

Declaration

public FontColorCommand FontColorCommand { get; set; }

Property Value

Type	Description
FontColorCommand	The FontColorCommand associated with the SfRichTextBoxAdv.

FontFamilyCommand

Gets or Sets a value that represents the FontFamilyCommand.

Declaration

public FontFamilyCommand FontFamilyCommand { get; set; }

Property Value

Type	Description
FontFamilyCommand	The FontFamilyCommand instance associated with the SfRichTextBoxAdv.

FontNames

Declaration

public ObservableCollection<string> FontNames { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<System.String>

FontSizeCommand

Gets or Sets a value that represents the FontSizeCommand.

Declaration

public FontSizeCommand FontSizeCommand { get; set; }

Property Value

Type	Description
FontSizeCommand	The FontSizeCommand instance associated with the SfRichTextBoxAdv.

FontSizeScaleFactor

Gets or sets the font size scale factor, which is used to scale text display in Mobile device to match Desktop device family.

Declaration

public double FontSizeScaleFactor { get; set; }

Property Value

Type	Description
System.Double	The double value of FontSize Scale factor.

Examples

The following code example demonstrates how to define font size scale factor for the SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with font size scale factor as 1.5. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" FontSizeScaleFactor="1.5"/>

// Defines the SfRichTextBoxAdv control with font size scale factor as 1.5.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.FontSizeScaleFactor = 1.5;

' Defines the SfRichTextBoxAdv control with font size scale factor as 1.5.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.FontSizeScaleFactor = 1.5

GripperSize

Gets or sets the Gripper size used for Touch selection in SfRichTextBoxAdv.

Declaration

public double GripperSize { get; set; }

Property Value

Type	Description
System.Double	The double value of Gripper size.

Examples

The following code example demonstrates how to define gripper size for the SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with gripper size as 20. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" GripperSize="20"/>

// Defines the SfRichTextBoxAdv control with gripper size as 20.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.GripperSize = 20;

' Defines the SfRichTextBoxAdv control with gripper size as 20.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.GripperSize = 20

HighlightColorCommand

Gets or Sets a value that represents the HighlightColorCommand.

Declaration

public HighlightColorCommand HighlightColorCommand { get; set; }

Property Value

Type	Description
HighlightColorCommand	The HighlightColorCommand instance associated with the SfRichTextBoxAdv.

HorizontalScrollBarVisibility

Gets or sets a value that indicates whether the horizontal scroll bar of the SfRichTextBoxAdv control needs to be visible.

Declaration

public bool HorizontalScrollBarVisibility { get; set; }

Property Value

Type	Description
System.Boolean	The horizontal scroll bar of the SfRichTextBoxAdv control needs to be visible or not.

Examples

The following code example demonstrates how to enable or disable horizontal scroll bar visibility in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with horizontal scroll bar visibility disabled. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" HorizontalScrollBarVisibility="False"/>

// Defines the SfRichTextBoxAdv control with horizontal scroll bar visibility disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.HorizontalScrollBarVisibility = false;

' Defines the SfRichTextBoxAdv control with horizontal scroll bar visibility disabled.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.HorizontalScrollBarVisibility = False

HtmlImportExportSettings

Gets or sets the HtmlImportExportSettings specifies the settings for HTML import and export.

Declaration

public HtmlImportExportSettings HtmlImportExportSettings { get; set; }

Property Value

Type	Description
HtmlImportExportSettings	The HtmlImportExportSettings instance specifies the settings for HTML import and export.

Examples

The following code example demonstrates how to define Html import and export settings for a SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Pages">
    <RichTextBoxAdv:SfRichTextBoxAdv.HtmlImportExportSettings>
        <!-- Defines page loading settings -->
        <RichTextBoxAdv:HtmlImportExportSettings IsOverwriteFontFamily="True" FontFamily="Times New Roman" />
    </RichTextBoxAdv:SfRichTextBoxAdv.HtmlImportExportSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
//Defines the html import and export settings.
HtmlImportExportSettings htmlImportExportSettings = new HtmlImportExportSettings();
htmlImportExportSettings.IsOverwriteFontFamily = true;
htmlImportExportSettings.FontFamily = "Times New Roman";
richTextBoxAdv.HtmlImportExportSettings = htmlImportExportSettings;

' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()

'Defines the html import and export settings.
Dim htmlImportExportSettings As New HtmlImportExportSettings()
htmlImportExportSettings.IsOverwriteFontFamily = True
htmlImportExportSettings.FontFamily = "Times New Roman"

richTextBoxAdv.HtmlImportExportSettings = htmlImportExportSettings

IgnoreAllSpellingErrorsCommand

Gets or Sets a value that represents the IgnoreAllSpellingErrorsCommand.

Declaration

public IgnoreAllSpellingErrorsCommand IgnoreAllSpellingErrorsCommand { get; set; }

Property Value

Type	Description
IgnoreAllSpellingErrorsCommand	The IgnoreAllSpellingErrorsCommand instance associated with the SfRichTextBoxAdv.

IncreaseIndentCommand

Gets or Sets a value that represents the IncreaseIndentCommand.

Declaration

public IncreaseIndentCommand IncreaseIndentCommand { get; set; }

Property Value

Type	Description
IncreaseIndentCommand	The IncreaseIndentCommand instance associated with the SfRichTextBoxAdv.

InsertBreakCommand

Gets or Sets a value that represents the InsertBreakCommand.

Declaration

public InsertBreakCommand InsertBreakCommand { get; set; }

Property Value

Type	Description
InsertBreakCommand	The InsertBreakCommand instance associated with the SfRichTextBoxAdv.

InsertColumnCommand

Gets or Sets a value that represents the InsertColumnCommand.

Declaration

public InsertColumnCommand InsertColumnCommand { get; set; }

Property Value

Type	Description
InsertColumnCommand	The InsertColumnCommand instance associated with the SfRichTextBoxAdv.

InsertHyperlinkCommand

Gets or Sets a value that represents the InsertHyperlinkCommand.

Declaration

public InsertHyperlinkCommand InsertHyperlinkCommand { get; set; }

Property Value

Type	Description
InsertHyperlinkCommand	The InsertHyperlinkCommand instance associated with the SfRichTextBoxAdv.

InsertPictureCommand

Gets or Sets a value that represents the InsertPictureCommand.

Declaration

public InsertPictureCommand InsertPictureCommand { get; set; }

Property Value

Type	Description
InsertPictureCommand	The InsertPictureCommand instance associated with the SfRichTextBoxAdv.

InsertRowCommand

Gets or Sets a value that represents the InsertRowCommand.

Declaration

public InsertRowCommand InsertRowCommand { get; set; }

Property Value

Type	Description
InsertRowCommand	The InsertRowCommand instance associated with the SfRichTextBoxAdv.

InsertTableCommand

Gets or Sets a value that represents the InsertTableCommand.

Declaration

public InsertTableCommand InsertTableCommand { get; set; }

Property Value

Type	Description
InsertTableCommand	The InsertTableCommand instance associated with the SfRichTextBoxAdv.

IsReadOnly

Gets or sets the value that determines if the user can change the content in the SfRichTextBoxAdv.

Declaration

public bool IsReadOnly { get; set; }

Property Value

Type	Description
System.Boolean	The SfRichTextBoxAdv is read-only or not.

Examples

The following code example demonstrates how to enable or disable read only mode in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with read only mode. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" IsReadOnly="True"/>

// Defines the SfRichTextBoxAdv control with read only mode.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.IsReadOnly = true;

' Defines the SfRichTextBoxAdv control with read only mode.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.IsReadOnly = True

IsTextPredictionEnabled

Gets or sets a value indicating whether the text prediction is enabled in SfRichTextBoxAdv control.

Declaration

public bool IsTextPredictionEnabled { get; set; }

Property Value

Type	Description
System.Boolean	True if text prediction is enabled. Otherwise False. The default is true.

Examples

The following code example demonstrates how to enable or disable text prediction in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with text prediction disbaled. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" IsTextPredictionEnabled="False"/>

// Defines the SfRichTextBoxAdv control with text prediction disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.IsTextPredictionEnabled = false;

' Defines the SfRichTextBoxAdv control with text prediction disabled.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.IsTextPredictionEnabled = False

IsVirtualizing

Gets or sets a value that indicates whether the SfRichTextBoxAdv control is virtualizing its contents.

Declaration

public bool IsVirtualizing { get; set; }

Property Value

Type	Description
System.Boolean	True if the SfRichTextBoxAdv control is virtualizing its contents. False if the SfRichTextBoxAdv control does not virtualizing its contents. The default value is true.

Remarks

Virtualization is a technique by which a subset of UI elements are generated from a larger number of data items based on which items are visible on-screen to utilize minimal memory. Generating many UI elements when only a few elements might be on the screen can adversely affect the performance of your application. The SfRichTextBoxAdv control calculates the number of visible items and creates UI elements only for visible items. Also, This property does not have any effect on the Block mode.

Examples

The following code example demonstrates how to disable viritualization for the SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with virtualization disabled. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" IsVirtualizing="False"/>

// Defines the SfRichTextBoxAdv control with virtualization disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.IsVirtualizing = false;

' Defines the SfRichTextBoxAdv control with virtualization disabled.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.IsVirtualizing = False

IsZoomEnabled

Get or Sets a value that indicates whether zooming needs to be enabled in the SfRichTextBoxAdv.

Declaration

public bool IsZoomEnabled { get; set; }

Property Value

Type	Description
System.Boolean	Zoom is enabled in the SfRichTextBoxAdv is enabled or not.

Examples

The following code example demonstrates how to enable or disable zooming operation in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with zooming operation disabled. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" IsZoomEnabled="False"/>

// Defines the SfRichTextBoxAdv control with zooming operation disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.IsZoomEnabled = false;

' Defines the SfRichTextBoxAdv control with zooming operation disabled.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.IsZoomEnabled = False

ItalicCommand

Gets or Sets a value that represents the ItalicCommand.

Declaration

public ItalicCommand ItalicCommand { get; set; }

Property Value

Type	Description
ItalicCommand	The ItalicCommand associated with the SfRichTextBoxAdv.

LayoutType

Gets or Sets the LayoutType of the SfRichTextBoxAdv control.

Declaration

public LayoutType LayoutType { get; set; }

Property Value

Type	Description
LayoutType	The LayoutType of the SfRichTextBoxAdv control.

Remarks

The default is LayoutType.Pages.

Examples

The following code example demonstrates how to define the SfRichTextBoxAdv control with continuous layout type.

<!-- Defines the SfRichTextBoxAdv control with continuous layout type. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Continuous"/>

// Defines the SfRichTextBoxAdv control with continuous layout type.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.LayoutType = LayoutType.Continuous;

' Defines the SfRichTextBoxAdv control with continuous layout type.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.LayoutType = LayoutType.Continuous

See Also

LayoutType

LayoutTypeCommand

Gets or Sets a value that represents the LayoutTypeCommand.

Declaration

public LayoutTypeCommand LayoutTypeCommand { get; set; }

Property Value

Type	Description
LayoutTypeCommand	The LayoutTypeCommand instance associated with the SfRichTextBoxAdv.

LeftIndentCommand

Gets or Sets a value that represents the LeftIndentCommand.

Declaration

public LeftIndentCommand LeftIndentCommand { get; set; }

Property Value

Type	Description
LeftIndentCommand	The LeftIndentCommand instance associated with the SfRichTextBoxAdv.

LineSpacingCommand

Gets or Sets a value that represents the LineSpacingCommand.

Declaration

public LineSpacingCommand LineSpacingCommand { get; set; }

Property Value

Type	Description
LineSpacingCommand	The LineSpacingCommand instance associated with the SfRichTextBoxAdv.

LineSpacingTypeCommand

Gets or Sets a value that represents the LineSpacingTypeCommand.

Declaration

public LineSpacingTypeCommand LineSpacingTypeCommand { get; set; }

Property Value

Type	Description
LineSpacingTypeCommand	The LineSpacingTypeCommand instance associated with the SfRichTextBoxAdv.

LoadAsyncSettings

Gets or sets the settings for asynchronous document loading operation.

Declaration

public LoadAsyncSettings LoadAsyncSettings { get; set; }

Property Value

Type	Description
LoadAsyncSettings

Examples

The following code example demonstrates how to define asynchronous loading settings for a SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Pages">
    <RichTextBoxAdv:SfRichTextBoxAdv.LoadAsyncSettings>
        <!-- Defines page loading settings -->
        <RichTextBoxAdv:LoadAsyncSettings InitialPageLoadCount="2" IncrementalPageLoadCount="1" />
    </RichTextBoxAdv:SfRichTextBoxAdv.LoadAsyncSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
//Defines the asycnhronous loading settings.
LoadAsyncSettings loadAsyncSettings = new LoadAsyncSettings();
loadAsyncSettings.InitialPageLoadCount = 2;
loadAsyncSettings.IncrementalPageLoadCount = 1;
richTextBoxAdv.LoadAsyncSettings = loadAsyncSettings;

/// ' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()

'Defines the asycnhronous loading settings.
Dim loadAsyncSettings As New LoadAsyncSettings()
loadAsyncSettings.InitialPageLoadCount = 2
loadAsyncSettings.IncrementalPageLoadCount = 1

richTextBoxAdv.LoadAsyncSettings = loadAsyncSettings

LostFocusBehavior

Gets or sets a value that indicates whether the SfRichTextBoxAdv control displays the caret or selection highlight when the control does not have focus. The default value is LostFocusBehavior.None.

Declaration

public LostFocusBehavior LostFocusBehavior { get; set; }

Property Value

Type	Description
LostFocusBehavior	One of the LostFocusBehavior values that specifies the desired value.

Examples

The following code example demonstrates how to define the selection visibility on control lost focus SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with selection highlight visible on lost focus. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LostFocusBehavior="ShowSelection"/>

// Defines the SfRichTextBoxAdv control with mini toolbar disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.LostFocusBehavior = LostFocusBehavior.ShowSelection;

' Defines the SfRichTextBoxAdv control with selection highlight visible on lost focus.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.LostFocusBehavior = LostFocusBehavior.ShowSelection

MergeSelectedCellsCommand

Gets or Sets a value that represents the MergeSelectedCellsCommand.

Declaration

public MergeSelectedCellsCommand MergeSelectedCellsCommand { get; set; }

Property Value

Type	Description
MergeSelectedCellsCommand	The MergeSelectedCellsCommand instance associated with the SfRichTextBoxAdv.

NewCommentCommand

Gets or Sets a value that represents the NewCommentCommand.

Declaration

public NewCommentCommand NewCommentCommand { get; set; }

Property Value

Type	Description
NewCommentCommand	The NewCommentCommand instance associated with the SfRichTextBoxAdv.

NewDocumentCommand

Gets or Sets a value that represents the NewDocumentCommand.

Declaration

public NewDocumentCommand NewDocumentCommand { get; set; }

Property Value

Type	Description
NewDocumentCommand	The NewDocumentCommand instance associated with the SfRichTextBoxAdv.

NextCommentCommand

Gets or Sets a value that represents the NextCommentCommand.

Declaration

public NextCommentCommand NextCommentCommand { get; set; }

Property Value

Type	Description
NextCommentCommand	The NextCommentCommand instance associated with the SfRichTextBoxAdv.

OpenDocumentCommand

Gets or Sets a value that represents the OpenDocumentCommand.

Declaration

public OpenDocumentCommand OpenDocumentCommand { get; set; }

Property Value

Type	Description
OpenDocumentCommand	The OpenDocumentCommand instance associated with the SfRichTextBoxAdv.

OverridesDocumentBackground

Gets or sets a value that indicates whether the background of SfRichTextBoxAdv overrides the document background when the LayoutType is Continuous.

Declaration

public bool OverridesDocumentBackground { get; set; }

Property Value

Type	Description
System.Boolean	True if SfRichTextBoxAdv background overrides the document background when the LayoutType is Continuous. Otherwise False. The default is false.

Remarks

This property affects the background only when the LayoutType is Continuous.

Examples

The following code example demonstrates how to override the document background in a SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with document background overridden. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Continuous" Background="#FF808080" OverridesDocumentBackground="True"/>

// Defines the SfRichTextBoxAdv control with document background overridden.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.LayoutType = LayoutType.Continuous;
richTextBoxAdv.Background = new SolidColorBrush(Color.FromArgb(0xFF, 0x80, 0x80, 0x80));
richTextBoxAdv.OverridesDocumentBackground = true;

' Defines the SfRichTextBoxAdv control with document background overridden.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.LayoutType = LayoutType.Continuous
richTextBoxAdv.Background = New SolidColorBrush(Color.FromArgb(&HFF, &H80, &H80, &H80))
richTextBoxAdv.OverridesDocumentBackground = True

PageCount

Gets the total number of pages in the SfRichTextBoxAdv control.

Declaration

public int PageCount { get; }

Property Value

Type	Description
System.Int32	Returns the total number of pages, if the SfRichTextBoxAdv control is loaded. Otherwise returns zero.

PageFitCommand

Gets or Sets a value that represents the PageFitCommand.

Declaration

public PageFitCommand PageFitCommand { get; set; }

Property Value

Type	Description
PageFitCommand	The PageFitCommand instance associated with the SfRichTextBoxAdv.

ParagraphCount

Gets the total number of paragraphs in the document.

Declaration

public int ParagraphCount { get; }

Property Value

Type	Description
System.Int32	Returns the total number of words in the document. Default value is 0.

Examples

The following code example demonstrates how to get paragraphs count SfRichTextBoxAdv control.

// Defines the SfRichTextBoxAdv control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
int paragraphCount = richTextBoxAdv.ParagraphCount;

' Defines the SfRichTextBoxAdv control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
Dim paragraphCount As Integer = richTextBoxAdv.ParagraphCount

PasteAsyncCommand

Gets or Sets a value that represents the PasteAsyncCommand.

Declaration

public PasteAsyncCommand PasteAsyncCommand { get; set; }

Property Value

Type	Description
PasteAsyncCommand	The PasteAsyncCommand instance associated with the SfRichTextBoxAdv.

PasteCommand

Gets or Sets a value that represents the PasteCommand.

Declaration

public PasteCommand PasteCommand { get; set; }

Property Value

Type	Description
PasteCommand	The PasteCommand instance associated with the SfRichTextBoxAdv.

PreviousCommentCommand

Gets or Sets a value that represents the PreviousCommentCommand.

Declaration

public PreviousCommentCommand PreviousCommentCommand { get; set; }

Property Value

Type	Description
PreviousCommentCommand	The PreviousCommentCommand instance associated with the SfRichTextBoxAdv.

PrintDocumentCommand

Gets or Sets a value that represents the PrintDocumentCommand.

Ensure no other handler for the PrintTaskRequested event is registered before invoking this method, since the SfRichTextBoxAdv internally registers it.

Declaration

public PrintDocumentCommand PrintDocumentCommand { get; set; }

Property Value

Type	Description
PrintDocumentCommand	The PrintDocumentCommand instance associated with the SfRichTextBoxAdv.

RedoCommand

Gets or Sets a value that represents the RedoCommand.

Declaration

public RedoCommand RedoCommand { get; set; }

Property Value

Type	Description
RedoCommand	The RedoCommand instance associated with the SfRichTextBoxAdv.

RemoveHyperlinkCommand

Gets or Sets a value that represents the RemoveHyperlinkCommand.

Declaration

public RemoveHyperlinkCommand RemoveHyperlinkCommand { get; set; }

Property Value

Type	Description
RemoveHyperlinkCommand	The RemoveHyperlinkCommand instance associated with the SfRichTextBoxAdv.

RightIndentCommand

Gets or Sets a value that represents the RightIndentCommand.

Declaration

public RightIndentCommand RightIndentCommand { get; set; }

Property Value

Type	Description
RightIndentCommand	The RightIndentCommand instance associated with the SfRichTextBoxAdv.

SaveAsDocumentCommand

Gets or Sets a value that represents the SaveAsDocumentCommand.

Declaration

public SaveAsDocumentCommand SaveAsDocumentCommand { get; set; }

Property Value

Type	Description
SaveAsDocumentCommand	The SaveAsDocumentCommand instance associated with the SfRichTextBoxAdv.

SaveDocumentCommand

Gets or Sets a value that represents the SaveDocumentCommand.

Declaration

public SaveDocumentCommand SaveDocumentCommand { get; set; }

Property Value

Type	Description
SaveDocumentCommand	The SaveDocumentCommand instance associated with the SfRichTextBoxAdv.

ScrollBarIndicatorMode

Get or Sets the Windows.UI.Xaml.Controls.Primitives.ScrollingIndicatorMode of the SfRichTextBoxAdv control.

Declaration

public ScrollingIndicatorMode ScrollBarIndicatorMode { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Controls.Primitives.ScrollingIndicatorMode	The Windows.UI.Xaml.Controls.Primitives.ScrollingIndicatorMode of the SfRichTextBoxAdv control.

Examples

The following code example demonstrates how to specify the scroll bar indicator mode for the SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with touch scroll bar indicator mode. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" ScrollBarIndicatorMode="TouchIndicator"/>

// Defines the SfRichTextBoxAdv control with touch scroll bar indicator mode.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.ScrollBarIndicatorMode = ScrollingIndicatorMode.TouchIndicator;

' Defines the SfRichTextBoxAdv control with touch scroll bar indicator mode.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.ScrollBarIndicatorMode = ScrollingIndicatorMode.TouchIndicator

SelectAllCommand

Gets or Sets a value that represents the SelectAllCommand.

Declaration

public SelectAllCommand SelectAllCommand { get; set; }

Property Value

Type	Description
SelectAllCommand	The SelectAllCommand instance associated with the SfRichTextBoxAdv.

SelectCellCommand

Gets or Sets a value that represents the SelectCellCommand.

Declaration

public SelectCellCommand SelectCellCommand { get; set; }

Property Value

Type	Description
SelectCellCommand	The SelectCellCommand instance associated with the SfRichTextBoxAdv.

SelectColumnCommand

Gets or Sets a value that represents the SelectColumnCommand.

Declaration

public SelectColumnCommand SelectColumnCommand { get; set; }

Property Value

Type	Description
SelectColumnCommand	The SelectColumnCommand instance associated with the SfRichTextBoxAdv.

Selection

Gets the SelectionAdv of the SfRichTextBoxAdv.

Declaration

public SelectionAdv Selection { get; }

Property Value

Type	Description
SelectionAdv	The instance of SelectionAdv.

See Also

SelectionAdv

SelectionBrush

Gets or sets a brush that describes the selection in the SfRichTextBoxAdv control.

Declaration

public Brush SelectionBrush { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	The brush that paints the selection in the SfRichTextBoxAdv control. The default value is a SolidColorBrush with color of #FF808080.

Examples

The following code example demonstrates how to define the selection brush for SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with selection brush as Blue. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" SelectionBrush="#FF0000FF"/>

// Defines the SfRichTextBoxAdv control with selection brush as Blue.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.SelectionBrush = new SolidColorBrush(Color.FromArgb(0xFF, 0x00, 0x00, 0xFF));

' Defines the SfRichTextBoxAdv control with selection brush as Blue.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.SelectionBrush = New SolidColorBrush(Color.FromArgb(&HFF, &H0, &H0, &HFF))

SelectRowCommand

Gets or Sets a value that represents the SelectRowCommand.

Declaration

public SelectRowCommand SelectRowCommand { get; set; }

Property Value

Type	Description
SelectRowCommand	The SelectRowCommand instance associated with the SfRichTextBoxAdv.

SelectTableCommand

Gets or Sets a value that represents the SelectTableCommand.

Declaration

public SelectTableCommand SelectTableCommand { get; set; }

Property Value

Type	Description
SelectTableCommand	The SelectTableCommand instance associated with the SfRichTextBoxAdv.

ShowCommentsCommand

Gets or Sets a value that represents the ShowCommentsCommand.

Declaration

public ShowCommentsCommand ShowCommentsCommand { get; set; }

Property Value

Type	Description
ShowCommentsCommand	The ShowCommentsCommand instance associated with the SfRichTextBoxAdv.

ShowHyperlinkDialogCommand

Gets or Sets a value that represents the ShowHyperlinkDialogCommand.

Declaration

public ShowHyperlinkDialogCommand ShowHyperlinkDialogCommand { get; set; }

Property Value

Type	Description
ShowHyperlinkDialogCommand	The ShowHyperlinkDialogCommand instance associated with the SfRichTextBoxAdv.

ShowOptionsPaneCommand

Gets or Sets a value that represents the ShowOptionsPaneCommand.

Declaration

public ShowOptionsPaneCommand ShowOptionsPaneCommand { get; set; }

Property Value

Type	Description
ShowOptionsPaneCommand	The ShowOptionsPaneCommand instance associated with the SfRichTextBoxAdv.

ShowSpellingPaneCommand

Gets or Sets a value that represents the ShowSpellingPaneCommand.

Declaration

public ShowSpellingPaneCommand ShowSpellingPaneCommand { get; set; }

Property Value

Type	Description
ShowSpellingPaneCommand	The ShowSpellingPaneCommand instance associated with the SfRichTextBoxAdv.

SpellChecker

Gets or Sets a spelling checker for the SfRichTextBoxAdv.

Declaration

public SpellChecker SpellChecker { get; set; }

Property Value

Type	Description
SpellChecker	The spelling checker for the SfRichTextBoxAdv.

Examples

The following code example demonstrates how to enable spell checking functionality in a SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" xmlns:System="clr-namespace:System;assembly=mscorlib" 
                                    xmlns:RichTextBoxAdv="clr-namespace:Syncfusion.Windows.Controls.RichTextBoxAdv;assembly=Syncfusion.SfRichTextBoxAdv.Wpf">
    <RichTextBoxAdv:SfRichTextBoxAdv.SpellChecker>
        <!-- Enables spell checking functionality. -->
        <RichTextBoxAdv:SpellChecker IsEnabled="True" IgnoreAlphaNumericWords="True" IgnoreURIs="True" IgnoreUppercaseWords="False">
            <RichTextBoxAdv:SpellChecker.CustomDictionaries>
                <!-- Defines the custom dictionaries for spell checking. -->
                <System:String>../../Assets/Default.dic</System:String>
            </RichTextBoxAdv:SpellChecker.CustomDictionaries>
        </RichTextBoxAdv:SpellChecker>
    </RichTextBoxAdv:SfRichTextBoxAdv.SpellChecker>
</RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the control.
Syncfusion.Windows.Controls.RichTextBoxAdv.SfRichTextBoxAdv richTextBoxAdv = new Syncfusion.Windows.Controls.RichTextBoxAdv.SfRichTextBoxAdv();
// Enables the spell checking functionality.
SpellChecker spellChecker = new SpellChecker();
spellChecker.IsEnabled = true;
spellChecker.IgnoreAlphaNumericWords = true;
spellChecker.IgnoreURIs = true;
spellChecker.IgnoreUppercaseWords = false;
// Defines the custom dictionaries for spell checking.
spellChecker.CustomDictionaries.Add("../../Assets/Default.dic");
richTextBoxAdv.SpellChecker = spellChecker;

' Defines the control.
Dim richTextBoxAdv As New Syncfusion.Windows.Controls.RichTextBoxAdv.SfRichTextBoxAdv()

' Enables the spell checking functionality.
Dim spellChecker As New SpellChecker()
spellChecker.IsEnabled = True
spellChecker.IgnoreAlphaNumericWords = True
spellChecker.IgnoreURIs = True
spellChecker.IgnoreUppercaseWords = False
' Defines the custom dictionaries for spell checking.
spellChecker.CustomDictionaries.Add("../../Assets/Default.dic")

richTextBoxAdv.SpellChecker = spellChecker

StrikeThroughCommand

Gets or Sets a value that represents the StrikeThroughCommand.

Declaration

public StrikeThroughCommand StrikeThroughCommand { get; set; }

Property Value

Type	Description
StrikeThroughCommand	The StrikeThroughCommand instance associated with the SfRichTextBoxAdv.

TableAlignmentCommand

Gets or Sets a value that represents the TableAlignmentCommand.

Declaration

public TableAlignmentCommand TableAlignmentCommand { get; set; }

Property Value

Type	Description
TableAlignmentCommand	The TableAlignmentCommand instance associated with the SfRichTextBoxAdv.

TableLeftIndentCommand

Gets or Sets a value that represents the TableLeftIndentCommand.

Declaration

public TableLeftIndentCommand TableLeftIndentCommand { get; set; }

Property Value

Type	Description
TableLeftIndentCommand	The TableLeftIndentCommand instance associated with the SfRichTextBoxAdv.

TextAlignmentCommand

Gets or Sets a value that represents the TextAlignmentCommand.

Declaration

public TextAlignmentCommand TextAlignmentCommand { get; set; }

Property Value

Type	Description
TextAlignmentCommand	The TextAlignmentCommand instance associated with the SfRichTextBoxAdv.

TextWrapping

Gets or Sets the TextWrapping of the SfRichTextBoxAdv control.

Declaration

public TextWrapping TextWrapping { get; set; }

Property Value

Type	Description
TextWrapping	The TextWrapping of the SfRichTextBoxAdv control.

Remarks

The default is TextWrapping.Wrap.

Examples

The following code example demonstrates how to shows Text Wrapping with NoWrap SfRichTextBoxAdv control with Flow Layout

<!-- Defines the SfRichTextBoxAdv control with text wrapping style as none. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Continuous" TextWrapping="NoWrap"/>

// Defines the SfRichTextBoxAdv control with text wrapping style as none..
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.LayoutType = LayoutType.Continuous;
richTextBoxAdv.TextWrapping = TextWrapping.NoWrap;

' Defines the SfRichTextBoxAdv control with text wrapping style as none..
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.LayoutType = LayoutType.Continuous
richTextBoxAdv.TextWrapping = TextWrapping.NoWrap

See Also

TextWrapping

UnderlineCommand

Gets or Sets a value that represents the UnderlineCommand.

Declaration

public UnderlineCommand UnderlineCommand { get; set; }

Property Value

Type	Description
UnderlineCommand	The UnderlineCommand instance associated with the SfRichTextBoxAdv.

UndoCommand

Gets or Sets a value that represents the UndoCommand.

Declaration

public UndoCommand UndoCommand { get; set; }

Property Value

Type	Description
UndoCommand	The UndoCommand instance associated with the SfRichTextBoxAdv.

UseCtrlClickToFollowHyperlink

Gets or sets a value that indicates whether the SfRichTextBoxAdv control requires holding CTRL key to enable hyperlink navigation on mouse click.

Declaration

public bool UseCtrlClickToFollowHyperlink { get; set; }

Property Value

Type	Description
System.Boolean	True if CTRL key must be hold to enable hyperlink navigation on mouse click. False if mouse click is enough to enable hyperlink navigation without need for holding CTRL key. The default value is true.

Examples

The following code example demonstrates how to specify the SfRichTextBoxAdv control to enable hyperlink navigation on mouse click without need for holding CTRL key.

<!-- Defines the SfRichTextBoxAdv control that enables hyperlink navigation on mouse click without need for holding CTRL key. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" UseCtrlClickToFollowHyperlink​​​="False"/>

// Defines the SfRichTextBoxAdv control that enables hyperlink navigation on mouse click without need for holding CTRL key.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.UseCtrlClickToFollowHyperlink​​​ = false;

' Defines the SfRichTextBoxAdv control that enables hyperlink navigation on mouse click without need for holding CTRL key.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.UseCtrlClickToFollowHyperlink​​​ = False

UseLightWeightDom

Gets or sets a Boolean value indicating whether to use lightweight DOM or not. The default value is false.

Declaration

public static bool UseLightWeightDom { get; set; }

Property Value

Type	Description
System.Boolean	True if SfRichTextBoxAdv control uses lightweight DOM; otherwise, false

Remarks

If this property is true, then all the formatting values will be removed from DependencyProperty and maintained internally in a memory optimized way to reduce main memory usage of DOM. This helps for loading large contents in SfRichTextBoxAdv control. Otherwise, all the formatting values are maintained in DependencyProperty and may increase the main memory usage of DOM.

Examples

The following code example demonstrates how to specify SfRichTextBoxAdv control to use lightweight DOM.

SfRichTextBoxAdv.UseLightWeightDom = true;

SfRichTextBoxAdv.UseLightWeightDom = True

VerticalScrollBarVisibility

Gets or sets a value that indicates whether the vertical scroll bar of the SfRichTextBoxAdv control needs to be visible.

Declaration

public bool VerticalScrollBarVisibility { get; set; }

Property Value

Type	Description
System.Boolean	The vertical scroll bar of the SfRichTextBoxAdv control needs to be visible or not.

Examples

The following code example demonstrates how to enable or disable vertical scroll bar visibility in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with vertical scroll bar visibility disabled. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" VerticalScrollBarVisibility="False"/>

// Defines the SfRichTextBoxAdv control with vertical scroll bar visibility disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.VerticalScrollBarVisibility = false;

' Defines the SfRichTextBoxAdv control with vertical scroll bar visibility disabled.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.VerticalScrollBarVisibility = False

WordCount

Gets the total number of words in the document.

Declaration

public int WordCount { get; }

Property Value

Type	Description
System.Int32	Returns the total number of words in the document. Default value is 0.

Examples

The following code example demonstrates how to get words count SfRichTextBoxAdv control.

// Defines the SfRichTextBoxAdv control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
int wordCount = richTextBoxAdv.WordCount;

' Defines the SfRichTextBoxAdv control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
Dim wordCount As Integer = richTextBoxAdv.WordCount

ZoomFactor

Gets or Sets the zoom factor of SfRichTextBoxAdv control.

Declaration

public double ZoomFactor { get; set; }

Property Value

Type	Description
System.Double	The zoom factor of SfRichTextBoxAdv control.

Remarks

The value should be represented in percentage [between 10 to 500].

Examples

The following code example demonstrates how to define zoom factor for the SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with zoom factor as 200%. --> 
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" ZoomFactor="200"/>

// Defines the SfRichTextBoxAdv control with zoom factor as 200%.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.ZoomFactor = 200;

' Defines the SfRichTextBoxAdv control with zoom factor as 200%.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.ZoomFactor = 200

Methods

add_CommentAdding(SfRichTextBoxAdv.CommentAddingEventHandler)

Declaration

public void add_CommentAdding(SfRichTextBoxAdv.CommentAddingEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.CommentAddingEventHandler	value

add_ContentChanged(SfRichTextBoxAdv.ContentChangedEventHandler)

Declaration

public void add_ContentChanged(SfRichTextBoxAdv.ContentChangedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.ContentChangedEventHandler	value

add_DocumentChanged(SfRichTextBoxAdv.DocumentChangedEventHandler)

Declaration

public void add_DocumentChanged(SfRichTextBoxAdv.DocumentChangedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.DocumentChangedEventHandler	value

add_FileLoadingFailed(SfRichTextBoxAdv.FileLoadingFailedEventHandler)

Declaration

public void add_FileLoadingFailed(SfRichTextBoxAdv.FileLoadingFailedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.FileLoadingFailedEventHandler	value

add_PrintCompleted(SfRichTextBoxAdv.PrintCompletedEventHandler)

Declaration

public void add_PrintCompleted(SfRichTextBoxAdv.PrintCompletedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.PrintCompletedEventHandler	value

add_RequestNavigate(SfRichTextBoxAdv.RequestNavigateEventHandler)

Declaration

public void add_RequestNavigate(SfRichTextBoxAdv.RequestNavigateEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.RequestNavigateEventHandler	value

add_SelectionChanged(SfRichTextBoxAdv.SelectionChangedEventHandler)

Declaration

public void add_SelectionChanged(SfRichTextBoxAdv.SelectionChangedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.SelectionChangedEventHandler	value

ArrangeOverride(Size)

Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior.

Declaration

protected override Size ArrangeOverride(Size finalSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	finalSize	The final area within the parent that this object should use to arrange itself and its children.

Returns

Type	Description
Windows.Foundation.Size	The actual size that is used after the element is arranged in layout.

Dispose()

Releases all resources used by the SfRichTextBoxAdv instance.

Declaration

public void Dispose()

Examples

The following code example demonstrates how to dispose an instance of SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public void OnUnloaded()
{
    if (richTextBoxAdv != null)
        richTextBoxAdv.Dispose();
}

Public Sub OnUnloaded()
    If richTextBoxAdv IsNot Nothing Then
        richTextBoxAdv.Dispose()
    End If
End Sub

Find(String, FindOptions)

Finds the first occurrence of the specified System.String in the SfRichTextBoxAdv from current selection with specified FindOptions.

Declaration

public TextSearchResult Find(string text, FindOptions findOption)

Parameters

Type	Name	Description
System.String	text	The text to find.
FindOptions	findOption	The FindOptions to match.

Returns

Type	Description
TextSearchResult	Returns the TextSearchResult instance, if any matching text with the specified is found. Otherwise returns null.

Examples

The following code example demonstrates how to find first occurrence of the specified text in the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public void FindText()
{
    // Finds for the specified text by matching case sensitive whole word.
    TextSearchResult textSearchResult = richTextBoxAdv.Find("Section", FindOptions.CaseSensitiveWholeWord);
if(textSearchResult != null)
{
    // If the text search result is found, select the result.
    richTextBoxAdv.Selection.Select(textSearchResult.Start, textSearchResult.End);

    // Applies bold formatting for the text.
    richTextBoxAdv.Selection.CharacterFormat.Bold = true;
}

}

Public Sub FindText()
     ' Finds for the specified text by matching case sensitive whole word.
     Dim textSearchResult As TextSearchResult = richTextBoxAdv.Find("Section", FindOptions.CaseSensitiveWholeWord)

     If textSearchResult IsNot Nothing Then
         ' If the text search result is found, select the result.
         richTextBoxAdv.Selection.SelectionRanges.Add(textSearchResult.Start, textSearchResult.[End])

         ' Applies bold formatting for the text.
         richTextBoxAdv.Selection.CharacterFormat.Bold = True
     End If
 End Sub

See Also

FindOptions

Find(Regex, FindOptions)

Finds the first occurrence of the specified System.Text.RegularExpressions.Regex pattern in the SfRichTextBoxAdv from current selection with specified FindOptions.

Declaration

public TextSearchResult Find(Regex pattern, FindOptions findOption)

Parameters

Type	Name	Description
System.Text.RegularExpressions.Regex	pattern	The System.Text.RegularExpressions.Regex pattern to find.
FindOptions	findOption	The FindOptions to match.

Returns

Type	Description
TextSearchResult	Returns the TextSearchResult instance, if any matching System.Text.RegularExpressions.Regex pattern with the specified is found. Otherwise returns null.

Examples

The following code example demonstrates how to find first occurrence of the specified pattern in the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public void FindPattern()
{
    // Finds for the specified pattern (lines starting with Section followed by space).
    TextSearchResult textSearchResult = richTextBoxAdv.Find(new Regex("^Section\\s"), FindOptions.None);
if(textSearchResult != null)
{
    // If the text search result is found, select the result.
    richTextBoxAdv.Selection.Select(textSearchResult.Start, textSearchResult.End);

    // Applies bold formatting for the text.
    richTextBoxAdv.Selection.CharacterFormat.Bold = true;
}

}

Public Sub FindPattern()
     ' Finds for the specified pattern (lines starting with Section followed by space).
     Dim textSearchResults As TextSearchResults = richTextBoxAdv.FindAll(New Regex("^Section\s"), FindOptions.None)

     If textSearchResult IsNot Nothing Then
         ' If the text search result is found, select the result.
         richTextBoxAdv.Selection.SelectionRanges.Add(textSearchResult.Start, textSearchResult.[End])

         ' Applies bold formatting for the text.
         richTextBoxAdv.Selection.CharacterFormat.Bold = True
     End If
 End Sub

See Also

System.Text.RegularExpressions.Regex

FindOptions

FindAll(String, FindOptions)

Finds all the occurrences of the specified System.String in the SfRichTextBoxAdv with specified FindOptions.

Declaration

public TextSearchResults FindAll(string text, FindOptions findOption)

Parameters

Type	Name	Description
System.String	text	The text to find.
FindOptions	findOption	The FindOptions to match.

Returns

Type	Description
TextSearchResults	Returns the Syncfusion.UI.Xaml.RichTextBoxAdv.SfRichTextBoxAdv.TextSearchResults instance, if any matching text with the specified is found. Otherwise returns null.

Examples

The following code example demonstrates how to find all occurrences of the specified text in the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public void FindAllText()
{
    // Finds for the specified text by matching case sensitive whole word.
    TextSearchResults textSearchResults = richTextBoxAdv.FindAll("Section", FindOptions.CaseSensitiveWholeWord);
if(textSearchResults != null)
{
   // If the text search results are found, select all the results.
   for (int i = 0; i < textSearchResults.Count; i++)
   {
       TextSearchResult textSearchResult = textSearchResults[i];
       if (i == 0)
           richTextBoxAdv.Selection.Select(textSearchResult.Start, textSearchResult.End);
       else
           richTextBoxAdv.Selection.SelectionRanges.Add(textSearchResult.Start, textSearchResult.End);
   }

   // Applies highlight color for the text.
   richTextBoxAdv.Selection.CharacterFormat.HighlightColor = HighlightColor.Yellow;
}

}

Public Sub FindAllText()
     ' Finds for the specified text by matching case sensitive whole word.
     Dim textSearchResults As TextSearchResults = richTextBoxAdv.FindAll("Section", FindOptions.CaseSensitiveWholeWord)

     If textSearchResults IsNot Nothing Then
         ' If the text search result is found, select all the results.
         For i As Integer = 0 To textSearchResults.Count - 1
             Dim textSearchResult As TextSearchResult = textSearchResults(i)
             If i = 0 Then
                 richTextBoxAdv.Selection.[Select](textSearchResult.Start, textSearchResult.[End])
             Else
                 richTextBoxAdv.Selection.SelectionRanges.Add(textSearchResult.Start, textSearchResult.[End])
             End If
         Next

         ' Applies highlight color for the text.
         richTextBoxAdv.Selection.CharacterFormat.HighlightColor = HighlightColor.Yellow
     End If
 End Sub

See Also

FindOptions

FindAll(Regex, FindOptions)

Finds all the occurrences of specified System.Text.RegularExpressions.Regex pattern in the SfRichTextBoxAdv with specified FindOptions.

Declaration

public TextSearchResults FindAll(Regex pattern, FindOptions findOption)

Parameters

Type	Name	Description
System.Text.RegularExpressions.Regex	pattern	The System.Text.RegularExpressions.Regex pattern to find.
FindOptions	findOption	The FindOptions to match.

Returns

Type	Description
TextSearchResults	Returns the Syncfusion.UI.Xaml.RichTextBoxAdv.SfRichTextBoxAdv.TextSearchResults instance, if any specified System.Text.RegularExpressions.Regex pattern is matched with the specified . Otherwise returns null.

Examples

The following code example demonstrates how to find all occurrences of the specified pattern in the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public void FindAllPattern()
{
    // Finds for the specified pattern (lines starting with Section followed by space).
    TextSearchResults textSearchResults = richTextBoxAdv.FindAll(new Regex("^Section\\s"), FindOptions.None);
if(textSearchResults != null)
{
   // If the text search results are found, select all the results.
   for (int i = 0; i < textSearchResults.Count; i++)
   {
       TextSearchResult textSearchResult = textSearchResults[i];
       if (i == 0)
           richTextBoxAdv.Selection.Select(textSearchResult.Start, textSearchResult.End);
       else
           richTextBoxAdv.Selection.SelectionRanges.Add(textSearchResult.Start, textSearchResult.End);
   }

   // Applies highlight color for the text.
   richTextBoxAdv.Selection.CharacterFormat.HighlightColor = HighlightColor.Yellow;
}

}

Public Sub FindAllPattern()
     ' Finds for the specified pattern (lines starting with Section followed by space).
     Dim textSearchResults As TextSearchResults = richTextBoxAdv.FindAll(New Regex("^Section\s"), FindOptions.None)

     If textSearchResults IsNot Nothing Then
         ' If the text search result is found, select all the results.
         For i As Integer = 0 To textSearchResults.Count - 1
             Dim textSearchResult As TextSearchResult = textSearchResults(i)
             If i = 0 Then
                 richTextBoxAdv.Selection.[Select](textSearchResult.Start, textSearchResult.[End])
             Else
                 richTextBoxAdv.Selection.SelectionRanges.Add(textSearchResult.Start, textSearchResult.[End])
             End If
         Next

         ' Applies highlight color for the text.
         richTextBoxAdv.Selection.CharacterFormat.HighlightColor = HighlightColor.Yellow
     End If
 End Sub

See Also

System.Text.RegularExpressions.Regex

FindOptions

GetPageAsImageAsync(Int32)

Asynchronously returns the specified page of SfRichTextBoxAdv as Windows.UI.Xaml.Media.Imaging.BitmapImage instance.

Declaration

public Task<BitmapImage> GetPageAsImageAsync(int pageNumber)

Parameters

Type	Name	Description
System.Int32	pageNumber	The page number of SfRichTextBoxAdv.

Returns

Type	Description
System.Threading.Tasks.Task<Windows.UI.Xaml.Media.Imaging.BitmapImage>	A task that represents the asynchronous operation to get the page of SfRichTextBoxAdv as Windows.UI.Xaml.Media.Imaging.BitmapImage.

Examples

The following code example demonstrate how to retrieve the pages in SfRichTextBoxAdv as bitmap images.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

List<BitmapImage> images = null;
public async Task<bool> GetPagesAsync()
{
TaskCompletionSource<bool> tcs = new TaskCompletionSource<bool>();
if (images != null)
    images.Clear();

images = new List&lt;BitmapImage>();

for (int pageNumber = 0; pageNumber &lt; richTextBoxAdv.PageCount; pageNumber++)
{
    // Retrieves the bimap image of a page in SfRichTextBoxAdv control.
    BitmapImage image = await richTextBoxAdv.GetPageAsImageAsync(pageNumber);
    images.Add(image);
}

tcs.SetResult(true);
return await tcs.Task;
}

Private images As List(Of BitmapImage) = Nothing

Public Async Function GetPagesAsync() As Task(Of Boolean)

    Dim tcs As TaskCompletionSource(Of Boolean) = New TaskCompletionSource(Of Boolean)

    If images IsNot Nothing Then
        images.Clear()
    End If

    images = New List(Of BitmapImage)()

    For pageNumber As Integer = 0 To richTextBoxAdv.PageCount - 1
       ' Retrieves the bimap image of a page in SfRichTextBoxAdv control.
       Dim image As BitmapImage = Await richTextBoxAdv.GetPageAsImageAsync(pageNumber)
       images.Add(image)
    Next

    tcs.SetResult(True)
    Return Await tcs.Task
End Function

Exceptions

Type	Condition
System.InvalidOperationException	This operation is invalid since the document loading is in progress.
System.IndexOutOfRangeException	Index was out of range. Must be non-negative and less than the size of the collection.

GetSpellingError(TextPosition)

Returns a SpellingError instance associated with any spelling error at the specified TextPosition in the document.

Declaration

public SpellingError GetSpellingError(TextPosition textPosition)

Parameters

Type	Name	Description
TextPosition	textPosition	The TextPosition instance at which spelling error to be checked.

Returns

Type	Description
SpellingError	A SpellingError instance containing the details of the spelling error found at the TextPosition, or null if no spelling error exists at the specified TextPosition.

Examples

The following code example demonstrates how to get the spelling error at the specified text position in a SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" xmlns:System="clr-namespace:System;assembly=mscorlib" 
                                    xmlns:RichTextBoxAdv="clr-namespace:Syncfusion.Windows.Controls.RichTextBoxAdv;assembly=Syncfusion.SfRichTextBoxAdv.Wpf">
    <RichTextBoxAdv:SfRichTextBoxAdv.SpellChecker>
        <!-- Enables spell checking functionality. -->
        <RichTextBoxAdv:SpellChecker IsEnabled="True" IgnoreAlphaNumericWords="True" IgnoreURIs="True" IgnoreUppercaseWords="False">
            <RichTextBoxAdv:SpellChecker.CustomDictionaries>
                <!-- Defines the custom dictionaries for spell checking. -->
                <System:String>../../Assets/Default.dic</System:String>
            </RichTextBoxAdv:SpellChecker.CustomDictionaries>
        </RichTextBoxAdv:SpellChecker>
    </RichTextBoxAdv:SfRichTextBoxAdv.SpellChecker>
</RichTextBoxAdv:SfRichTextBoxAdv>

public void IgnoreSpellingError()
{
    TextPosition textPosition = richTextBoxAdv.Document.GetTextPosition("0;0;20");
    // Gets the spelling error at the specified text position.
    Syncfusion.Windows.Controls.RichTextBoxAdv.SpellingError spellingError = richTextBoxAdv.GetSpellingError(textPosition);
    if (spellingError != null)
        // If a spelling error is found, ignores all the occurrences of the misspelled word.
        spellingError.IgnoreAll();
}

Public Sub IgnoreSpellingError()
    Dim textPosition As TextPosition = richTextBoxAdv.Document.GetTextPosition("0;0;20")
    ' Gets the spelling error at the specified text position.
    Dim spellingError As Syncfusion.Windows.Controls.RichTextBoxAdv.SpellingError = richTextBoxAdv.GetSpellingError(textPosition)
    If spellingError IsNot Nothing Then
        ' If a spelling error is found, ignores all the occurrences of the misspelled word.
        spellingError.IgnoreAll()
    End If
End Sub

Load(WordDocument)

Imports the specified WordDocument into the SfRichTextBoxAdv control.

Declaration

public void Load(WordDocument wordDocument)

Parameters

Type	Name	Description
WordDocument	wordDocument	Word document.

Exceptions

Type	Condition
System.ArgumentNullException	document cannot be null.

Load(Stream, FormatType)

Imports the specified System.IO.Stream in the specified FormatType into the SfRichTextBoxAdv control.

Declaration

public void Load(Stream stream, FormatType formatType)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream to import contents.
FormatType	formatType	The FormatType to import.

Examples

The following code example demonstrates how to load a stream into the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public void LoadStream()
{
    // Raw content.
    string content = "
Hello world
";
    // Converts the string into byte array.
    byte[] bytes = Encoding.UTF8.GetBytes(content);
    // Initializes the stream.
    Stream stream = new MemoryStream();
    // Serializes the bytes into the stream.
    stream.Write(bytes, 0, bytes.Length);
    // Seeks the stream to starting position.
    stream.Position = 0;
// Loads the stream into SfRichTextBoxAdv in HTML format.
richTextBoxAdv.Load(stream, FormatType.Html);

}

Public Sub LoadStream()

    ' Raw content.
    Dim content As String = "
Hello world
"
    ' Converts the string into byte array.
    Dim bytes As Byte() = Encoding.UTF8.GetBytes(content)
    ' Initializes the stream.
    Dim stream As Stream = New MemoryStream()
    ' Serializes the bytes into the stream.
    stream.Write(bytes, 0, bytes.Length);
    ' Seeks the stream to starting position.
    stream.Position = 0

    ' Loads the stream into SfRichTextBoxAdv in HTML format.
    richTextBoxAdv.Load(stream, FormatType.Html)
End Sub

Exceptions

Type	Condition
System.NotSupportedException	RichTextBoxAdv does not support this file format.
System.ArgumentNullException	Stream cannot be null.

See Also

FormatType

Load(StorageFile)

Imports the specified Windows.Storage.StorageFile into the SfRichTextBoxAdv.

Declaration

public void Load(StorageFile storageFile)

Parameters

Type	Name	Description
Windows.Storage.StorageFile	storageFile	The Windows.Storage.StorageFile to import the content.

Examples

The following code example demonstrates how to import a storage file into the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public async void LoadFileAsync()
{
    FileOpenPicker fileOpenPicker = new FileOpenPicker();
    fileOpenPicker.FileTypeFilter.Add(".doc");
    fileOpenPicker.FileTypeFilter.Add(".docx");
    fileOpenPicker.FileTypeFilter.Add(".dot");
    fileOpenPicker.FileTypeFilter.Add(".dotx");
    fileOpenPicker.FileTypeFilter.Add(".rtf");
    fileOpenPicker.FileTypeFilter.Add(".htm");
    fileOpenPicker.FileTypeFilter.Add(".html");
    fileOpenPicker.FileTypeFilter.Add(".xml");
    fileOpenPicker.FileTypeFilter.Add(".txt");
    StorageFile file = await fileOpenPicker.PickSingleFileAsync();
if (file != null)
    // Loads the file into SfRichTextBoxAdv.
    richTextBoxAdv.Load(file);

}

Public Async Function LoadFileAsync() As Task

    Dim fileOpenPicker As New FileOpenPicker()
    fileOpenPicker.FileTypeFilter.Add(".doc")
    fileOpenPicker.FileTypeFilter.Add(".docx")
    fileOpenPicker.FileTypeFilter.Add(".dot")
    fileOpenPicker.FileTypeFilter.Add(".dotx")
    fileOpenPicker.FileTypeFilter.Add(".rtf")
    fileOpenPicker.FileTypeFilter.Add(".htm")
    fileOpenPicker.FileTypeFilter.Add(".html")
    fileOpenPicker.FileTypeFilter.Add(".xml")
    fileOpenPicker.FileTypeFilter.Add(".txt")
    Dim file As StorageFile = Await fileOpenPicker.PickSingleFileAsync()

    If file IsNot Nothing Then
        ' Loads the file into SfRichTextBoxAdv.
        richTextBoxAdv.Load(file)
    End If
End Function

LoadAsync(WordDocument, CancellationToken)

Asynchronously imports the specified WordDocument into the SfRichTextBoxAdv control.

Declaration

public Task<bool> LoadAsync(WordDocument wordDocument, CancellationToken cancellationToken)

Parameters

Type	Name	Description
WordDocument	wordDocument	The WordDocument
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the asynchronous load operation.

Exceptions

Type	Condition
System.ArgumentNullException	document cannot be null.

LoadAsync(Stream, FormatType)

Asynchronously imports the specified System.IO.Stream in the specified FormatType into the SfRichTextBoxAdv control.

Declaration

public Task<bool> LoadAsync(Stream stream, FormatType formatType)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream to import the content.
FormatType	formatType	The FormatType to import.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the asynchronous load operation.

Examples

The following code example demonstrates how to asynchronously load System.IO.Stream.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public async Task<bool> LoadStreamAsync()
{
    TaskCompletionSource<bool> tcs = new TaskCompletionSource<bool>();
// Raw content.
string content = &quot;&lt;html>&lt;body>&lt;p>Hello world&lt;/p>&lt;/body>&lt;/html>&quot;;
// Converts the string into byte array.
byte[] bytes = Encoding.UTF8.GetBytes(content);
// Initializes the stream.
Stream stream = new MemoryStream();
// Serializes the bytes into the stream.
stream.Write(bytes, 0, bytes.Length);
// Seeks the stream to starting position.
stream.Position = 0;

// Loads the stream asynchronously into SfRichTextBoxAdv in HTML format.
await richTextBoxAdv.LoadAsync(stream, FormatType.Html);

tcs.SetResult(true);
return await tcs.Task;

}

Public Async Function LoadStreamAsync() As Task(Of Boolean)

    Dim tcs As TaskCompletionSource(Of Boolean) = New TaskCompletionSource(Of Boolean)

    ' Raw content.
    Dim content As String = "<html><body><p>Hello world</p></body></html>"
    ' Converts the string into byte array.
    Dim bytes As Byte() = Encoding.UTF8.GetBytes(content)
    ' Initializes the stream.
    Dim stream As Stream = New MemoryStream()
    ' Serializes the bytes into the stream.
    stream.Write(bytes, 0, bytes.Length);
    ' Seeks the stream to starting position.
    stream.Position = 0

    ' Loads the stream asynchronously into SfRichTextBoxAdv in HTML format.
    Await richTextBoxAdv.LoadAsync(stream, FormatType.Html)

    tcs.SetResult(True)
    Return Await tcs.Task
End Function

Exceptions

Type	Condition
System.NotSupportedException	RichTextBoxAdv does not support this file format.
System.ArgumentNullException	Stream cannot be null.

LoadAsync(Stream, FormatType, CancellationToken)

Asynchronously imports the specified System.IO.Stream in the specified FormatType into the SfRichTextBoxAdv.

Declaration

public Task<bool> LoadAsync(Stream stream, FormatType formatType, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream to import the content.
FormatType	formatType	The FormatType to import.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the asynchronous load operation.

Examples

The following code example demonstrates how to asynchronously load a stream into the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

Task<bool> loadAsync = null;
public async Task<bool> LoadStreamAsync()
{
TaskCompletionSource<bool> tcs = new TaskCompletionSource<bool>();
// Raw content.
string content = &quot;&lt;html>&lt;body>&lt;p>Hello world&lt;/p>&lt;/body>&lt;/html>&quot;;
// Converts the string into byte array.
byte[] bytes = Encoding.UTF8.GetBytes(content);
// Initializes the stream.
Stream stream = new MemoryStream();
// Serializes the bytes into the stream.
stream.Write(bytes, 0, bytes.Length);
// Seeks the stream to starting position.
stream.Position = 0;

CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
// Loads the stream asynchronously into SfRichTextBoxAdv in HTML format.
loadAsync = richTextBoxAdv.LoadAsync(stream, FormatType.Html, cancellationTokenSource.Token);

await loadAsync;

if (cancellationTokenSource != null)
    cancellationTokenSource.Dispose();
cancellationTokenSource = null;
loadAsync = null;

tcs.SetResult(true);
return await tcs.Task;

}

Dim loadAsync As Task(Of Boolean) = Nothing

Public Async Function LoadStreamAsync() As Task(Of Boolean)

    Dim tcs As TaskCompletionSource(Of Boolean) = New TaskCompletionSource(Of Boolean)

    ' Raw content.
    Dim content As String = "<html><body><p>Hello world</p></body></html>"
    ' Converts the string into byte array.
    Dim bytes As Byte() = Encoding.UTF8.GetBytes(content)
    ' Initializes the stream.
    Dim stream As Stream = New MemoryStream()
    ' Serializes the bytes into the stream.
    stream.Write(bytes, 0, bytes.Length);
    ' Seeks the stream to starting position.
    stream.Position = 0

    Dim cancellationTokenSource As CancellationTokenSource = New CancellationTokenSource()

    ' Loads the stream asynchronously into SfRichTextBoxAdv in HTML format.
    loadAsync = richTextBoxAdv.LoadAsync(stream, FormatType.Html, cancellationTokenSource.Token)

    Await loadAsync
    If cancellationTokenSource IsNot Nothing Then
        cancellationTokenSource.Dispose()
    End If
    cancellationTokenSource = Nothing
    loadAsync = Nothing

    tcs.SetResult(True)
    Return Await tcs.Task
End Function

Exceptions

Type	Condition
System.NotSupportedException	RichTextBoxAdv does not support this file format.
System.ArgumentNullException	Stream cannot be null.

See Also

FormatType

LoadAsync(StorageFile)

Asynchronously imports the specified Windows.Storage.StorageFile into the SfRichTextBoxAdv.

Declaration

public Task<bool> LoadAsync(StorageFile storageFile)

Parameters

Type	Name	Description
Windows.Storage.StorageFile	storageFile	The Windows.Storage.StorageFile to import the content.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the asynchronous load operation.

Examples

The following code example demonstrates how to asynchronously load a file into the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public async Task<bool> LoadFileAsync()
{
    TaskCompletionSource<bool> tcs = new TaskCompletionSource<bool>();
FileOpenPicker fileOpenPicker = new FileOpenPicker();
fileOpenPicker.FileTypeFilter.Add(&quot;.doc&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.docx&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.dot&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.dotx&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.rtf&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.htm&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.html&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.xml&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.txt&quot;);
StorageFile file = await fileOpenPicker.PickSingleFileAsync();

if (file != null)
    // Loads the file asynchronously into SfRichTextBoxAdv.
    await richTextBoxAdv.LoadAsync(file);

tcs.SetResult(true);
return await tcs.Task;
}

Public Async Function LoadFileAsync() As Task(Of Boolean)

    Dim tcs As TaskCompletionSource(Of Boolean) = New TaskCompletionSource(Of Boolean)

    Dim fileOpenPicker As New FileOpenPicker()
    fileOpenPicker.FileTypeFilter.Add(".doc")
    fileOpenPicker.FileTypeFilter.Add(".docx")
    fileOpenPicker.FileTypeFilter.Add(".dot")
    fileOpenPicker.FileTypeFilter.Add(".dotx")
    fileOpenPicker.FileTypeFilter.Add(".rtf")
    fileOpenPicker.FileTypeFilter.Add(".htm")
    fileOpenPicker.FileTypeFilter.Add(".html")
    fileOpenPicker.FileTypeFilter.Add(".xml")
    fileOpenPicker.FileTypeFilter.Add(".txt")
    Dim file As StorageFile = Await fileOpenPicker.PickSingleFileAsync()

    If file IsNot Nothing Then
        ' Loads the file asynchronously into SfRichTextBoxAdv.
        Await richTextBoxAdv.LoadAsync(file)
    End If

    tcs.SetResult(True)
    Return Await tcs.Task
End Function

Exceptions

Type	Condition
System.ArgumentNullException	StorageFile cannot be null.

LoadAsync(StorageFile, CancellationToken)

Asynchronously imports the specified Windows.Storage.StorageFile into the SfRichTextBoxAdv.

Declaration

public Task<bool> LoadAsync(StorageFile storageFile, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Windows.Storage.StorageFile	storageFile	The Windows.Storage.StorageFile to import the content.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the asynchronous load operation.

Examples

The following code example demonstrates how to asynchronously load a storage file into the SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

Task<bool> loadAsync = null;
public async Task<bool> LoadFileAsync()
{
TaskCompletionSource<bool> tcs = new TaskCompletionSource<bool>();
CancellationTokenSource cancellationTokenSource = null;
FileOpenPicker fileOpenPicker = new FileOpenPicker();
fileOpenPicker.FileTypeFilter.Add(&quot;.doc&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.docx&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.dot&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.dotx&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.rtf&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.htm&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.html&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.xml&quot;);
fileOpenPicker.FileTypeFilter.Add(&quot;.txt&quot;);
StorageFile file = await fileOpenPicker.PickSingleFileAsync();

if (file != null)
{
    cancellationTokenSource = new CancellationTokenSource();

    // Loads the file asynchronously into SfRichTextBoxAdv.
    loadAsync = richTextBoxAdv.LoadAsync(file, cancellationTokenSource.Token);
    await loadAsync;
}

if (cancellationTokenSource != null)
    cancellationTokenSource.Dispose();
cancellationTokenSource = null;
loadAsync = null;

tcs.SetResult(true);
return await tcs.Task;
}

Dim loadAsync As Task(Of Boolean) = Nothing

Public Async Function LoadFileAsync() As Task(Of Boolean)

    Dim tcs As TaskCompletionSource(Of Boolean) = New TaskCompletionSource(Of Boolean)

    Dim fileOpenPicker As New FileOpenPicker()
    fileOpenPicker.FileTypeFilter.Add(".doc")
    fileOpenPicker.FileTypeFilter.Add(".docx")
    fileOpenPicker.FileTypeFilter.Add(".dot")
    fileOpenPicker.FileTypeFilter.Add(".dotx")
    fileOpenPicker.FileTypeFilter.Add(".rtf")
    fileOpenPicker.FileTypeFilter.Add(".htm")
    fileOpenPicker.FileTypeFilter.Add(".html")
    fileOpenPicker.FileTypeFilter.Add(".xml")
    fileOpenPicker.FileTypeFilter.Add(".txt")
    Dim file As StorageFile = Await fileOpenPicker.PickSingleFileAsync()

    Dim cancellationTokenSource As CancellationTokenSource = Nothing

    If file IsNot Nothing Then
        cancellationTokenSource = New CancellationTokenSource()
        ' Loads the file asynchronously into SfRichTextBoxAdv.
        loadAsync = richTextBoxAdv.LoadAsync(file, cancellationTokenSource.Token)
        Await loadAsync
    End If

    If cancellationTokenSource IsNot Nothing Then
        cancellationTokenSource.Dispose()
    End If
    cancellationTokenSource = Nothing
    loadAsync = Nothing

    tcs.SetResult(True)
    Return Await tcs.Task
End Function

MeasureOverride(Size)

Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	availableSize	The available size that this object can give to child objects. Infinity can be specified as a value to indicate that the object will size to whatever content is available.

Returns

Type	Description
Windows.Foundation.Size	The size that this object determines it needs during layout, based on its calculations of the allocated sizes for child objects or based on other considerations such as a fixed container size.

OnApplyTemplate()

Applies the template

Declaration

protected override void OnApplyTemplate()

OnCreateAutomationPeer()

When implemented in a derived class, returns class-specific AutomationPeer implementations for the UI Automation infrastructure.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type	Description
Windows.UI.Xaml.Automation.Peers.AutomationPeer	The class-specific AutomationPeer subclass to return.

OnDoubleTapped(DoubleTappedRoutedEventArgs)

Called before the DoubleTapped event occurs.

Declaration

protected override void OnDoubleTapped(DoubleTappedRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.DoubleTappedRoutedEventArgs	e	Event data for the event.

OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.

Declaration

protected override void OnGotFocus(RoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.RoutedEventArgs	e	The data for the event.

OnHolding(HoldingRoutedEventArgs)

Called before the Holding event occurs.

Declaration

protected override void OnHolding(HoldingRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.HoldingRoutedEventArgs	e	Event data for the event.

OnIsTextPredictionEnabledChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when [is text prediction enabled changed].

Declaration

protected static void OnIsTextPredictionEnabledChanged(DependencyObject dependencyObject, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
Windows.UI.Xaml.DependencyObject	dependencyObject	The dependency object.
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	The Windows.UI.Xaml.DependencyPropertyChangedEventArgs instance containing the event data.

OnKeyDown(KeyRoutedEventArgs)

Called before the KeyDown event occurs.

Declaration

protected override void OnKeyDown(KeyRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.KeyRoutedEventArgs	e	The data for the event.

OnKeyUp(KeyRoutedEventArgs)

Called before the KeyUp event occurs.

Declaration

protected override void OnKeyUp(KeyRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.KeyRoutedEventArgs	e	The data for the event.

OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.

Declaration

protected override void OnLostFocus(RoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.RoutedEventArgs	e	The data for the event.

OnManipulationDelta(ManipulationDeltaRoutedEventArgs)

Called before the ManipulationDelta event occurs.

Declaration

protected override void OnManipulationDelta(ManipulationDeltaRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.ManipulationDeltaRoutedEventArgs	e	Event data for the event.

OnPointerExited(PointerRoutedEventArgs)

Called before the PointerExited event occurs.

Declaration

protected override void OnPointerExited(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	Event data for the event.

OnPointerMoved(PointerRoutedEventArgs)

Called before the PointerMoved event occurs.

Declaration

protected override void OnPointerMoved(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	Event data for the event.

OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs.

Declaration

protected override void OnPointerPressed(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	Event data for the event.

OnPointerReleased(PointerRoutedEventArgs)

Called before the PointerReleased event occurs.

Declaration

protected override void OnPointerReleased(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	Event data for the event.

OnPointerWheelChanged(PointerRoutedEventArgs)

Called before the PointerWheelChanged event occurs.

Declaration

protected override void OnPointerWheelChanged(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	Event data for the event.

OnSpellCheckerChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the spellchecker changed.

Declaration

protected static void OnSpellCheckerChanged(DependencyObject dependencyObject, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
Windows.UI.Xaml.DependencyObject	dependencyObject	The Windows.UI.Xaml.DependencyObject.
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	The Windows.UI.Xaml.DependencyPropertyChangedEventArgs.

OnSpellCheckerChanged(DependencyPropertyChangedEventArgs)

called when spellchecker changed.

Declaration

protected virtual void OnSpellCheckerChanged(DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	The Windows.UI.Xaml.DependencyPropertyChangedEventArgs.

OnTapped(TappedRoutedEventArgs)

Called before the Tapped event occurs.

Declaration

protected override void OnTapped(TappedRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.TappedRoutedEventArgs	e	Event data for the event.

remove_CommentAdding(SfRichTextBoxAdv.CommentAddingEventHandler)

Declaration

public void remove_CommentAdding(SfRichTextBoxAdv.CommentAddingEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.CommentAddingEventHandler	value

remove_ContentChanged(SfRichTextBoxAdv.ContentChangedEventHandler)

Declaration

public void remove_ContentChanged(SfRichTextBoxAdv.ContentChangedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.ContentChangedEventHandler	value

remove_DocumentChanged(SfRichTextBoxAdv.DocumentChangedEventHandler)

Declaration

public void remove_DocumentChanged(SfRichTextBoxAdv.DocumentChangedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.DocumentChangedEventHandler	value

remove_FileLoadingFailed(SfRichTextBoxAdv.FileLoadingFailedEventHandler)

Declaration

public void remove_FileLoadingFailed(SfRichTextBoxAdv.FileLoadingFailedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.FileLoadingFailedEventHandler	value

remove_PrintCompleted(SfRichTextBoxAdv.PrintCompletedEventHandler)

Declaration

public void remove_PrintCompleted(SfRichTextBoxAdv.PrintCompletedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.PrintCompletedEventHandler	value

remove_RequestNavigate(SfRichTextBoxAdv.RequestNavigateEventHandler)

Declaration

public void remove_RequestNavigate(SfRichTextBoxAdv.RequestNavigateEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.RequestNavigateEventHandler	value

remove_SelectionChanged(SfRichTextBoxAdv.SelectionChangedEventHandler)

Declaration

public void remove_SelectionChanged(SfRichTextBoxAdv.SelectionChangedEventHandler value)

Parameters

Type	Name	Description
SfRichTextBoxAdv.SelectionChangedEventHandler	value

ResetZooming()

Resets the zooming to 100% in SfRichTextBoxAdv control.

Declaration

public void ResetZooming()

Remarks

If SfRichTextBoxAdv control is loaded, then the ZoomFactor property is set to 100.

Examples

The following code example demonstrates how to reset the zooming factor of SfRichTextBoxAdv.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public void ResetZooming()
{
    richTextBoxAdv.Dispose();
}

Public Sub ResetZooming()
    richTextBoxAdv.ResetZooming()
End Sub

Save(Stream, FormatType)

Exports the SfRichTextBoxAdv content into the specified System.IO.Stream in specified FormatType.

Declaration

public void Save(Stream stream, FormatType formatType)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream to export the content.
FormatType	formatType	The FormatType to export.

Examples

The following code example demonstrates how to export the SfRichTextBoxAdv content into the stream.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public void SaveStream()
{
    // Initializes the stream.
    Stream stream = new MemoryStream();
// Exports the content into the stream as Docx Format.
richTextBoxAdv.Save(stream, FormatType.Docx);

// Seek the stream to starting position.
stream.Position = 0;

// Process the stream here.

}

Public Sub SaveStream()

    ' Initializes the stream.
    Dim stream As Stream = New MemoryStream()

    ' Exports the content into the stream as Docx Format.
    richTextBoxAdv.Save(stream, FormatType.Docx)

    ' Seek the stream to starting position.
    stream.Position = 0

    ' Process the stream here.
End Sub

Exceptions

Type	Condition
System.ArgumentNullException	Stream cannot be null.

Save(StorageFile)

Exports the SfRichTextBoxAdv content into the Windows.Storage.StorageFile.

Declaration

public void Save(StorageFile storageFile)

Parameters

Type	Name	Description
Windows.Storage.StorageFile	storageFile	The Windows.Storage.StorageFile to export the content.

Examples

The following code example demonstrates how to export the SfRichTextBoxAdv content into a storage file.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public async void SaveFile()
{
    FileSavePicker fileSavePicker = new FileSavePicker();
    fileSavePicker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary;
    fileSavePicker.FileTypeChoices.Add("Word Document", new List<string>() { ".docx" });
    fileSavePicker.FileTypeChoices.Add("Word 97-2003 Document", new List<string>() { ".doc" });
     fileSavePicker.FileTypeChoices.Add("Word Template", new List<string>() { ".dotx" });
    fileSavePicker.FileTypeChoices.Add("Word 97-2003 Template", new List<string>() { ".dot" });
    fileSavePicker.FileTypeChoices.Add("Rich Text Document", new List<string>() { ".rtf" });
    fileSavePicker.FileTypeChoices.Add("Web Page, Filtered", new List<string>() { ".html" });
    fileSavePicker.FileTypeChoices.Add("Word XML Document", new List<string>() { ".xml" });
    fileSavePicker.FileTypeChoices.Add("Plain Text", new List<string>() { ".txt" });
    fileSavePicker.SuggestedFileName = "New Document";
    StorageFile file = await fileSavePicker.PickSaveFileAsync();
// Exports the content into the file.
if (file != null)
    richTextBoxAdv.Save(file);

} 

Public Async Function SaveFile() As Task
    Dim fileSavePicker As New FileSavePicker()
    fileSavePicker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary
    fileSavePicker.FileTypeChoices.Add("Word Document", New List(Of String)() From { _
       ".docx" _
    })
    fileSavePicker.FileTypeChoices.Add("Word 97-2003 Document", New List(Of String)() From { _
        ".doc" _
    })
     fileSavePicker.FileTypeChoices.Add("Word Template", New List(Of String)() From { _
       ".dotx" _
    })
    fileSavePicker.FileTypeChoices.Add("Word 97-2003 Template", New List(Of String)() From { _
        ".dot" _
    })
    fileSavePicker.FileTypeChoices.Add("Rich Text Document", New List(Of String)() From { _
        ".rtf" _
    })
    fileSavePicker.FileTypeChoices.Add("Web Page, Filtered", New List(Of String)() From { _
        ".html" _
    })
    fileSavePicker.FileTypeChoices.Add("Word XML Document", New List(Of String)() From { _
        ".xml" _
    })
    fileSavePicker.FileTypeChoices.Add("Plain Text", New List(Of String)() From { _
        ".txt" _
    })
    fileSavePicker.SuggestedFileName = "New Document"
    Dim file As Windows.Storage.StorageFile = Await fileSavePicker.PickSaveFileAsync()

    ' Exports the content into the file.
    If file IsNot Nothing Then
         richTextBoxAdv.Save(file)
    End If
End Function

Exceptions

Type	Condition
System.ArgumentNullException	StorageFile cannot be null.

SaveAsync(Stream, FormatType)

Asynchronously exports the SfRichTextBoxAdv document content as specified FormatType into the System.IO.Stream.

Declaration

public Task<bool> SaveAsync(Stream stream, FormatType formatType)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream to export the content.
FormatType	formatType	The FormatType to export.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the asynchronous save operation.

Examples

The following code example demonstrates how to asynchronously export the SfRichTextBoxAdv content into a stream.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public async void SaveStream()
{
    // Initializes the stream.
    Stream stream = new MemoryStream();
// Exports the content into the stream as Docx Format asynchronously.
await richTextBoxAdv.SaveAsync(stream, FormatType.Docx);

// Seek the stream to starting position.
stream.Position = 0;

// Process the stream here.

}

Public Async Function SaveStream() As Task

    ' Initializes the stream.
    Dim stream As Stream = New MemoryStream()

    ' Exports the content into the stream as Docx Format asynchronously.
    Await richTextBoxAdv.SaveAsync(stream, FormatType.Docx)

    ' Seek the stream to starting position.
    stream.Position = 0

    ' Process the stream here.
End Function

Exceptions

Type	Condition
System.ArgumentNullException	Stream cannot be null.

SaveAsync(StorageFile)

Asynchronously exports the SfRichTextBoxAdv content into the specified Windows.Storage.StorageFile.

Declaration

public Task<bool> SaveAsync(StorageFile storageFile)

Parameters

Type	Name	Description
Windows.Storage.StorageFile	storageFile	The Windows.Storage.StorageFile to export the content.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the asynchronous save operation.

Examples

The following code example demonstrates how to asynchronously export the SfRichTextBoxAdv content into a storage file.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public async void SaveFile()
{
    FileSavePicker fileSavePicker = new FileSavePicker();
    fileSavePicker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary;
    fileSavePicker.FileTypeChoices.Add("Word Document", new List<string>() { ".docx" });
    fileSavePicker.FileTypeChoices.Add("Word 97-2003 Document", new List<string>() { ".doc" });
     fileSavePicker.FileTypeChoices.Add("Word Template", new List<string>() { ".dotx" });
    fileSavePicker.FileTypeChoices.Add("Word 97-2003 Template", new List<string>() { ".dot" });
    fileSavePicker.FileTypeChoices.Add("Rich Text Document", new List<string>() { ".rtf" });
    fileSavePicker.FileTypeChoices.Add("Web Page, Filtered", new List<string>() { ".html" });
    fileSavePicker.FileTypeChoices.Add("Word XML Document", new List<string>() { ".xml" });
    fileSavePicker.FileTypeChoices.Add("Plain Text", new List<string>() { ".txt" });
    fileSavePicker.SuggestedFileName = "New Document";
    StorageFile file = await fileSavePicker.PickSaveFileAsync();
// Exports the content into the file asynchronously.
if (file != null)
    await richTextBoxAdv.SaveAsync(file);

} 

Public Async Function SaveFile() As Task
    Dim fileSavePicker As New FileSavePicker()
    fileSavePicker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary
    fileSavePicker.FileTypeChoices.Add("Word Document", New List(Of String)() From { _
       ".docx" _
    })
    fileSavePicker.FileTypeChoices.Add("Word 97-2003 Document", New List(Of String)() From { _
        ".doc" _
    })
     fileSavePicker.FileTypeChoices.Add("Word Template", New List(Of String)() From { _
       ".dotx" _
    })
    fileSavePicker.FileTypeChoices.Add("Word 97-2003 Template", New List(Of String)() From { _
        ".dot" _
    })
    fileSavePicker.FileTypeChoices.Add("Rich Text Document", New List(Of String)() From { _
        ".rtf" _
    })
    fileSavePicker.FileTypeChoices.Add("Web Page, Filtered", New List(Of String)() From { _
        ".html" _
    })
    fileSavePicker.FileTypeChoices.Add("Word XML Document", New List(Of String)() From { _
        ".xml" _
    })
    fileSavePicker.FileTypeChoices.Add("Plain Text", New List(Of String)() From { _
        ".txt" _
    })
    fileSavePicker.SuggestedFileName = "New Document"
    Dim file As Windows.Storage.StorageFile = Await fileSavePicker.PickSaveFileAsync()

    ' Exports the content into the file asynchronously.
    If file IsNot Nothing Then
         Await richTextBoxAdv.SaveAsync(file)
    End If
End Function

Exceptions

Type	Condition
System.ArgumentNullException	StorageFile cannot be null.

SavePageAsImageAsync(Stream, Int32)

Declaration

public Task<bool> SavePageAsImageAsync(Stream stream, int pageNumber)

Parameters

Type	Name	Description
System.IO.Stream	stream
System.Int32	pageNumber

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

SavePageAsImageAsync(StorageFile, Int32)

Asynchronously saves the specified page of SfRichTextBoxAdv into the specified Windows.Storage.StorageFile instance.

Declaration

public Task<bool> SavePageAsImageAsync(StorageFile storageFile, int pageNumber)

Parameters

Type	Name	Description
Windows.Storage.StorageFile	storageFile	The Windows.Storage.StorageFile instance to save.
System.Int32	pageNumber	The page number of SfRichTextBoxAdv.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the asynchronous operation to save the page of SfRichTextBoxAdv as image.

Examples

The following code example demonstrate how to save the first page in SfRichTextBoxAdv into a StorageFile.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv"/>

public async Task<bool> SaveFirstPageAsync(StorageFile file)
{
    TaskCompletionSource<bool> tcs = new TaskCompletionSource<bool>();
// Saves the first page in SfRichTextBoxAdv control into the file.
await richTextBoxAdv.SavePageAsImageAsync(file, 0);

 tcs.SetResult(true);
 return await tcs.Task;

}

Public Async Function SaveFirstPageAsync(StorageFile file) As Task(Of Boolean)

    Dim tcs As TaskCompletionSource(Of Boolean) = New TaskCompletionSource(Of Boolean)

    ' Saves the first page in SfRichTextBoxAdv control into the file.
    Await richTextBoxAdv.SavePageAsImageAsync(file, 0)

    tcs.SetResult(True)
    Return Await tcs.Task
End Function

Exceptions

Type	Condition
System.ArgumentNullException	StorageFile cannot be null.
System.InvalidOperationException	This operation is invalid since the document loading is in progress.
System.IndexOutOfRangeException	Index was out of range. Must be non-negative and less than the size of the collection.

Events

CommentAdding

Occurs when the CommentAdv is added to the SfRichTextBoxAdv.

Declaration

public event SfRichTextBoxAdv.CommentAddingEventHandler CommentAdding

Event Type

Type	Description
SfRichTextBoxAdv.CommentAddingEventHandler

Examples

The following code example demonstrates how to define author, inital and visual style of the comment. when a hyperlink is tapped or clicked by using CTRL key.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" CommentAdding="RichTextBoxAdv_CommentAdding" />

bool isFileLoading = false;
public void RichTextBoxAdv_CommentAdding(object obj, CommentAddingEventArgs args)
{
if (isFileLoading)
return;
// Defines the author and intial of the comment.
CommentAdv commentAdv = args.Comment;
commentAdv.Author = "Peter";
commentAdv.Initial = "F";
// Defines the visual style of the comment.
CommentVisualStyle visualStyle = args.VisualStyle;
visualStyle.BackgroundBrush = new SolidColorBrush(Colors.LightPink);
visualStyle.BorderBrush = new SolidColorBrush(Colors.Pink);
visualStyle.HighlightColor = Colors.LightPink;

}

Dim isFileLoading As Boolean = False

Public Sub RichTextBoxAdv_CommentAdding(obj As Object, args As CommentAddingEventArgs)
    If isFileLoading Then
        Return
    End If
    ' Defines the author and intial of the comment.
    Dim commentAdv As CommentAdv = args.Comment
    commentAdv.Author = "Peter"
    commentAdv.Initial = "F"

    ' Defines the visual style of the comment.
    Dim visualStyle As CommentVisualStyle = args.VisualStyle
    visualStyle.BackgroundBrush = New SolidColorBrush(Colors.LightPink)
    visualStyle.BorderBrush = New SolidColorBrush(Colors.Pink)
    visualStyle.HighlightColor = Colors.LightPink
End Sub

ContentChanged

Occurs when the content is changed in the SfRichTextBoxAdv.

Declaration

public event SfRichTextBoxAdv.ContentChangedEventHandler ContentChanged

Event Type

Type	Description
SfRichTextBoxAdv.ContentChangedEventHandler

Remarks

This event will be triggered whenever operations such as content insertion, content deletion, formatting changes occur in the SfRichTextBoxAdv.

DocumentChanged

Occurs when the document is changed in the SfRichTextBoxAdv.

Declaration

public event SfRichTextBoxAdv.DocumentChangedEventHandler DocumentChanged

Event Type

Type	Description
SfRichTextBoxAdv.DocumentChangedEventHandler

Remarks

This event can be used to stop the busy indicator when document opening process completed and start showing the busy indicator using DocumentChanging event

DocumentChanging

Occurs when opening a document in the SfRichTextBoxAdv.

Declaration

public event EventHandler<DocumentChangingEventArgs> DocumentChanging

Event Type

Type	Description
System.EventHandler<DocumentChangingEventArgs>

Remarks

This event can be used to start the busy indicator when document opening process starts and stop showing the busy indicator using DocumentChanged event

DocumentSaved

Occurs after the document is saved in the SfRichTextBoxAdv.

Declaration

public event EventHandler<DocumentSavedEventArgs> DocumentSaved

Event Type

Type	Description
System.EventHandler<DocumentSavedEventArgs>

Remarks

This event can be used to stop the busy indicator when document saving process completed and start showing the busy indicator using DocumentSaving event

DocumentSaving

Occurs when saving a document in the SfRichTextBoxAdv.

Declaration

public event EventHandler<DocumentSavingEventArgs> DocumentSaving

Event Type

Type	Description
System.EventHandler<DocumentSavingEventArgs>

Remarks

This event can be used to start the busy indicator when document saving process starts and stop showing the busy indicator using DocumentSaved event

FileLoadingFailed

Occurs when the file loading operation is failed in the SfRichTextBoxAdv.

Declaration

public event SfRichTextBoxAdv.FileLoadingFailedEventHandler FileLoadingFailed

Event Type

Type	Description
SfRichTextBoxAdv.FileLoadingFailedEventHandler

PrintCompleted

Occurs when the printing is completed in the SfRichTextBoxAdv.

Declaration

public event SfRichTextBoxAdv.PrintCompletedEventHandler PrintCompleted

Event Type

Type	Description
SfRichTextBoxAdv.PrintCompletedEventHandler

RequestNavigate

Occurs when hyperlink navigation is requested in the SfRichTextBoxAdv.

Declaration

public event SfRichTextBoxAdv.RequestNavigateEventHandler RequestNavigate

Event Type

Type	Description
SfRichTextBoxAdv.RequestNavigateEventHandler

Examples

The following code example demonstrates how to customize the hyperlink navigation when a hyperlink is tapped or clicked by using CTRL key.

<RichTextBoxAdv:SfRichTextBoxAdv xmlns:RichTextBoxAdv="using:Syncfusion.UI.Xaml.RichTextBoxAdv"
   x:Name="richTextBoxAdv" ManipulationMode="All" RequestNavigate="SfRichTextBoxAdv_RequestNavigate"/>

public async void SfRichTextBoxAdv_RequestNavigate(object obj, RequestNavigateEventArgs args)
{
    if (args.Hyperlink.LinkType == HyperlinkType.Webpage || args.Hyperlink.LinkType == HyperlinkType.Email)
    {
        // If the link is a webpage or e-mail, launces the URI.
        Uri uri = new Uri(args.Hyperlink.NavigationLink);
        await Windows.System.Launcher.LaunchUriAsync(uri);
    }
    // If the link to a file.
    else if (args.Hyperlink.LinkType == HyperlinkType.File)
    {
        // Handle your code here.
    }
}

Public Async Sub SfRichTextBoxAdv_RequestNavigate(obj As Object, args As Syncfusion.UI.Xaml.RichTextBoxAdv.RequestNavigateEventArgs)
    If args.Hyperlink.LinkType = HyperlinkType.Webpage OrElse args.Hyperlink.LinkType = HyperlinkType.Email Then
        ' If the link is a webpage or e-mail, launces the URI.
        Dim uri As New Uri(args.Hyperlink.NavigationLink)
        Await Windows.System.Launcher.LaunchUriAsync(uri)
        ' If the link to a file.
        ' Handle your code here.
    ElseIf args.Hyperlink.LinkType = HyperlinkType.File Then
    End If
End Sub

SelectionChanged

Occurs when the selection is changed in the SfRichTextBoxAdv.

Declaration

public event SfRichTextBoxAdv.SelectionChangedEventHandler SelectionChanged

Event Type

Type	Description
SfRichTextBoxAdv.SelectionChangedEventHandler

ZoomFactorChanged

Occurs when the zoom factor is changed in the SfRichTextBoxAdv.

Declaration

public event DependencyPropertyChangedEventHandler ZoomFactorChanged

Event Type

Type	Description
Windows.UI.Xaml.DependencyPropertyChangedEventHandler

Extension Methods

DateTimeExtension.ToDateTime(Object)