CommentOptions.HighlightCommentedRange Property

Gets or sets whether to highlight commented document ranges.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

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:

Object Type	Path to HighlightCommentedRange
AnnotationOptions	.Comments .HighlightCommentedRange
RichEditControlOptionsBase	.Comments .HighlightCommentedRange

Remarks

When the CommentOptions.Visibility is set to RichEditCommentVisibility.Visible, the comment balloons are displayed and document ranges are highlighted.

Set the CommentOptions.Visibility to Hidden and the HighlightCommentedRange option to true to hide comment balloons and keep commented ranges highlighted.

You can disable highlighting commented ranges only when the CommentOptions.Visibility property is set to Hidden.

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

Specify the CommentOptions.Color property to set the comment color (uniform throughout all comments). Use the CommentOptions.ResetColor method to go back to the default color schema.