alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Search Results for

    Show / Hide Table of Contents

    Class ChartTextRecord

    This record is used in conjunction with several child records (which further define the text displayed on the chart) to define the alignment, color, position, size, and so on of text fields that appear on the chart. The fields in this record have meaning according to the TEXT record's parent (CHART, LEGEND, or DEFAULTTEXT).

    Inheritance
    object
    BiffRecordRaw
    ChartTextRecord
    Implements
    ICloneable
    IBiffStorage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    [Biff(TBIFFRecord.ChartText)]
    [CLSCompliant(false)]
    public class ChartTextRecord : BiffRecordRaw, ICloneable, IBiffStorage

    Constructors

    ChartTextRecord()

    Default constructor, initializes all fields with default values.

    Declaration
    public ChartTextRecord()

    ChartTextRecord(Stream, out int)

    Read / initialize constructor.

    Declaration
    public ChartTextRecord(Stream stream, out int itemSize)
    Parameters
    Type Name Description
    Stream stream

    Stream from which record data should be read.

    int itemSize

    Size of read item.

    Exceptions
    Type Condition
    ArgumentNullException

    If stream is not specified.

    ApplicationException

    If stream does not support read or seek operations.

    ChartTextRecord(int)

    Reserved for record's internal data array.

    Declaration
    public ChartTextRecord(int iReserve)
    Parameters
    Type Name Description
    int iReserve

    Amount of bytes for data array.

    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    If amount of bytes requested is less than zero.

    Fields

    DEF_DATA_LABEL_FIRST_BIT

    First bit of the data label placement value.

    Declaration
    public const int DEF_DATA_LABEL_FIRST_BIT = 0
    Field Value
    Type
    int

    DEF_DATA_LABEL_MASK

    Mask for data label placement.

    Declaration
    public const int DEF_DATA_LABEL_MASK = 15
    Field Value
    Type
    int

    DEF_FIRST_ROTATION_BIT

    First bit of the rotation value.

    Declaration
    public const int DEF_FIRST_ROTATION_BIT = 8
    Field Value
    Type
    int

    DEF_RECORD_SIZE

    Correct size of the record.

    Declaration
    public const int DEF_RECORD_SIZE = 32
    Field Value
    Type
    int

    DEF_ROTATION_MASK

    Mask for the rotation value.

    Declaration
    public const int DEF_ROTATION_MASK = 1792
    Field Value
    Type
    int

    Properties

    BackgroundMode

    Display mode of the background.

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

    ColorIndex

    Index to color value of text.

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

    DataLabelPlacement

    Data label placement.

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

    HorzAlign

    Horizontal alignment of the text.

    Declaration
    public ExcelChartHorzAlignment HorzAlign { get; set; }
    Property Value
    Type
    ExcelChartHorzAlignment

    IsAutoColor

    True if automatic color; False if user-selected color.

    Declaration
    public bool IsAutoColor { get; set; }
    Property Value
    Type
    bool

    IsAutoMode

    True if background is set to automatic.

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

    IsAutoText

    True to use automatically generated text string; False to use user-created text string. Must be one for fShowValue to be meaningful.

    Declaration
    public bool IsAutoText { get; set; }
    Property Value
    Type
    bool

    IsDeleted

    True if an automatic text label has been deleted by the user.

    Declaration
    public bool IsDeleted { get; set; }
    Property Value
    Type
    bool

    IsGenerated

    True if default or unmodified; False if modified.

    Declaration
    public bool IsGenerated { get; set; }
    Property Value
    Type
    bool

    IsShowBubbleSizes

    True to show bubble sizes.

    Declaration
    public bool IsShowBubbleSizes { get; set; }
    Property Value
    Type
    bool

    IsShowKey

    If text is an attached data label: True to draw legend key with data label; False if no legend key.

    Declaration
    public bool IsShowKey { get; set; }
    Property Value
    Type
    bool

    IsShowLabel

    True to show label.

    Declaration
    public bool IsShowLabel { get; set; }
    Property Value
    Type
    bool

    IsShowLabelPercent

    True to show category label and value as a percentage (pie charts only).

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

    IsShowPercent

    True to show value as a percent. This bit applies only to pie charts.

    Declaration
    public bool IsShowPercent { get; set; }
    Property Value
    Type
    bool

    IsShowValue

    True if text of label is the value of the data point; False if text is the category label.

    Declaration
    public bool IsShowValue { get; set; }
    Property Value
    Type
    bool

    IsVertical

    True if text is not horizontal; False if text is horizontal.

    Declaration
    public bool IsVertical { get; set; }
    Property Value
    Type
    bool

    MaximumRecordSize

    Maximum possible size of the record.

    Declaration
    public override int MaximumRecordSize { get; }
    Property Value
    Type
    int
    Overrides
    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MaximumRecordSize

    MinimumRecordSize

    Minimum possible size of the record.

    Declaration
    public override int MinimumRecordSize { get; }
    Property Value
    Type
    int
    Overrides
    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

    Options

    Option flags. Read-only.

    Declaration
    public ushort Options { get; }
    Property Value
    Type
    ushort

    Options2

    Option flags. Read-only.

    Declaration
    public ushort Options2 { get; set; }
    Property Value
    Type
    ushort

    Rotation

    Rotation.

    Declaration
    public TRotation Rotation { get; set; }
    Property Value
    Type
    TRotation

    TextColor

    Text color.

    Declaration
    public uint TextColor { get; set; }
    Property Value
    Type
    uint

    TextRotation

    Text rotation.

    Declaration
    public short TextRotation { get; set; }
    Property Value
    Type
    short

    TextRotationOrNull

    Text rotation.

    Declaration
    public short? TextRotationOrNull { get; set; }
    Property Value
    Type
    short?

    VertAlign

    Vertical alignment of the text.

    Declaration
    public ExcelChartVertAlignment VertAlign { get; set; }
    Property Value
    Type
    ExcelChartVertAlignment

    XPos

    X-position of the text in 1/4000 of chart area.

    Declaration
    public uint XPos { get; set; }
    Property Value
    Type
    uint

    XSize

    X-size of the text in 1/4000 of chart area.

    Declaration
    public uint XSize { get; set; }
    Property Value
    Type
    uint

    YPos

    Y-position of the text in 1/4000 of chart area.

    Declaration
    public uint YPos { get; set; }
    Property Value
    Type
    uint

    YSize

    Y-size of the text in 1/4000 of chart area.

    Declaration
    public uint YSize { get; set; }
    Property Value
    Type
    uint

    Methods

    ParseStructure(DataProvider, int, int, ExcelVersion)

    Parse structure of record. Converts data buffer to special values according to record specification.

    Declaration
    public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)
    Parameters
    Type Name Description
    DataProvider provider

    Object that provides access to the data.

    int iOffset

    Offset to the record's data.

    int iLength

    Length of the record's data.

    ExcelVersion version

    Excel version used for infill.

    Overrides
    BiffRecordRaw.ParseStructure(DataProvider, int, int, ExcelVersion)

    Implements

    ICloneable
    IBiffStorage
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved