alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Search Results for

    Show / Hide Table of Contents

    Class NoteRecord

    The NOTE record specifies a comment associated with a particular cell.

    Inheritance
    object
    BiffRecordRaw
    NoteRecord
    Implements
    ICloneable
    IBiffStorage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Parser.Biff_Records
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    [Biff(TBIFFRecord.Note)]
    [CLSCompliant(false)]
    public class NoteRecord : BiffRecordRaw, ICloneable, IBiffStorage

    Constructors

    NoteRecord()

    Default constructor fills all data with default values.

    Declaration
    public NoteRecord()

    NoteRecord(Stream, out int)

    Read / initialize constructor.

    Declaration
    public NoteRecord(Stream stream, out int itemSize)
    Parameters
    Type Name Description
    Stream stream

    Stream from which record data should be read.

    int itemSize

    Size of read item.

    Exceptions
    Type Condition
    ArgumentNullException

    If stream is not specified.

    ApplicationException

    If stream does not support read or seek operations.

    NoteRecord(int)

    Reserved for record's internal data array.

    Declaration
    public NoteRecord(int iReserve)
    Parameters
    Type Name Description
    int iReserve

    Amount of bytes for data array.

    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    If amount of bytes requested is less than zero.

    Properties

    AuthorName

    Name of the original comment author.

    Declaration
    public string AuthorName { get; set; }
    Property Value
    Type
    string

    Column

    Index to column.

    Declaration
    public ushort Column { get; set; }
    Property Value
    Type
    ushort

    IsVisible

    Indicates whether the comment is visible. Changes one bit in m_usOptions field.

    Declaration
    public bool IsVisible { get; set; }
    Property Value
    Type
    bool

    MinimumRecordSize

    Read-only. Returns minimum possible size of record's internal data array.

    Declaration
    public override int MinimumRecordSize { get; }
    Property Value
    Type
    int
    Overrides
    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

    ObjId

    Object ID for OBJ record that contains the comment.

    Declaration
    public ushort ObjId { get; set; }
    Property Value
    Type
    ushort

    Reserved

    Read-only. Reserved.

    Declaration
    public ushort Reserved { get; }
    Property Value
    Type
    ushort

    Row

    Index to row.

    Declaration
    public ushort Row { get; set; }
    Property Value
    Type
    ushort

    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
    int
    Overrides
    BiffRecordRaw.GetStoreSize(ExcelVersion)

    ParseStructure(DataProvider, int, int, 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.

    int iOffset

    Offset to the record's data.

    int iLength

    Length of the record's data.

    ExcelVersion version

    Excel version used for infill.

    Overrides
    BiffRecordRaw.ParseStructure(DataProvider, int, int, ExcelVersion)

    Implements

    ICloneable
    IBiffStorage
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved