alexa
menu

MAUI

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

    Show / Hide Table of Contents

    Class CommentsRange

    This class represents comment for multicell range.

    Inheritance
    object
    CommonObject
    CommentsRange
    Implements
    IDisposable
    ICommentShape
    IComment
    ITextBox
    IShape
    IParentApplication
    Inherited Members
    CommonObject.AddReference()
    CommonObject.AppImplementation
    CommonObject.Application
    CommonObject.CheckDisposed()
    CommonObject.Dispose()
    CommonObject.FindParent(object, Type)
    CommonObject.FindParent(object, Type, bool)
    CommonObject.FindParent(Type)
    CommonObject.FindParent(Type, bool)
    CommonObject.FindParent(Type[])
    CommonObject.FindParents(Type[])
    CommonObject.m_bIsDisposed
    CommonObject.OnDispose()
    CommonObject.Parent
    CommonObject.ReferenceCount
    CommonObject.ReleaseReference()
    CommonObject.SetParent(object)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Implementation.Shapes
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    public class CommentsRange : CommonObject, IDisposable, ICommentShape, IComment, ITextBox, IShape, IParentApplication

    Constructors

    CommentsRange(IApplication, IRange)

    Creates instance for specified range.

    Declaration
    public CommentsRange(IApplication application, IRange parentRange)
    Parameters
    Type Name Description
    IApplication application

    Application object for new object.

    IRange parentRange

    Parent range.

    Properties

    AlternativeText

    Gets or sets alternative text.

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

    Author

    Returns or sets the author of the comment. Read-only String.

    Declaration
    public string Author { get; }
    Property Value
    Type
    string

    AutoSize

    True if the size of the specified object is changed automatically to fit text within its boundaries. Read/write Boolean.

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

    Column

    Column of the commented cell. Read-only.

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

    Fill

    Represents fill properties. Read-only.

    Declaration
    public IFill Fill { get; }
    Property Value
    Type
    IFill

    HAlignment

    Horizontal alignment of the text.

    Declaration
    public ExcelCommentHAlign HAlignment { get; set; }
    Property Value
    Type
    ExcelCommentHAlign

    Height

    Gets or sets height of comment shape

    Declaration
    public int Height { get; set; }
    Property Value
    Type
    int

    HeightDouble

    Gets or sets the height of the Shape expressed in decimal units.

    Declaration
    public double HeightDouble { get; set; }
    Property Value
    Type
    double

    Hyperlink

    Get object that represents the hyperlink for the shape.

    Declaration
    public IHyperLink Hyperlink { get; }
    Property Value
    Type
    IHyperLink

    Id

    Gets Comments range id.

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

    IsMoveWithCell

    Indicates whether shape must be moved with cells.

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

    IsShapeVisible

    Determines whether the object is visible. Read / write Boolean.

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

    IsSizeWithCell

    Indicates whether shape must be sized with cells.

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

    IsTextLocked

    Indicates whether comment text is locked.

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

    IsVisible

    Determines whether the object is visible. Read / write Boolean.

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

    Left

    Gets or sets left position of the comment

    Declaration
    public int Left { get; set; }
    Property Value
    Type
    int

    LeftDouble

    Gets or sets the left position of the Shape expressed in decimal units.

    Declaration
    public double LeftDouble { get; set; }
    Property Value
    Type
    double

    Line

    Represents line format properties. Read-only.

    Declaration
    public IShapeLineFormat Line { get; }
    Property Value
    Type
    IShapeLineFormat

    LockText

    Gets or Sets whether to allow text editing within this drawing object when the parent worksheet is protected

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

    Name

    Gets or sets the comment shape name.

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

    OnAction

    Gets or sets macro associated with this shape

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

    RichText

    Text of the comment.

    Declaration
    public IRichTextString RichText { get; set; }
    Property Value
    Type
    IRichTextString

    Row

    Row of the commented cell. Read-only.

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

    Shadow

    Gets the shadow properties.

    Declaration
    public IShadow Shadow { get; }
    Property Value
    Type Description
    IShadow

    The shadow properties.

    ShapeRotation

    Returns or sets the rotation of the shape, in degrees.

    Declaration
    public int ShapeRotation { get; set; }
    Property Value
    Type
    int

    ShapeType

    Gets shape type.

    Declaration
    public ExcelShapeType ShapeType { get; }
    Property Value
    Type
    ExcelShapeType

    Text

    Gets or sets text.

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

    TextFrame

    Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape. Read-only.

    Declaration
    public ITextFrame TextFrame { get; }
    Property Value
    Type
    ITextFrame

    TextRotation

    Text rotation.

    Declaration
    public ExcelTextRotation TextRotation { get; set; }
    Property Value
    Type
    ExcelTextRotation

    ThreeD

    Gets the chart3 D properties.

    Declaration
    public IThreeDFormat ThreeD { get; }
    Property Value
    Type Description
    IThreeDFormat

    The chart3 D properties.

    Top

    Gets or sets the Top position of the shape.

    Declaration
    public int Top { get; set; }
    Property Value
    Type
    int

    TopDouble

    Gets or sets the top position of the Shape expressed in decimal units.

    Declaration
    public double TopDouble { get; set; }
    Property Value
    Type
    double

    VAlignment

    Vertical alignment of the text.

    Declaration
    public ExcelCommentVAlign VAlignment { get; set; }
    Property Value
    Type
    ExcelCommentVAlign

    Width

    Gets or set the width of shape.

    Declaration
    public int Width { get; set; }
    Property Value
    Type
    int

    WidthDouble

    Gets or sets the width of the Shape expressed in decimal units.

    Declaration
    public double WidthDouble { get; set; }
    Property Value
    Type
    double

    Methods

    Remove()

    Removes this comment.

    Declaration
    public void Remove()

    Scale(int, int)

    Scales all comments in the array.

    Declaration
    public void Scale(int scaleWidth, int scaleHeight)
    Parameters
    Type Name Description
    int scaleWidth

    Width scale in percents.

    int scaleHeight

    Height scale in percents.

    Implements

    IDisposable
    ICommentShape
    IComment
    ITextBox
    IShape
    IParentApplication
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved