Class WindowOneRecord
Stores the attributes of the workbook window. This is basically so that the GUI is aware of the size of the window holding the spreadsheet document.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class WindowOneRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
WindowOneRecord()
Default constructor
Declaration
public WindowOneRecord()
WindowOneRecord(Int32)
Reserved for record's internal data array.
Declaration
public WindowOneRecord(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. |
WindowOneRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public WindowOneRecord(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
DisplayedTab
The displayed tab number.
Declaration
public ushort DisplayedTab { get; set; }
Property Value
Type |
---|
System.UInt16 |
Height
The height of the window.
Declaration
public ushort Height { get; set; }
Property Value
Type |
---|
System.UInt16 |
HHold
Horizontal position of the window.
Declaration
public ushort HHold { get; set; }
Property Value
Type |
---|
System.UInt16 |
IsHidden
Indicates whether window is hidden.
Declaration
public bool IsHidden { get; set; }
Property Value
Type |
---|
System.Boolean |
IsHScroll
Indicates whether to display horizontal scrollbar.
Declaration
public bool IsHScroll { get; set; }
Property Value
Type |
---|
System.Boolean |
IsIconic
Indicates whether window is icon.
Declaration
public bool IsIconic { get; set; }
Property Value
Type |
---|
System.Boolean |
IsTabs
Display tabs at the bottom.
Declaration
public bool IsTabs { get; set; }
Property Value
Type |
---|
System.Boolean |
IsVScroll
Indicates whether to display vertical scrollbar.
Declaration
public bool IsVScroll { 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
NumSelectedTabs
The number of selected tabs.
Declaration
public ushort NumSelectedTabs { get; set; }
Property Value
Type |
---|
System.UInt16 |
Options
Read-only. Options flag.
Declaration
public ushort Options { get; }
Property Value
Type |
---|
System.UInt16 |
Reserved
Property value reserved by Microsoft for own values.
Declaration
public bool Reserved { get; set; }
Property Value
Type |
---|
System.Boolean |
SelectedTab
The selected tab number.
Declaration
public ushort SelectedTab { get; set; }
Property Value
Type |
---|
System.UInt16 |
TabWidthRatio
Ratio of the width of the tabs to the horizontal scrollbar.
Declaration
public ushort TabWidthRatio { get; set; }
Property Value
Type |
---|
System.UInt16 |
VHold
Vertical position of the window.
Declaration
public ushort VHold { get; set; }
Property Value
Type |
---|
System.UInt16 |
Width
The width of the window.
Declaration
public ushort Width { get; set; }
Property Value
Type |
---|
System.UInt16 |
Methods
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. |