Word.Interfaces.CommentContentRangeData interface

Package:

word

An interface describing the data returned by calling commentContentRange.toJSON().

Properties

bold	Specifies a value that indicates whether the comment text is bold.
hyperlink	Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
isEmpty	Checks whether the range length is zero.
italic	Specifies a value that indicates whether the comment text is italicized.
strikeThrough	Specifies a value that indicates whether the comment text has a strikethrough.
text	Gets the text of the comment range.
underline	Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.

Property Details

bold

Specifies a value that indicates whether the comment text is bold.

bold?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

hyperlink

Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.

hyperlink?: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

isEmpty

Checks whether the range length is zero.

isEmpty?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

italic

Specifies a value that indicates whether the comment text is italicized.

italic?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

strikeThrough

Specifies a value that indicates whether the comment text has a strikethrough.

strikeThrough?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

text

Gets the text of the comment range.

text?: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

underline

Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.

underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

Property Value

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

Remarks

[ API set: WordApi 1.4 ]