Class NoteRecord
The NOTE record specifies a comment associated with a particular cell.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff]
public class NoteRecord : BiffRecordRaw, ICloneable, IBiffStorageConstructors
NoteRecord()
Default constructor fills all data with default values.
Declaration
public NoteRecord()NoteRecord(Int32)
Reserved for record's internal data array.
Declaration
public NoteRecord(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. |
NoteRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public NoteRecord(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
AuthorName
Name of the original comment author.
Declaration
public string AuthorName { get; set; }Property Value
| Type |
|---|
| System.String |
Column
Index to column.
Declaration
public ushort Column { get; set; }Property Value
| Type |
|---|
| System.UInt16 |
IsVisible
Indicates whether the comment is visible. Changes one bit in m_usOptions field.
Declaration
public bool IsVisible { 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
ObjId
Object ID for OBJ record that contains the comment.
Declaration
public ushort ObjId { get; set; }Property Value
| Type |
|---|
| System.UInt16 |
Reserved
Read-only. Reserved.
Declaration
public ushort Reserved { get; }Property Value
| Type |
|---|
| System.UInt16 |
Row
Index to row.
Declaration
public ushort Row { get; set; }Property Value
| Type |
|---|
| System.UInt16 |
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. |