Class ChartFrameRecord
The FRAME record defines the border that is present around a displayed label as a rectangle. A displayed label can include the chart title, the legend (if not a regular rectangle), a category name, or a value amount.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class ChartFrameRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
ChartFrameRecord()
Default constructor, initializes all fields with default values.
Declaration
public ChartFrameRecord()
ChartFrameRecord(Int32)
Reserved for record's internal data array.
Declaration
public ChartFrameRecord(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. |
ChartFrameRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public ChartFrameRecord(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
Correct size of the record.
Declaration
public const int DEF_RECORD_SIZE = 4
Field Value
Type |
---|
System.Int32 |
Properties
AutoPosition
Microsoft Excel calculates position.
Declaration
public bool AutoPosition { get; set; }
Property Value
Type |
---|
System.Boolean |
AutoSize
Microsoft Excel calculates size.
Declaration
public bool AutoSize { get; set; }
Property Value
Type |
---|
System.Boolean |
MaximumRecordSize
Read-only. Returns maximum possible size of record's internal data array.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
MinimumRecordSize
Read-only. Returns minimum possible size of record's internal data array.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
Options
Record flags holder.
Declaration
public ushort Options { get; }
Property Value
Type |
---|
System.UInt16 |
Rectangle
0 = regular rectangle/no border 1�3 (reserved) 4 = rectangle with shadow
Declaration
public ExcelRectangleStyle Rectangle { get; set; }
Property Value
Type |
---|
ExcelRectangleStyle |
Methods
GetStoreSize(ExcelVersion)
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
ExcelVersion | version |
Returns
Type |
---|
System.Int32 |
Overrides
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. |