Class EditorSettings

Represents the common editing settings for the control SfRichTextBoxAdv.

Inheritance

System.Object

EditorSettings

Namespace: Syncfusion.Windows.Controls.RichTextBoxAdv

Assembly: Syncfusion.SfRichTextBoxAdv.WPF.dll

Syntax

public class EditorSettings : DependencyObject

Constructors

EditorSettings()

Initializes a new instance of the EditorSettings class.

Declaration

public EditorSettings()

Fields

CanUndoStyleProperty

Identifies the CanUndoStyle dependency property.

Declaration

public static readonly DependencyProperty CanUndoStyleProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the CanUndoStyle dependency property.

DisplayScreenTipsProperty

Identifies the DisplayScreenTips dependency property.

Declaration

public static readonly DependencyProperty DisplayScreenTipsProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the DisplayScreenTips dependency property.

IsCommentPaneVisibleProperty

Identifies the IsCommentPaneVisible dependency property.

Declaration

public static readonly DependencyProperty IsCommentPaneVisibleProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the IsCommentPaneVisible dependency property.

IsInElementHostProperty

Identifies the IsInElementHost dependency property.

Declaration

public static readonly DependencyProperty IsInElementHostProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the IsInElementHost dependency property.

IsUndoEnabledProperty

Identifies the IsUndoEnabled dependency property.

Declaration

public static readonly DependencyProperty IsUndoEnabledProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the IsUndoEnabled dependency property.

PrintCommentsProperty

Identifies the PrintComments dependency property.

Declaration

public static readonly DependencyProperty PrintCommentsProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the PrintComments dependency property.

ResizingModeProperty

Identifies the ResizingMode dependency property.

Declaration

public static readonly DependencyProperty ResizingModeProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the ResizingMode dependency property.

Properties

CanUndoStyle

Gets or sets a value indicates whether the undo support is enabled for the DocumentStyle in the SfRichTextBoxAdv control.

Declaration

public bool CanUndoStyle { get; set; }

Property Value

Type	Description
System.Boolean	True if the undo support is enabled for the DocumentStyle;otherwise, false. The default value is true.

Examples

The following code example demonstrates how to enable or disable style undo support in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with undo style operation disabled. -->
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv">
    <RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
        <!-- Defines editor settings with undo style operation disabled -->
        <RichTextBoxAdv:EditorSettings CanUndoStyle="False" />
    </RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the SfRichTextBoxAdv control with style undo operation disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.EditorSettings.CanUndoStyle = false;

' Defines the SfRichTextBoxAdv control with style undo operation disabled.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.EditorSettings.CanUndoStyle = false

DisplayScreenTips

Gets or sets a value that indicates whether the screen tip can be displayed for the hyperlink in the SfRichTextBoxAdv control. The default is true.

Declaration

public bool DisplayScreenTips { get; set; }

Property Value

Type	Description
System.Boolean	True if the screen tip can be displayed for the hyperlink. Otherwise, False.

Examples

The following code example demonstrates how to enable or disable screen tip for the hyperlink in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with screen tip of the hyperlink is disabled.-->
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv">
    <RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
        <!-- Defines editor settings with screen tip of the hyperlink is disabled. -->
        <RichTextBoxAdv:EditorSettings DisplayScreenTips="False" />
    </RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>

//Defines the SfRichTextBoxAdv control with screen tip of the hyperlink as disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.EditorSettings.DisplayScreenTips = false;

'Defines the SfRichTextBoxAdv control with screen tip of the hyperlink as disabled.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.EditorSettings.DisplayScreenTips = False

IsCommentPaneVisible

Gets a value indicating whether the comment pane is currently visible or not in the SfRichTextBoxAdv control.

Declaration

public bool IsCommentPaneVisible { get; }

Property Value

Type	Description
System.Boolean	True if the comment pane is visible.Otherwise, False.

Examples

The following code example demonstrates how to get a value indicating whether the comment pane is currently visible or hidden in the SfRichTextBoxAdv control.

// Defines the SfRichTextBoxAdv control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
// Gets a value indicating whether the comment pane is currently visible or hidden in the SfRichTextBoxAdv control.
bool isCommentPaneVisible = richTextBoxAdv.EditorSettings.IsCommentPaneVisible;

' Defines the SfRichTextBoxAdv control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
'Gets a value indicating whether the comment pane is currently visible or hidden in the SfRichTextBoxAdv.
Dim isCommentPaneVisible As Boolean = richTextBoxAdv.EditorSettings.IsCommentPaneVisible

IsInElementHost

Gets or sets a value indicating whether the SfRichTextBoxAdv control is hosted in Windows Forms application using ElementHost control.

Declaration

public bool IsInElementHost { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false.

Remarks

This property enables compatibility of Input Method Editor (IME) in Windows Forms application. It is applicable only when the WPF SfRichTextBoxAdv control is hosted in Windows Forms application using ElementHost control and not applicable for WPF application.

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 the editor settings indicating the control is hosted in Windows Forms application using ElementHost control -->
        <RichTextBoxAdv:EditorSettings IsInElementHost="True" />
    </RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
//Defines the editor settings indicating the control is hosted in Windows Forms application using ElementHost control.
EditorSettings editorSettings = new EditorSettings();
editorSettings.IsInElementHost = true;
richTextBoxAdv.EditorSettings = editorSettings;

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

'Defines the editor settings indicating the control is hosted in Windows Forms application using ElementHost control.
Dim loadAsyncSettings As New EditorSettings()
editorSettings.IsInElementHost = True

richTextBoxAdv.EditorSettings = editorSettings

IsUndoEnabled

Gets or sets a value that indicates whether undo support is enabled for the SfRichTextBoxAdv control.

Declaration

public bool IsUndoEnabled { get; set; }

Property Value

Type	Description
System.Boolean	True if the undo support is enabled;otherwise, false. The default value is true.

Examples

The following code example demonstrates how to enable or disable undo support in SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with undo operation disabled. -->
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv">
    <RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
        <!-- Defines editor settings with undo operation disabled -->
        <RichTextBoxAdv:EditorSettings IsUndoEnabled="False" />
    </RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>

// Defines the SfRichTextBoxAdv control with undo operation disabled.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.EditorSettings.IsUndoEnabled = false;

' Defines the SfRichTextBoxAdv control with undo operation disabled.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.EditorSettings.IsUndoEnabled = false

PrintComments

Gets or sets a value that indicates whether the comments need to be shown while printing the document in the SfRichTextBoxAdv control. The default is true.

Declaration

public bool PrintComments { get; set; }

Property Value

Type	Description
System.Boolean	True if the comments can be shown on printing.Otherwise, False.

Examples

The following code example demonstrates how to hide the comments while printing in the SfRichTextBoxAdv control.

<!-- Defines the SfRichTextBoxAdv control with comments hidden while printing.-->
<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv">
    <RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
        <!-- Defines editor settings with comments hidden for printing. -->
        <RichTextBoxAdv:EditorSettings PrintComments="False" />
    </RichTextBoxAdv:SfRichTextBoxAdv.EditorSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>

//Defines the SfRichTextBoxAdv control with comments hidden for printing.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();
richTextBoxAdv.EditorSettings.PrintComments = false;

'Defines the SfRichTextBoxAdv control with comments hidden for printing.
Dim richTextBoxAdv As New SfRichTextBoxAdv()
richTextBoxAdv.EditorSettings.PrintComments = False

ResizingMode

A ResizingMode enumeration value that specifies when the element being resized should be redrawn.

Declaration

public ResizingMode ResizingMode { get; set; }

Property Value

Type	Description
ResizingMode	The default value is Delayed.

Remarks

This property is to control whether a element is redrawn dynamically during the resizing operation (the Live value), or the element is redrawn after the resizing operation is finished (the Delayed value).

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