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
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class ChartTextRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
ChartTextRecord()
Default constructor, initializes all fields with default values.
Declaration
public ChartTextRecord()
ChartTextRecord(Int32)
Reserved for record's internal data array.
Declaration
public ChartTextRecord(int iReserve)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iReserve | Amount of bytes for data array. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | If amount of bytes requested is less than zero. |
ChartTextRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public ChartTextRecord(Stream stream, out int itemSize)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | Stream from which record data should be read. |
System.Int32 | itemSize | Size of read item. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | If stream is not specified. |
System.ApplicationException | If stream does not support read or seek operations. |
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 |
---|
System.Int32 |
DEF_DATA_LABEL_MASK
Mask for data label placement.
Declaration
public const int DEF_DATA_LABEL_MASK = 15
Field Value
Type |
---|
System.Int32 |
DEF_FIRST_ROTATION_BIT
First bit of the rotation value.
Declaration
public const int DEF_FIRST_ROTATION_BIT = 8
Field Value
Type |
---|
System.Int32 |
DEF_RECORD_SIZE
Correct size of the record.
Declaration
public const int DEF_RECORD_SIZE = 32
Field Value
Type |
---|
System.Int32 |
DEF_ROTATION_MASK
Mask for the rotation value.
Declaration
public const int DEF_ROTATION_MASK = 1792
Field Value
Type |
---|
System.Int32 |
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 |
---|
System.Boolean |
IsAutoMode
True if background is set to automatic.
Declaration
public bool IsAutoMode { get; set; }
Property Value
Type |
---|
System.Boolean |
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 |
---|
System.Boolean |
IsDeleted
True if an automatic text label has been deleted by the user.
Declaration
public bool IsDeleted { get; set; }
Property Value
Type |
---|
System.Boolean |
IsGenerated
True if default or unmodified; False if modified.
Declaration
public bool IsGenerated { get; set; }
Property Value
Type |
---|
System.Boolean |
IsShowBubbleSizes
True to show bubble sizes.
Declaration
public bool IsShowBubbleSizes { get; set; }
Property Value
Type |
---|
System.Boolean |
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 |
---|
System.Boolean |
IsShowLabel
True to show label.
Declaration
public bool IsShowLabel { get; set; }
Property Value
Type |
---|
System.Boolean |
IsShowLabelPercent
True to show category label and value as a percentage (pie charts only).
Declaration
public bool IsShowLabelPercent { get; set; }
Property Value
Type |
---|
System.Boolean |
IsShowPercent
True to show value as a percent. This bit applies only to pie charts.
Declaration
public bool IsShowPercent { get; set; }
Property Value
Type |
---|
System.Boolean |
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 |
---|
System.Boolean |
IsVertical
True if text is not horizontal; False if text is horizontal.
Declaration
public bool IsVertical { get; set; }
Property Value
Type |
---|
System.Boolean |
MaximumRecordSize
Maximum possible size of the record.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
MinimumRecordSize
Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
Options
Option flags. Read-only.
Declaration
public ushort Options { get; }
Property Value
Type |
---|
System.UInt16 |
Options2
Option flags. Read-only.
Declaration
public ushort Options2 { get; set; }
Property Value
Type |
---|
System.UInt16 |
Rotation
Rotation.
Declaration
public TRotation Rotation { get; set; }
Property Value
Type |
---|
TRotation |
TextColor
Text color.
Declaration
public uint TextColor { get; set; }
Property Value
Type |
---|
System.UInt32 |
TextRotation
Text rotation.
Declaration
public short TextRotation { get; set; }
Property Value
Type |
---|
System.Int16 |
TextRotationOrNull
Text rotation.
Declaration
public Nullable<short> TextRotationOrNull { get; set; }
Property Value
Type |
---|
System.Nullable<System.Int16> |
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 |
---|
System.UInt32 |
XSize
X-size of the text in 1/4000 of chart area.
Declaration
public uint XSize { get; set; }
Property Value
Type |
---|
System.UInt32 |
YPos
Y-position of the text in 1/4000 of chart area.
Declaration
public uint YPos { get; set; }
Property Value
Type |
---|
System.UInt32 |
YSize
Y-size of the text in 1/4000 of chart area.
Declaration
public uint YSize { get; set; }
Property Value
Type |
---|
System.UInt32 |
Methods
ParseStructure(DataProvider, Int32, Int32, 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. |
System.Int32 | iOffset | Offset to the record's data. |
System.Int32 | iLength | Length of the record's data. |
ExcelVersion | version | Excel version used for infill. |