Table of Contents

Class ExcelCommentObject

Namespace
Spire.Xls
Assembly
Spire.XLS.dll
public class ExcelCommentObject : ICommentShape, IComment, ITextBoxShape, ITextBox, IShape, IExcelApplication
Inheritance
ExcelCommentObject
Implements
Derived
Inherited Members

Properties

AlternativeText

Alternative text.

public string AlternativeText { get; set; }

Property Value

string

Author

Gets or sets the author of the comment.

public string Author { get; set; }

Property Value

string

AutoSize

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

public bool AutoSize { get; set; }

Property Value

bool

Column

Column of the commented range.

public int Column { get; }

Property Value

int

Fill

public IShapeFill Fill { get; }

Property Value

IShapeFill

Glow

public IGlow Glow { get; }

Property Value

IGlow

HAlignment

public CommentHAlignType HAlignment { get; set; }

Property Value

CommentHAlignType

Height

Height of comment.

public int Height { get; set; }

Property Value

int

HtmlString

Gets and sets the html string which contains data and some formattings in this shape.

public string HtmlString { get; set; }

Property Value

string

ID

public int ID { get; }

Property Value

int

IsLockAspectRatio

public bool IsLockAspectRatio { get; set; }

Property Value

bool

IsLocked

public bool IsLocked { get; set; }

Property Value

bool

IsPrintable

public bool IsPrintable { get; set; }

Property Value

bool

IsSmartArt

public bool IsSmartArt { get; }

Property Value

bool

IsTextLocked

public bool IsTextLocked { get; set; }

Property Value

bool

IsVisible

Indicates whether the comment is visible.

public bool IsVisible { get; set; }

Property Value

bool

Left

Position of left

public int Left { get; set; }

Property Value

int

Line

public IShapeLineFormat Line { get; }

Property Value

IShapeLineFormat

LinkedCell

Gets or sets the range linked to the shape's value.

public IXLSRange LinkedCell { get; set; }

Property Value

IXLSRange

Name

Name of object.

public string Name { get; set; }

Property Value

string

OnAction

public string OnAction { get; set; }

Property Value

string

Parent

public object Parent { get; }

Property Value

object

Reflection

public IReflectionEffect Reflection { get; }

Property Value

IReflectionEffect

ResizeBehave

Specifies all possible settings for how drawing object shall be resized when the rows and columns between its start and ending anchor are resized or inserted.

public ResizeBehaveType ResizeBehave { get; set; }

Property Value

ResizeBehaveType

RichText

public IRichTextString RichText { get; }

Property Value

IRichTextString

Rotation

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

public int Rotation { get; set; }

Property Value

int

Row

Row of the commented range.

public int Row { get; }

Property Value

int

Shadow

public IShadow Shadow { get; }

Property Value

IShadow

ShapeType

Shape type of object.

public ExcelShapeType ShapeType { get; set; }

Property Value

ExcelShapeType

Text

Comment text

public string Text { get; set; }

Property Value

string

TextFrame

public ITextFrame TextFrame { get; }

Property Value

ITextFrame

TextRotation

public TextRotationType TextRotation { get; set; }

Property Value

TextRotationType

ThreeD

public IFormat3D ThreeD { get; }

Property Value

IFormat3D

Top

Top of object.

public int Top { get; set; }

Property Value

int

VAlignment

public CommentVAlignType VAlignment { get; set; }

Property Value

CommentVAlignType

Visible

public bool Visible { get; set; }

Property Value

bool

Width

Width of object.

public int Width { get; set; }

Property Value

int

Methods

Remove()

Removes comment.

public void Remove()

Scale(int, int)

Scales all comments.

public void Scale(int scaleWidth, int scaleHeight)

Parameters

scaleWidth int

Width scale in percents.

scaleHeight int

Height scale in percents.

SetCommentLocation(bool, bool)

public void SetCommentLocation(bool isMoveWithCell, bool isSizeWithCell)

Parameters

isMoveWithCell bool
isSizeWithCell bool