Class ChartBarRecord

This record defines a bar or column chart group.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
ChartBarRecord
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.ChartBar)]
public class ChartBarRecord : BiffRecordRaw, ICloneable, IBiffStorage, IChartType

Constructors

ChartBarRecord()

Default constructor, initializes all fields with default values.

Declaration
public ChartBarRecord()

ChartBarRecord(Int32)

Reserved for record's internal data array.

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

ChartBarRecord(Stream, out Int32)

Read / initialize constructor.

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

CategoriesSpace

Space between categories (percent of bar width), default = 50.

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

HasShadow

True if this bar has a shadow; otherwise False.

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

IsHorizontalBar

True for horizontal bars (bar chart). False for vertical bars (column chart).

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

Options

Holder of all flags.

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

Overlap

Space between bars.

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

ShowAsPercents

Each category is displayed as a percentage.

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

StackValues

Stack the displayed values.

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

Methods

GetStoreSize(ExcelVersion)

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Convert 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