Class CommentsRange
This class represents comment for multicell range.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Shapes
Assembly: Syncfusion.XlsIO.UWP.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 |
---|
System.String |
Author
Returns or sets the author of the comment. Read-only String.
Declaration
public string Author { get; }
Property Value
Type |
---|
System.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 |
---|
System.Boolean |
Column
Column of the commented cell. Read-only.
Declaration
public int Column { get; }
Property Value
Type |
---|
System.Int32 |
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 |
---|
System.Int32 |
HeightDouble
Gets or sets the height of the Shape expressed in decimal units.
Declaration
public double HeightDouble { get; set; }
Property Value
Type |
---|
System.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 |
---|
System.Int32 |
IsMoveWithCell
Indicates whether shape must be moved with cells.
Declaration
public bool IsMoveWithCell { get; set; }
Property Value
Type |
---|
System.Boolean |
IsShapeVisible
Determines whether the object is visible. Read / write Boolean.
Declaration
public bool IsShapeVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
IsSizeWithCell
Indicates whether shape must be sized with cells.
Declaration
public bool IsSizeWithCell { get; set; }
Property Value
Type |
---|
System.Boolean |
IsTextLocked
Indicates whether comment text is locked.
Declaration
public bool IsTextLocked { get; set; }
Property Value
Type |
---|
System.Boolean |
IsVisible
Determines whether the object is visible. Read / write Boolean.
Declaration
public bool IsVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
Left
Gets or sets left position of the comment
Declaration
public int Left { get; set; }
Property Value
Type |
---|
System.Int32 |
LeftDouble
Gets or sets the left position of the Shape expressed in decimal units.
Declaration
public double LeftDouble { get; set; }
Property Value
Type |
---|
System.Double |
Line
Represents line format properties. Read-only.
Declaration
public IShapeLineFormat Line { get; }
Property Value
Type |
---|
IShapeLineFormat |
Name
Gets or sets the comment shape name.
Declaration
public string Name { get; set; }
Property Value
Type |
---|
System.String |
OnAction
Gets or sets macro associated with this shape
Declaration
public string OnAction { get; set; }
Property Value
Type |
---|
System.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 |
---|
System.Int32 |
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 |
---|
System.Int32 |
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 |
---|
System.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 |
---|
System.Int32 |
TopDouble
Gets or sets the top position of the Shape expressed in decimal units.
Declaration
public double TopDouble { get; set; }
Property Value
Type |
---|
System.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 |
---|
System.Int32 |
WidthDouble
Gets or sets the width of the Shape expressed in decimal units.
Declaration
public double WidthDouble { get; set; }
Property Value
Type |
---|
System.Double |
Methods
Remove()
Removes this comment.
Declaration
public void Remove()
Scale(Int32, Int32)
Scales all comments in the array.
Declaration
public void Scale(int scaleWidth, int scaleHeight)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | scaleWidth | Width scale in percents. |
System.Int32 | scaleHeight | Height scale in percents. |