Class ChartRichTextString

Represents rich text string in the workbook.

Inheritance
System.Object
CommonWrapper
ChartRichTextString
Inherited Members
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.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class ChartRichTextString : CommonWrapper, ICloneParent, IChartRichTextString, IParentApplication, IOptimizedUpdate

Constructors

ChartRichTextString(IApplication, Object)

Initializes new instance of the RichTextString.

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

Application object for the RichTextString.
System.Object parent

Parent object for the RichTextString.

ChartRichTextString(IApplication, Object, TextWithFormat)

Initializes new instance of the RichTextString.

Declaration
public ChartRichTextString(IApplication application, object parent, TextWithFormat text)
Parameters
Type Name Description
IApplication application

Application object for the RichTextString.
System.Object parent

Parent object for the RichTextString.
TextWithFormat text

Text to wrap.

ChartRichTextString(IApplication, Object, Boolean)

Initializes new instance of the RichTextString.

Declaration
public ChartRichTextString(IApplication application, object parent, bool isReadOnly)
Parameters
Type Name Description
IApplication application

Application object for the RichTextString.
System.Object parent

Parent object for the RichTextString.
System.Boolean isReadOnly

Indicates whether string is read-only.

ChartRichTextString(IApplication, Object, Boolean, Boolean)

Initializes new instance of the RichTextString.

Declaration
public ChartRichTextString(IApplication application, object parent, bool isReadOnly, bool bCreateText)
Parameters
Type Name Description
IApplication application

Application object for the RichTextString.
System.Object parent

Parent object for the RichTextString.
System.Boolean isReadOnly

Indicates whether string is read-only.
System.Boolean bCreateText

Indicates whether to create inner TextWithFormat.

Fields

m_book

Parent workbook.

Declaration
protected WorkbookImpl m_book
Field Value
Type Description
WorkbookImpl

Properties

Application

Returns parent application object. Read-only.

Declaration
public IApplication Application { get; }
Property Value
Type Description
IApplication

FormattingRuns

Gets the formatting runs of rich-text

Declaration
public ChartAlrunsRecord.TRuns[] FormattingRuns { get; }
Property Value
Type Description
ChartAlrunsRecord.TRuns[]

Parent

Returns parent object. Read-only.

Declaration
public object Parent { get; }
Property Value
Type Description
System.Object

Text

Gets the text

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

Methods

AddFont(IFont)

Adds font to all required collections..

Declaration
protected virtual int AddFont(IFont font)
Parameters
Type Name Description
IFont font

Font to add.
Returns
Type Description
System.Int32

Font index in the collection.

GetFont(ChartAlrunsRecord.TRuns)

Gets font for the specified formatting run.

Declaration
public IFont GetFont(ChartAlrunsRecord.TRuns tRuns)
Parameters
Type Name Description
ChartAlrunsRecord.TRuns tRuns

Formatting run to return its font
Returns
Type Description
IFont

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.

SetParents()

Searches for all necessary parent objects.

Declaration
protected virtual void SetParents()

Implements