Class ChartShtpropsRecord
This record specifies chart sheet properties.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
[Biff]
public class ChartShtpropsRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
ChartShtpropsRecord()
Default constructor, initializes all fields with default values.
Declaration
public ChartShtpropsRecord()
ChartShtpropsRecord(Int32)
Reserved for record's internal data array.
Declaration
public ChartShtpropsRecord(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. |
ChartShtpropsRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public ChartShtpropsRecord(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_MIN_RECORD_SIZE
Represents minimum record size.
Declaration
public const int DEF_MIN_RECORD_SIZE = 3
Field Value
Type |
---|
System.Int32 |
DEF_RECORD_SIZE
Correct size of the record.
Declaration
public const int DEF_RECORD_SIZE = 4
Field Value
Type |
---|
System.Int32 |
Properties
Flags
Property flags. Read-only.
Declaration
public ushort Flags { get; }
Property Value
Type |
---|
System.UInt16 |
IsAlwaysAutoPlotArea
True if user has modified chart enough that fManPlotArea should be set to 0.
Declaration
public bool IsAlwaysAutoPlotArea { get; set; }
Property Value
Type |
---|
System.Boolean |
IsManPlotArea
False to use default plot area dimensions; True if POS record describes plot-area dimensions.
Declaration
public bool IsManPlotArea { get; set; }
Property Value
Type |
---|
System.Boolean |
IsManSerAlloc
True if chart type has been manually formatted (changed from the default).
Declaration
public bool IsManSerAlloc { get; set; }
Property Value
Type |
---|
System.Boolean |
IsNotSizeWith
True not to size chart with window.
Declaration
public bool IsNotSizeWith { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPlotVisOnly
True to plot visible cells only.
Declaration
public bool IsPlotVisOnly { get; set; }
Property Value
Type |
---|
System.Boolean |
MaximumRecordSize
Maximum possible size of the record.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
MinimumRecordSize
Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
PlotBlank
Empty cells plotted as: 0 = not plotted 1 = zero 2 = interpolated
Declaration
public ExcelChartPlotEmpty PlotBlank { get; set; }
Property Value
Type |
---|
ExcelChartPlotEmpty |
Reserved
Reserved by Microsoft.
Declaration
public byte Reserved { get; set; }
Property Value
Type |
---|
System.Byte |
Methods
GetStoreSize(ExcelVersion)
Size of the required storage space. Read-only.
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. 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. |