menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartTextAreaImpl - Xamarin.Forms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ChartTextAreaImpl

    Represents text area in the chart.

    Inheritance
    System.Object
    CommonObject
    ChartTextAreaImpl
    ChartWrappedTextAreaImpl
    Implements
    System.IDisposable
    IChartDataLabels
    ISerializable
    IChartTextArea
    IFont
    IParentApplication
    IOptimizedUpdate
    Inherited Members
    CommonObject.AddReference()
    CommonObject.AppImplementation
    CommonObject.Application
    CommonObject.CheckDisposed()
    CommonObject.Dispose()
    CommonObject.Finalize()
    CommonObject.FindParent(Object, Type)
    CommonObject.FindParent(Object, Type, Boolean)
    CommonObject.FindParent(Type)
    CommonObject.FindParent(Type, Boolean)
    CommonObject.FindParent(Type[])
    CommonObject.FindParents(Type[])
    CommonObject.m_bIsDisposed
    CommonObject.OnDispose()
    CommonObject.Parent
    CommonObject.ReferenceCount
    CommonObject.ReleaseReference()
    CommonObject.SetParent(Object)
    Namespace: Syncfusion.XlsIO.Implementation.Charts
    Assembly: Syncfusion.XlsIO.Portable.dll
    Syntax
    public class ChartTextAreaImpl : CommonObject, IDisposable, IChartDataLabels, ISerializable, IInternalChartTextArea, IChartTextArea, IInternalFont, IFont, IParentApplication, IOptimizedUpdate

    Constructors

    ChartTextAreaImpl(IApplication, Object)

    Creates objects sets its Application and Parent properties to specified values.

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

    Application object.

    System.Object parent

    Parent object.

    ChartTextAreaImpl(IApplication, Object, ExcelObjectTextLink)

    Creates objects sets its Application and Parent properties to specified values.

    Declaration
    public ChartTextAreaImpl(IApplication application, object parent, ExcelObjectTextLink textLink)
    Parameters
    Type Name Description
    IApplication application

    Application object.

    System.Object parent

    Parent object.

    ExcelObjectTextLink textLink

    Text link.

    ChartTextAreaImpl(IApplication, Object, IList<BiffRecordRaw>, ref Int32)

    Creates objects sets its Application and Parent properties to specified values and parses object data.

    Declaration
    public ChartTextAreaImpl(IApplication application, object parent, IList<BiffRecordRaw> data, ref int iPos)
    Parameters
    Type Name Description
    IApplication application

    Application object.

    System.Object parent

    Parent object.

    System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

    Array with object's records.

    System.Int32 iPos

    Position of the first object's record in the data array.

    Fields

    m_rtfString

    Represents RTF string.

    Declaration
    protected IChartRichTextString m_rtfString
    Field Value
    Type
    IChartRichTextString

    Properties

    AttachedLabelLayout

    Return attached label layout record. Read-only

    Declaration
    public ChartAttachedLabelLayoutRecord AttachedLabelLayout { get; }
    Property Value
    Type
    ChartAttachedLabelLayoutRecord

    BackgroundMode

    Display mode of the background.

    Declaration
    public ExcelChartBackgroundMode BackgroundMode { get; set; }
    Property Value
    Type
    ExcelChartBackgroundMode

    Bold

    True if the font is bold. Read / write Boolean.

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

    ChartAI

    Returns ChartAIRecord for the text area (creates it if necessary). Read-only.

    Declaration
    public ChartAIRecord ChartAI { get; }
    Property Value
    Type
    ChartAIRecord

    ChartAlRuns

    Return ChartAlRunsRecord for the text area (creates if necessary). Read-only.

    Declaration
    public ChartAlrunsRecord ChartAlRuns { get; }
    Property Value
    Type
    ChartAlrunsRecord

    Color

    Returns or sets the primary color of the object. Read / write ExcelKnownColors.

    Declaration
    public ExcelKnownColors Color { get; set; }
    Property Value
    Type
    ExcelKnownColors

    ColorObject

    Returns textarea's color object. Read-only.

    Declaration
    public ColorObject ColorObject { get; }
    Property Value
    Type
    ColorObject

    ContainDataLabels

    Returns true if contain dataLabels otherwise false. Read-only.

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

    Delimiter

    Delimiter.

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

    Font

    Returns FontImpl for current font. Read-only.

    Declaration
    public FontImpl Font { get; }
    Property Value
    Type
    FontImpl

    FontIndex

    Gets the font index.

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

    FontName

    Returns or sets the font name. Read / write string.

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

    FrameFormat

    Return frame format. Read-only.

    Declaration
    public IChartFrameFormat FrameFormat { get; }
    Property Value
    Type
    IChartFrameFormat

    HasText

    Indicates whether text area contains text.

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

    HasTextRotation

    Gets value indicating whether TextRotation was changed. Read-only.

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

    Index

    Returns font index. Read-only.

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

    IsAutoColor

    Indicates whether color has automatic color. Read-only.

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

    IsAutoMode

    True if background is set to automatic.

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

    IsBubbleSize

    Indicates whether bubble size is in data labels.

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

    IsCategoryName

    Indicates whether category name is in data labels.

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

    IsFormula

    Gets or sets a value indicating whether this instance is formula.

    Declaration
    public bool IsFormula { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is formula; otherwise, false.

    IsLegendKey

    Indicates whether legend key is in data labels.

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

    IsPercentage

    Indicates whether percentage is in data labels.

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

    IsSeriesName

    Indicates whether series name is in data labels.

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

    IsShowLabelPercent

    Gets or sets value indicating whether to show category label and value as percentage.

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

    IsTrend

    Indicates if current text assign to trend object.

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

    IsValue

    Indicates whether value is in data labels.

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

    IsValueFromCells

    Gets and sets boolean value indicating whether display to value from cells value to datalabels.

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

    Italic

    True if the font style is italic. Read / write Boolean.

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

    Layout

    Gets or sets Excel 2007 layout data

    Declaration
    public IChartLayout Layout { get; set; }
    Property Value
    Type
    IChartLayout

    MacOSOutlineFont

    True if the font is an outline font. Read / write Boolean.

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

    MacOSShadow

    True if the font is a shadow font or if the object has a shadow. Read / write Boolean.

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

    NumberFormat

    Gets / sets number format for the text area.

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

    NumberFormatIndex

    Gets index to the number format. Read-only.

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

    ObjectLink

    Gets object link record. Read-only.

    Declaration
    public ChartObjectLinkRecord ObjectLink { get; }
    Property Value
    Type
    ChartObjectLinkRecord

    ParagraphType

    Represents the TextArea Paragraph

    Declaration
    public ChartParagraphType ParagraphType { get; set; }
    Property Value
    Type
    ChartParagraphType

    ParentWorkbook

    Returns parent workbook object.

    Declaration
    public WorkbookImpl ParentWorkbook { get; }
    Property Value
    Type
    WorkbookImpl

    Position

    Represents data labels position.

    Declaration
    public ExcelDataLabelPosition Position { get; set; }
    Property Value
    Type
    ExcelDataLabelPosition

    RGBColor

    Gets / sets font color. If there is at least one free color, define a new color; if not, search for the closest one in workbook palette.

    Declaration
    public Color RGBColor { get; set; }
    Property Value
    Type
    Color

    RichText

    Gets rich text.

    Declaration
    public IChartRichTextString RichText { get; }
    Property Value
    Type
    IChartRichTextString

    ShouldSerialize

    Indicates whether object should be serialized. Read-only.

    Declaration
    protected virtual bool ShouldSerialize { get; }
    Property Value
    Type
    System.Boolean

    ShowLeaderLines

    Indicates whether Leader Lines is in data labels.

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

    Size

    Returns or sets the size of the font. Read / write Variant.

    Declaration
    public double Size { get; set; }
    Property Value
    Type
    System.Double

    Strikethrough

    True if the font is struck through with a horizontal line. Read / write Boolean

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

    Subscript

    True if the font is formatted as subscript. False by default. Read / write Boolean.

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

    Superscript

    True if the font is formatted as superscript. False by default. Read/write Boolean

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

    Text

    Text.

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

    TextRecord

    Returns chart text record. Read-only.

    Declaration
    public ChartTextRecord TextRecord { get; }
    Property Value
    Type
    ChartTextRecord

    TextRotationAngle

    Text rotation angle.

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

    Underline

    Returns or sets the type of underline applied to the font. Can be one of the following ExcelUnderlineStyle constants. Read / write ExcelUnderline.

    Declaration
    public ExcelUnderline Underline { get; set; }
    Property Value
    Type
    ExcelUnderline

    ValueFromCellsRange

    Gets and sets indicating whether value from cells range in datalables.

    Declaration
    public IRange ValueFromCellsRange { get; set; }
    Property Value
    Type
    IRange

    VerticalAlignment

    Gets / sets font vertical alignment.

    Declaration
    public ExcelFontVertialAlignment VerticalAlignment { get; set; }
    Property Value
    Type
    ExcelFontVertialAlignment

    Methods

    BeginUpdate()

    This method should be called before several updates to the object will take place.

    Declaration
    public void BeginUpdate()

    Clone(Object)

    Creates object that is copy of the current instance.

    Declaration
    public object Clone(object parent)
    Parameters
    Type Name Description
    System.Object parent

    Parent object for create new instance.

    Returns
    Type Description
    System.Object

    Returns clone of current object.

    Clone(Object, Dictionary<Int32, Int32>, Dictionary<String, String>)

    Clone current record.

    Declaration
    public object Clone(object parent, Dictionary<int, int> dicFontIndexes, Dictionary<string, string> dicNewSheetNames)
    Parameters
    Type Name Description
    System.Object parent

    Parent object for create new instance.

    System.Collections.Generic.Dictionary<System.Int32, System.Int32> dicFontIndexes

    Dictionary with new font indexes.

    System.Collections.Generic.Dictionary<System.String, System.String> dicNewSheetNames

    Dictionary with new worksheet names.

    Returns
    Type Description
    System.Object

    Returns clone of current object.

    CreateFrameFormat()

    Creates frame format.

    Declaration
    protected virtual ChartFrameFormatImpl CreateFrameFormat()
    Returns
    Type Description
    ChartFrameFormatImpl

    Newly created frame format.

    CreateRichTextString()

    Creates rich text string.

    Declaration
    protected void CreateRichTextString()

    EndUpdate()

    This method should be called after several updates to the object took place.

    Declaration
    public void EndUpdate()

    GenerateNativeFont()

    Generates .Net font object corresponding to the current font.

    Declaration
    public Font GenerateNativeFont()
    Returns
    Type Description
    Font

    Generated .Net font.

    InitFrameFormat()

    Initializes frame format.

    Declaration
    protected void InitFrameFormat()

    MarkUsedReferences(Boolean[])

    Sets items with used reference indexes to true.

    Declaration
    public void MarkUsedReferences(bool[] usedItems)
    Parameters
    Type Name Description
    System.Boolean[] usedItems

    Array to mark used references in.

    Parse(IList<BiffRecordRaw>, Int32)

    Parses chart text area.

    Declaration
    public int Parse(IList<BiffRecordRaw> data, int iPos)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

    BiffRecords array to parse.

    System.Int32 iPos

    Starting data position.

    Returns
    Type Description
    System.Int32

    Position after parsing.

    ParseRecord(BiffRecordRaw, IList<BiffRecordRaw>, Int32)

    Parses single record.

    Declaration
    protected int ParseRecord(BiffRecordRaw record, IList<BiffRecordRaw> data, int iPos)
    Parameters
    Type Name Description
    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw record

    Record to parse.

    System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> data

    Data array with records to parse (used for complex object parsing).

    System.Int32 iPos

    Position in data array after current record.

    Returns
    Type Description
    System.Int32

    Position after record parsing.

    Serialize(IList<IBiffStorage>)

    Saves chart text area into OffsetArrayList.

    Declaration
    public virtual void Serialize(IList<IBiffStorage> records)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<IBiffStorage> records

    OffsetArrayList that will receive all chart's records.

    Exceptions
    Type Condition
    System.ArgumentNullException

    When specified OffsetArrayList is NULL.

    Serialize(IList<IBiffStorage>, Boolean)

    Saves chart text area into OffsetArrayList.

    Declaration
    public void Serialize(IList<IBiffStorage> records, bool bIsLegendEntry)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<IBiffStorage> records

    OffsetArrayList that will receive all chart's records.

    System.Boolean bIsLegendEntry

    If true - serialize as legend entry text; otherwise false.

    Exceptions
    Type Condition
    System.ArgumentNullException

    When specified OffsetArrayList is NULL.

    Serialize(IList<IBiffStorage>, Boolean, Boolean)

    Saves chart text area into OffsetArrayList.

    Declaration
    public void Serialize(IList<IBiffStorage> records, bool bIsLegendEntry, bool bSerializeFontX)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<IBiffStorage> records
    System.Boolean bIsLegendEntry
    System.Boolean bSerializeFontX

    SerializeRecord(IList<IBiffStorage>, BiffRecordRaw)

    Saves single record into list of biff records.

    Declaration
    protected virtual void SerializeRecord(IList<IBiffStorage> records, BiffRecordRaw record)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<IBiffStorage> records

    OffsetArrayList that will receive necessary records.

    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw record

    Record to serialize.

    UnwrapRecord(BiffRecordRaw)

    Unwraps specified record.

    Declaration
    public static BiffRecordRaw UnwrapRecord(BiffRecordRaw record)
    Parameters
    Type Name Description
    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw record

    Record to unwrap.

    Returns
    Type Description
    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw

    Unwrapped record.

    UpdateAsTrend()

    Updates record for serialize as trend line data label.

    Declaration
    public void UpdateAsTrend()

    UpdateReferenceIndexes(Int32[])

    Updates reference indexes.

    Declaration
    public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)
    Parameters
    Type Name Description
    System.Int32[] arrUpdatedIndexes

    Array with updated indexes.

    UpdateSerieIndex(Int32)

    Updates Series index.

    Declaration
    public void UpdateSerieIndex(int iNewIndex)
    Parameters
    Type Name Description
    System.Int32 iNewIndex

    Index to set.

    Implements

    System.IDisposable
    IChartDataLabels
    ISerializable
    IChartTextArea
    IFont
    IParentApplication
    IOptimizedUpdate
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved