AnnotationOptions.Comments Property

Provides access to the options used to display comments in a document.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

public CommentOptions Comments { get; }

VB.NET

Public ReadOnly Property Comments As CommentOptions

Property Value

Type	Description
CommentOptions	An object containing comment options.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to Comments
WinForms Controls	SnapControl	.Options .Comments
	SnapControl	.Annotations .Comments
	SnapControlOptions	.Annotations .Comments
	RichEditControl	.Options .Comments
RichEditControl	.Annotations .Comments
RichEditControlOptions	.Annotations .Comments
WPF Controls	RichEditControl	.Options .Comments
	RichEditControl	.Annotations .Comments
RichEditControlOptions	.Annotations .Comments
Office File API	IRichEditDocumentServer	.Options .Comments
	IRichEditDocumentServer	.Annotations .Comments
	RichEditControlOptionsBase	.Annotations .Comments
RichEditDocumentServer	.Options .Comments
RichEditDocumentServer	.Annotations .Comments
Reporting	SyntaxEditor	.Options .Comments
SyntaxEditor	.Annotations .Comments

Remarks

The code sample below shows how to specify comment options:

C#

CommentOptions commentOptions = documentProcessor.Options.Annotations.Comments;

commentOptions.Color = System.Drawing.Color.DarkRed;
commentOptions.Visibility = RichEditCommentVisibility.Visible;
commentOptions.HighlightCommentedRange = true;

VB.NET

Dim commentOptions As CommentOptions = documentProcessor.Options.Annotations.Comments

commentOptions.Color = System.Drawing.Color.DarkRed
commentOptions.Visibility = RichEditCommentVisibility.Visible
commentOptions.HighlightCommentedRange = True

Tip

Use the AnnotationOptions class properties to manage comment authors. Access the properties via the documentProcessor.Options.Annotations notation.