Class ChartBoppopRecord

This record stores options for a bar of pie or pie of pie chart; these are two of the pie chart subtypes.

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

Constructors

ChartBoppopRecord()

Default constructor, initializes all fields with default values.

Declaration
public ChartBoppopRecord()

ChartBoppopRecord(Int32)

Reserved for record's internal data array.

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

ChartBoppopRecord(Stream, out Int32)

Read / initialize constructor.

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

Properties

ChartSplitType

Split type: 0 = Position 1 = Value 2 = Percent 3 = Custom

Declaration
public ExcelSplitType ChartSplitType { get; set; }
Property Value
Type
ExcelSplitType

Gap

Space between the first pie and the second.

Declaration
public ushort Gap { get; set; }
Property Value
Type
System.UInt16

HasShadow

1 = the second pie / bar has a shadow.

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

NumSplitValue

For split = 1, what values should go to the other pie / bar.

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

Pie2Size

Size of the second pie as a percentage of the first.

Declaration
public ushort Pie2Size { get; set; }
Property Value
Type
System.UInt16

PieChartType

0 = normal pie chart 1 = pie of pie chart 2 = bar of pie chart

Declaration
public ExcelPieType PieChartType { get; set; }
Property Value
Type
ExcelPieType

ShowLeaderLines

True to show leader lines to data labels.

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

SplitPercent

For split = 2, what percentage should go to the other pie / bar.

Declaration
public ushort SplitPercent { get; set; }
Property Value
Type
System.UInt16

SplitPosition

For split = 0, which positions should go to the other pie / bar.

Declaration
public ushort SplitPosition { get; set; }
Property Value
Type
System.UInt16

UseDefaultSplitValue

True to use default split value; otherwise False.

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

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)

Implements

System.ICloneable