Class RefreshAllRecord
Flag whether to refresh all external data when loading a sheet.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.RefreshAll)]
[CLSCompliant(false)]
public class RefreshAllRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
RefreshAllRecord()
Default constructor
Declaration
public RefreshAllRecord()
RefreshAllRecord(Int32)
Reserved for record's internal data array.
Declaration
public RefreshAllRecord(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. |
RefreshAllRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public RefreshAllRecord(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
IsRefreshAll
Flag whether to refresh all external data when loading a sheet.
Declaration
public ushort IsRefreshAll { get; set; }
Property Value
Type | Description |
---|---|
System.UInt16 |
MaximumRecordSize
Read-only. Returns maximum possible size of record's internal data array.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type | Description |
---|---|
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 | Description |
---|---|
System.Int32 |
Overrides
Methods
GetStoreSize(ExcelVersion)
Size of the required storage space.
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
ExcelVersion | version |
Returns
Type | Description |
---|---|
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. |