menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RichTextBoxAdv - API Reference

    Show / Hide Table of Contents

    Class RichTextBoxAdv

    RichTextBoxAdv class.

    Inheritance
    System.Object
    RichTextBoxAdv
    Namespace: Syncfusion.Windows.Forms.Diagram
    Assembly: Syncfusion.Diagram.Utility.Windows.dll
    Syntax
    public class RichTextBoxAdv : RichTextBox

    Constructors

    RichTextBoxAdv()

    Declaration
    public RichTextBoxAdv()

    Properties

    Rtf

    Gets or sets the Rtf string.

    Declaration
    public string Rtf { get; set; }
    Property Value
    Type Description
    System.String

    SelectionAlignment

    Gets or sets the alignment to apply to the current selection or insertion point.

    Declaration
    public RichTextBoxAdv.TextAlign SelectionAlignment { get; set; }
    Property Value
    Type Description
    RichTextBoxAdv.TextAlign
    Remarks

    Replaces the SelectionAlignment from System.Windows.Forms.RichTextBox.

    SelectionBackColor

    Gets or sets the selections background color

    Declaration
    public Color SelectionBackColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    SelectionUnderlineColor

    Gets or sets the underline color to apply to the current selection or insertion point.

    Declaration
    public RichTextBoxAdv.UnderlineColor SelectionUnderlineColor { get; set; }
    Property Value
    Type Description
    RichTextBoxAdv.UnderlineColor
    Remarks

    Underline colors can be set to any value of the RichTextBoxAdv.UnderlineColor enumeration.

    SelectionUnderlineStyle

    Gets or sets the underline style to apply to the current selection or insertion point.

    Declaration
    public RichTextBoxAdv.UnderlineStyle SelectionUnderlineStyle { get; set; }
    Property Value
    Type Description
    RichTextBoxAdv.UnderlineStyle
    Remarks

    Underline styles can be set to any value of the RichTextBoxAdv.UnderlineStyle enumeration.

    Text

    Gets or sets the text.

    Declaration
    public override string Text { get; set; }
    Property Value
    Type Description
    System.String

    TextLength

    Gets the string length.

    Declaration
    public override int TextLength { get; }
    Property Value
    Type Description
    System.Int32

    Methods

    BeginUpdate()

    Lock control updating till proper call of EndUpdate Method. Each call of BeginUpdate must be corresponding EndUpdate, otherwise control redrawing will be locked

    Declaration
    protected void BeginUpdate()

    EndUpdate()

    UnLock control update

    Declaration
    protected void EndUpdate()

    GetCharFormat()

    Gets the char format.

    Declaration
    [CLSCompliant(false)]
    protected RichTextNativeMethods.CHARFORMAT2 GetCharFormat()
    Returns
    Type Description
    Syncfusion.Runtime.InteropServices.WinAPI.RichTextNativeMethods.CHARFORMAT2

    CHAR format.

    OnHandleCreated(EventArgs)

    This member overrides System.Windows.Forms.Control.OnHandleCreated.

    Declaration
    protected override void OnHandleCreated(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    Event args.

    OnRtfChanged(EventArgs)

    Raises the RtfChanged event.

    Declaration
    protected virtual void OnRtfChanged(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    The System.EventArgs instance containing the event data.

    ToggleSelectionFontStyle(FontStyle)

    Toggles the selection font style.

    Declaration
    public void ToggleSelectionFontStyle(FontStyle value)
    Parameters
    Type Name Description
    System.Drawing.FontStyle value

    The value.

    UnderlineSelection(Int32, Int32, RichTextBoxAdv.UnderlineStyle, RichTextBoxAdv.UnderlineColor)

    Underlines the selection.

    Declaration
    [CLSCompliant(false)]
    protected void UnderlineSelection(int position, int length, RichTextBoxAdv.UnderlineStyle style, RichTextBoxAdv.UnderlineColor color)
    Parameters
    Type Name Description
    System.Int32 position

    The position.

    System.Int32 length

    The length.

    RichTextBoxAdv.UnderlineStyle style

    The style.

    RichTextBoxAdv.UnderlineColor color

    The color.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved