Class ChartDataLabelsRecord

Summary description for ChartDataLabelsRecord.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
ChartDataLabelsRecord
Implements
System.ICloneable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.ChartDataLabels)]
[CLSCompliant(false)]
public class ChartDataLabelsRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

ChartDataLabelsRecord()

Default constructor, initializes all fields with default values.

Declaration
public ChartDataLabelsRecord()

ChartDataLabelsRecord(Int32)

Reserved for record's internal data array.

Declaration
public ChartDataLabelsRecord(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.

ChartDataLabelsRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public ChartDataLabelsRecord(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

Declaration
public const int DEF_RECORD_SIZE = 12
Field Value
Type Description
System.Int32

Properties

Delimiter

Delimiter.

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

DelimiterLength

Length of the delimiter.

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

IsBubbleSize

Indicates whether bubble size is in data labels.

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

IsCategoryName

Indicates whether category name is in data labels.

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

IsPercentage

Indicates whether percentage is in data labels.

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

IsSeriesName

Indicates whether series name is in data labels.

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

IsValue

Indicates whether value is in data labels.

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

Options

Option flags. Read-only.

Declaration
public byte Options { get; }
Property Value
Type Description
System.Byte

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
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

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.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Operators

Equality(ChartDataLabelsRecord, ChartDataLabelsRecord)

Operator to check if the records are equal

Declaration
public static bool operator ==(ChartDataLabelsRecord record1, ChartDataLabelsRecord record2)
Parameters
Type Name Description
ChartDataLabelsRecord record1
ChartDataLabelsRecord record2
Returns
Type Description
System.Boolean

Inequality(ChartDataLabelsRecord, ChartDataLabelsRecord)

Checks and returns if the records are not equal

Declaration
public static bool operator !=(ChartDataLabelsRecord record1, ChartDataLabelsRecord record2)
Parameters
Type Name Description
ChartDataLabelsRecord record1
ChartDataLabelsRecord record2
Returns
Type Description
System.Boolean

Implements

System.ICloneable