Class ChartRichTextString
Represents rich text string in the workbook.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.NET.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. |
| 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. |
| object | parent | Parent object for the RichTextString. |
| TextWithFormat | text | Text to wrap. |
ChartRichTextString(IApplication, object, bool)
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. |
| object | parent | Parent object for the RichTextString. |
| bool | isReadOnly | Indicates whether string is read-only. |
ChartRichTextString(IApplication, object, bool, bool)
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. |
| object | parent | Parent object for the RichTextString. |
| bool | isReadOnly | Indicates whether string is read-only. |
| bool | bCreateText | Indicates whether to create inner TextWithFormat. |
Fields
m_book
Parent workbook.
Declaration
protected WorkbookImpl m_book
Field Value
| Type |
|---|
| WorkbookImpl |
Properties
Application
Returns parent application object. Read-only.
Declaration
public IApplication Application { get; }
Property Value
| Type |
|---|
| IApplication |
FormattingRuns
Gets the formatting runs of rich-text
Declaration
public ChartAlrunsRecord.TRuns[] FormattingRuns { get; }
Property Value
| Type |
|---|
| TRuns[] |
Parent
Returns parent object. Read-only.
Declaration
public object Parent { get; }
Property Value
| Type |
|---|
| object |
Text
Gets the text
Declaration
public string Text { get; }
Property Value
| Type |
|---|
| 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 |
|---|---|
| int | Font index in the collection. |
GetFont(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 |
|---|
| IFont |
SetFont(int, int, IFont)
Sets font for range of characters.
Declaration
public void SetFont(int iStartPos, int iEndPos, IFont font)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iStartPos | First character of the range. |
| int | iEndPos | Last character of the range. |
| IFont | font | Font to set. |
SetParents()
Searches for all necessary parent objects.
Declaration
protected virtual void SetParents()