Class StyleRecord
Style Record: Describes a built-in style in the GUI or user defined style.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.Style)]
[CLSCompliant(false)]
public class StyleRecord : BiffRecordRaw, ICloneable, IBiffStorage, INamedObject
Constructors
StyleRecord()
Default constructor
Declaration
public StyleRecord()
StyleRecord(Int32)
Reserved for record's internal data array.
Declaration
public StyleRecord(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. |
StyleRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public StyleRecord(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
BuildInOrNameLen
The row or column level of the style.
Declaration
public byte BuildInOrNameLen { get; set; }
Property Value
Type |
---|
System.Byte |
ExtendedFormatIndex
The actual index of the style extended format record.
Declaration
public ushort ExtendedFormatIndex { get; set; }
Property Value
Type |
---|
System.UInt16 |
IsBuildInStyle
Whether the style is built in or user-defined.
Declaration
public bool IsBuildInStyle { get; set; }
Property Value
Type |
---|
System.Boolean |
IsBuiltIncustomized
Gets or sets if the style record is built-in customized
Declaration
public bool IsBuiltIncustomized { get; set; }
Property Value
Type |
---|
System.Boolean |
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
Name
Returns style name. Read-only.
Declaration
public string Name { get; }
Property Value
Type |
---|
System.String |
OutlineStyleLevel
The row or column level of the style.
Declaration
public byte OutlineStyleLevel { get; set; }
Property Value
Type |
---|
System.Byte |
StyleName
The style's name (if user-defined).
Declaration
public string StyleName { get; set; }
Property Value
Type |
---|
System.String |
Methods
CopyTo(BiffRecordRaw)
Copies this record into another StyleRecord.
Declaration
public override void CopyTo(BiffRecordRaw raw)
Parameters
Type | Name | Description |
---|---|---|
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | raw |
Overrides
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. |
Overrides
Exceptions
Type | Condition |
---|---|
WrongBiffRecordDataException | If there is any internal error. |