Class ChartSeriesTextRecord
The value of the ID field determines the assignment of the text field.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.ChartSeriesText)]
[CLSCompliant(false)]
public class ChartSeriesTextRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
ChartSeriesTextRecord()
Default constructor, initializes all fields with default values.
Declaration
public ChartSeriesTextRecord()
ChartSeriesTextRecord(Int32)
Reserved for record's internal data array.
Declaration
public ChartSeriesTextRecord(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. |
ChartSeriesTextRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public ChartSeriesTextRecord(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_RECORD_SIZE
Minimum size of the record.
Declaration
public const int DEF_RECORD_SIZE = 3
Field Value
Type | Description |
---|---|
System.Int32 |
Properties
MinimumRecordSize
Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Overrides
Text
The series text string.
Declaration
public string Text { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TextId
Text identifier: 0 = series name or text.
Declaration
public ushort TextId { get; set; }
Property Value
Type | Description |
---|---|
System.UInt16 |
Methods
GetStoreSize(ExcelVersion)
Evaluates size of the required storage space.
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
ExcelVersion | version |
Returns
Type | Description |
---|---|
System.Int32 | Size of the required storage space. |
Overrides
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. |