CommentOptions.HighlightCommentedRange Property

Gets or sets whether commented document ranges are highlighted.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#

[DefaultValue(false)]
public bool HighlightCommentedRange { get; set; }

VB.NET

<DefaultValue(False)>
Public Property HighlightCommentedRange As Boolean

Property Value

Type	Default	Description
Boolean	**false**	True, to highlight ranges which have comments associated with them; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to HighlightCommentedRange
WinForms Controls	SnapControlOptions	.Comments.HighlightCommentedRange
	RichEditControlOptions	.Comments.HighlightCommentedRange
WPF Controls	RichEditControlOptions	.Comments.HighlightCommentedRange
Office File API	RichEditControlOptionsBase	.Comments.HighlightCommentedRange

Remarks

When the CommentOptions.Visibility is set to RichEditCommentVisibility.Visible, the comment balloons are displayed and document ranges are highlighted. However, you can hide comments and highlight commented ranges by setting the CommentOptions.Visibility to RichEditCommentVisibility.Hidden and the CommentOptions.HighlightCommentedRange option - to true.

Default comment colors are obtained from the predefined color scheme, a distinct color for each reviewer. The colors are shown in the picture below.

You can set the a comment color which is uniform throughout all comments and reviewers by specifying the CommentOptions.Color property. Use the CommentOptions.ResetColor method to go back to the default color schema.