Class RichTextStringGroup

Summary description for RichTextStringGroup.

Inheritance
System.Object
CommonObject
RichTextStringGroup
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Implementation.Collections.Grouping
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class RichTextStringGroup : CommonObject, IDisposable, IRichTextString, IParentApplication, IOptimizedUpdate

Constructors

RichTextStringGroup(IApplication, Object)

Creates new instance of the group.

Declaration
public RichTextStringGroup(IApplication application, object parent)
Parameters
Type Name Description
IApplication application

Application object for the new group.
System.Object parent

Parent object for the new group.

Properties

Count

Returns number of elements in the group. Read-only.

Declaration
public int Count { get; }
Property Value
Type
System.Int32

IsFormatted

Indicates whether rich text string has formatting runs. Read-only.

Declaration
public bool IsFormatted { get; }
Property Value
Type
System.Boolean

Item[Int32]

Returns single RichTextString from the group. Read-only.

Declaration
public IRichTextString this[int index] { get; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type
IRichTextString

RtfText

Returns text in rtf format. Read-only.

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

Text

Gets / sets text of the string.

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

Methods

Append(String, IFont)

Appends rich text string with specified text and font.

Declaration
public void Append(string text, IFont font)
Parameters
Type Name Description
System.String text

Text to append.
IFont font

Font to use.

BeginUpdate()

Declaration
public void BeginUpdate()

Clear()

Clears text and formatting.

Declaration
public void Clear()

ClearFormatting()

Clears string formatting.

Declaration
public void ClearFormatting()

EndUpdate()

Declaration
public void EndUpdate()

GetFont(Int32)

Returns font which is applied to character at the specified position.

Declaration
public IFont GetFont(int iPosition)
Parameters
Type Name Description
System.Int32 iPosition

Character index.
Returns
Type Description
IFont

Font which is applied to character at the specified position.

SetFont(Int32, Int32, IFont)

Sets font for range of characters.

Declaration
public void SetFont(int iStartPos, int iEndPos, IFont font)
Parameters
Type Name Description
System.Int32 iStartPos

First character of the range.
System.Int32 iEndPos

Last character of the range.
IFont font

Font to set.

Implements

System.IDisposable