WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TextRange - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TextRange

    Represents minimal text run that has same formatting.

    Inheritance
    System.Object
    EntityBase
    XDLSSerializableBase
    WidgetBase
    ParagraphItem
    TextRange
    Field
    Implements
    IXDLSSerializable
    ITextRange
    IParagraphItem
    IEntityBase
    IStringWidget
    ISplitLeafWidget
    ILeafWidget
    IWidget
    ITextMeasurable
    Inherited Members
    ParagraphItem.m_iStartIndex
    ParagraphItem.WriteXmlAttributes(IXDLSAttributeWriter)
    ParagraphItem.ReadXmlAttributes(IXDLSAttributeReader)
    ParagraphItem.OwnerParagraph
    ParagraphItem.StartIndex
    WidgetBase.m_layoutInfo
    WidgetBase.DrawImpl(CustomGraphics, LayoutedWidget)
    WidgetBase.IWidget.LayoutInfo
    XDLSSerializableBase.m_id
    XDLSSerializableBase.IXDLSSerializable.WriteXmlAttributes(IXDLSAttributeWriter)
    XDLSSerializableBase.IXDLSSerializable.WriteXmlContent(IXDLSContentWriter)
    XDLSSerializableBase.IXDLSSerializable.ReadXmlAttributes(IXDLSAttributeReader)
    XDLSSerializableBase.IXDLSSerializable.ReadXmlContent(IXDLSContentReader)
    XDLSSerializableBase.IXDLSSerializable.RestoreReference(String, Int32)
    XDLSSerializableBase.RestoreReference(String, Int32)
    XDLSSerializableBase.IXDLSSerializable.XDLSHolder
    XDLSSerializableBase.XDLSHolder
    EntityBase.SetOwner(IEntityBase)
    EntityBase.Owner
    EntityBase.Document
    EntityBase.DocumentEx
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.DLS
    Assembly: Syncfusion.DLS.Base.dll
    Syntax
    public class TextRange : ParagraphItem, IXDLSSerializable, ITextRange, IParagraphItem, IEntityBase, IStringWidget, ISplitLeafWidget, ILeafWidget, IWidget, ITextMeasurable

    Constructors

    TextRange(IDocument)

    Initializing constructor

    Declaration
    public TextRange(IDocument doc)
    Parameters
    Type Name Description
    IDocument doc

    TextRange(ITextRange, IParagraph)

    Declaration
    protected TextRange(ITextRange txtRange, IParagraph paragraph)
    Parameters
    Type Name Description
    ITextRange txtRange
    IParagraph paragraph

    Fields

    m_bDetached

    Declaration
    protected bool m_bDetached
    Field Value
    Type Description
    System.Boolean

    m_format

    Declaration
    protected CharacterFormat m_format
    Field Value
    Type Description
    CharacterFormat

    m_strDetachedText

    Declaration
    protected string m_strDetachedText
    Field Value
    Type Description
    System.String

    Properties

    CharacterFormat

    Gets character format( font properties ).

    Declaration
    public CharacterFormat CharacterFormat { get; }
    Property Value
    Type Description
    CharacterFormat

    Hyperlink

    Gets hyperlink object.

    Declaration
    public Hyperlink Hyperlink { get; }
    Property Value
    Type Description
    Hyperlink

    OwnerParagraphEx

    Gets owner paragraph.

    Declaration
    protected Paragraph OwnerParagraphEx { get; }
    Property Value
    Type Description
    Paragraph

    Text

    Gets / sets text.

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

    TextLength

    Gets length of the text.

    Declaration
    protected int TextLength { get; set; }
    Property Value
    Type Description
    System.Int32

    Methods

    Clone(IParagraph)

    Declaration
    public override IParagraphItem Clone(IParagraph paragraph)
    Parameters
    Type Name Description
    IParagraph paragraph
    Returns
    Type Description
    IParagraphItem
    Overrides
    ParagraphItem.Clone(IParagraph)

    CreateLayoutInfo()

    Declaration
    protected override void CreateLayoutInfo()
    Overrides
    WidgetBase.CreateLayoutInfo()

    GetTextAscent(CustomGraphics)

    Declaration
    public double GetTextAscent(CustomGraphics cg)
    Parameters
    Type Name Description
    CustomGraphics cg
    Returns
    Type Description
    System.Double

    InitXDLSHolder()

    Declaration
    protected override void InitXDLSHolder()
    Overrides
    XDLSSerializableBase.InitXDLSHolder()

    Measure(CustomGraphics)

    Declaration
    public SizeF Measure(CustomGraphics cg)
    Parameters
    Type Name Description
    CustomGraphics cg
    Returns
    Type Description
    System.Drawing.SizeF

    ReadXmlContent(IXDLSContentReader)

    Declaration
    protected override bool ReadXmlContent(IXDLSContentReader reader)
    Parameters
    Type Name Description
    IXDLSContentReader reader
    Returns
    Type Description
    System.Boolean
    Overrides
    XDLSSerializableBase.ReadXmlContent(IXDLSContentReader)

    SetOwnerParagraph(IParagraph, Int32)

    Declaration
    protected override void SetOwnerParagraph(IParagraph paragraph, int startIndex)
    Parameters
    Type Name Description
    IParagraph paragraph
    System.Int32 startIndex
    Overrides
    ParagraphItem.SetOwnerParagraph(IParagraph, Int32)

    WriteXmlContent(IXDLSContentWriter)

    Declaration
    protected override void WriteXmlContent(IXDLSContentWriter writer)
    Parameters
    Type Name Description
    IXDLSContentWriter writer
    Overrides
    XDLSSerializableBase.WriteXmlContent(IXDLSContentWriter)

    Explicit Interface Implementations

    ISplitLeafWidget.SplitByOffset(CustomGraphics, SizeF)

    Declaration
    ISplitLeafWidget[] ISplitLeafWidget.SplitByOffset(CustomGraphics cg, SizeF offset)
    Parameters
    Type Name Description
    CustomGraphics cg
    System.Drawing.SizeF offset
    Returns
    Type Description
    ISplitLeafWidget[]

    IStringWidget.Draw(CustomGraphics, LayoutedWidget, String)

    Declaration
    void IStringWidget.Draw(CustomGraphics cg, LayoutedWidget ltWidget, string text)
    Parameters
    Type Name Description
    CustomGraphics cg
    LayoutedWidget ltWidget
    System.String text

    IStringWidget.OffsetToIndex(CustomGraphics, Double, String)

    Declaration
    int IStringWidget.OffsetToIndex(CustomGraphics cg, double offset, string text)
    Parameters
    Type Name Description
    CustomGraphics cg
    System.Double offset
    System.String text
    Returns
    Type Description
    System.Int32

    ITextMeasurable.Measure(CustomGraphics, String)

    Declaration
    SizeF ITextMeasurable.Measure(CustomGraphics cg, string text)
    Parameters
    Type Name Description
    CustomGraphics cg
    System.String text
    Returns
    Type Description
    System.Drawing.SizeF

    IWidget.Draw(CustomGraphics, LayoutedWidget)

    Declaration
    void IWidget.Draw(CustomGraphics cg, LayoutedWidget ltWidget)
    Parameters
    Type Name Description
    CustomGraphics cg
    LayoutedWidget ltWidget

    Implements

    IXDLSSerializable
    ITextRange
    IParagraphItem
    IEntityBase
    IStringWidget
    ISplitLeafWidget
    ILeafWidget
    IWidget
    ITextMeasurable
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved