alexa
menu

MAUI

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

    Show / Hide Table of Contents

    Class CommentsCollection

    Collection stores all comments in the worksheet.

    Inheritance
    object
    CollectionBase<CommentShapeImpl>
    CollectionBaseEx<CommentShapeImpl>
    CommentsCollection
    Implements
    IList<CommentShapeImpl>
    ICollection<CommentShapeImpl>
    IEnumerable<CommentShapeImpl>
    IParentApplication
    ICloneParent
    IComments
    IEnumerable
    Inherited Members
    CollectionBase<CommentShapeImpl>.Add(CommentShapeImpl)
    CollectionBase<CommentShapeImpl>.Capacity
    CollectionBase<CommentShapeImpl>.Contains(CommentShapeImpl)
    CollectionBase<CommentShapeImpl>.CopyTo(CommentShapeImpl[], int)
    CollectionBase<CommentShapeImpl>.GetEnumerator()
    CollectionBase<CommentShapeImpl>.IndexOf(CommentShapeImpl)
    CollectionBase<CommentShapeImpl>.InnerList
    CollectionBase<CommentShapeImpl>.Insert(int, CommentShapeImpl)
    CollectionBase<CommentShapeImpl>.IsReadOnly
    CollectionBase<CommentShapeImpl>.List
    CollectionBase<CommentShapeImpl>.Remove(CommentShapeImpl)
    CollectionBase<CommentShapeImpl>.RemoveAt(int)
    CollectionBaseEx<CommentShapeImpl>.AppImplementation
    CollectionBaseEx<CommentShapeImpl>.Application
    CollectionBaseEx<CommentShapeImpl>.Changed
    CollectionBaseEx<CommentShapeImpl>.ChangeName(IDictionary, ValueChangedEventArgs)
    CollectionBaseEx<CommentShapeImpl>.Cleared
    CollectionBaseEx<CommentShapeImpl>.Clearing
    CollectionBaseEx<CommentShapeImpl>.ClearMaxValues()
    CollectionBaseEx<CommentShapeImpl>.Clone(object)
    CollectionBaseEx<CommentShapeImpl>.EnsureCapacity(int)
    CollectionBaseEx<CommentShapeImpl>.FindParent(Type)
    CollectionBaseEx<CommentShapeImpl>.FindParent(Type, bool)
    CollectionBaseEx<CommentShapeImpl>.GenerateDefaultName(ICollection<CommentShapeImpl>, string)
    CollectionBaseEx<CommentShapeImpl>.GenerateDefaultName(ICollection, string)
    CollectionBaseEx<CommentShapeImpl>.GenerateDefaultName(string, params ICollection[])
    CollectionBaseEx<CommentShapeImpl>.Inserted
    CollectionBaseEx<CommentShapeImpl>.Inserting
    CollectionBaseEx<CommentShapeImpl>.OnInsert(int, CommentShapeImpl)
    CollectionBaseEx<CommentShapeImpl>.OnRemove(int, CommentShapeImpl)
    CollectionBaseEx<CommentShapeImpl>.OnSet(int, CommentShapeImpl, CommentShapeImpl)
    CollectionBaseEx<CommentShapeImpl>.Parent
    CollectionBaseEx<CommentShapeImpl>.QuietMode
    CollectionBaseEx<CommentShapeImpl>.Removed
    CollectionBaseEx<CommentShapeImpl>.Removing
    CollectionBaseEx<CommentShapeImpl>.Set
    CollectionBaseEx<CommentShapeImpl>.SetParent(object)
    CollectionBaseEx<CommentShapeImpl>.Setting
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Implementation.Collections
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    public class CommentsCollection : CollectionBaseEx<CommentShapeImpl>, IList<CommentShapeImpl>, ICollection<CommentShapeImpl>, IEnumerable<CommentShapeImpl>, IParentApplication, ICloneParent, IComments, IEnumerable

    Constructors

    CommentsCollection(IApplication, object)

    Creates new instance of the collection and sets its parent and application properties.

    Declaration
    public CommentsCollection(IApplication application, object parent)
    Parameters
    Type Name Description
    IApplication application

    Application object for the collection.

    object parent

    Parent object for the collection.

    Properties

    Count

    Returns the number of comments in the collection

    Declaration
    public int Count { get; }
    Property Value
    Type
    int

    this[int]

    Returns single entry from the collection. Read-only.

    Declaration
    public ICommentShape this[int index] { get; }
    Parameters
    Type Name Description
    int index
    Property Value
    Type
    ICommentShape

    this[int, int]

    Returns single entry from the collection by row and column one-based indexes. Read-only.

    Declaration
    public ICommentShape this[int iRow, int iColumn] { get; }
    Parameters
    Type Name Description
    int iRow
    int iColumn
    Property Value
    Type
    ICommentShape

    this[string]

    Gets single item from the collection.

    Declaration
    public ICommentShape this[string name] { get; }
    Parameters
    Type Name Description
    string name

    Name of the item to get.

    Property Value
    Type Description
    ICommentShape

    Single item from the collection.

    ReRegisterOnAccess

    This property indicates whether internal hashtable is invalid and must be filled once again before accessing.

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

    Methods

    AddComment(IRange)

    Adds comment to the specified range.

    Declaration
    public ICommentShape AddComment(IRange parentRange)
    Parameters
    Type Name Description
    IRange parentRange

    Range that should be commented.

    Returns
    Type Description
    ICommentShape

    Newly created comment shape.

    AddComment(int, int)

    Adds comment to the specified range.

    Declaration
    public ICommentShape AddComment(int iRow, int iColumn)
    Parameters
    Type Name Description
    int iRow

    Row of the cell to add comment to.

    int iColumn

    Column of the cell to add comment to.

    Returns
    Type Description
    ICommentShape

    Newly created comment shape.

    AddComment(int, int, bool)

    Adds comment to the specified range.

    Declaration
    public ICommentShape AddComment(int iRow, int iColumn, bool bIsParseOptions)
    Parameters
    Type Name Description
    int iRow

    Row of the cell to add comment to.

    int iColumn

    Column of the cell to add comment to.

    bool bIsParseOptions

    Indicates is parse comment fill line options.

    Returns
    Type Description
    ICommentShape

    Newly created comment shape.

    Clear()

    Remove all ICommentShape from the IComments collection.

    Declaration
    public void Clear()

    OnClear()

    OnClear is invoked before Clear behavior.

    Declaration
    protected override void OnClear()
    Overrides
    CollectionBaseEx<CommentShapeImpl>.OnClear()

    OnClearComplete()

    OnClear is invoked after Clear behavior.

    Declaration
    protected override void OnClearComplete()
    Overrides
    CollectionBaseEx<CommentShapeImpl>.OnClearComplete()

    OnInsertComplete(int, CommentShapeImpl)

    Performs additional processes after inserting a new element into the collection.

    Declaration
    protected override void OnInsertComplete(int index, CommentShapeImpl value)
    Parameters
    Type Name Description
    int index

    The zero-based index at which to insert value.

    CommentShapeImpl value

    The new value of the element at index.

    Overrides
    CollectionBaseEx<CommentShapeImpl>.OnInsertComplete(int, CommentShapeImpl)

    OnRemoveComplete(int, CommentShapeImpl)

    Performs additional processes after removing an element from the collection.

    Declaration
    protected override void OnRemoveComplete(int index, CommentShapeImpl value)
    Parameters
    Type Name Description
    int index

    The zero-based index at which the value can be found.

    CommentShapeImpl value

    The value of the element to remove from index.

    Overrides
    CollectionBaseEx<CommentShapeImpl>.OnRemoveComplete(int, CommentShapeImpl)

    OnSetComplete(int, CommentShapeImpl, CommentShapeImpl)

    Performs additional processes after setting a value in the collection.

    Declaration
    protected override void OnSetComplete(int index, CommentShapeImpl oldValue, CommentShapeImpl newValue)
    Parameters
    Type Name Description
    int index

    The zero-based index at which oldValue can be found.

    CommentShapeImpl oldValue

    The value to replace with newValue.

    CommentShapeImpl newValue

    The new value of the element at the index.

    Overrides
    CollectionBaseEx<CommentShapeImpl>.OnSetComplete(int, CommentShapeImpl, CommentShapeImpl)

    Remove(ICommentShape)

    Removes comment from the collection.

    Declaration
    public void Remove(ICommentShape comment)
    Parameters
    Type Name Description
    ICommentShape comment

    Comment to remove from the collection.

    Implements

    IList<T>
    ICollection<T>
    IEnumerable<T>
    IParentApplication
    ICloneParent
    IComments
    IEnumerable

    Extension Methods

    CalcEngineHelper.ToArray<T>(IEnumerable<T>)
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved