CommentOptions.Visibility Property

Specifies the visibility mode of a document comment.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[DefaultValue(RichEditCommentVisibility.Auto)]
public RichEditCommentVisibility Visibility { get; set; }

VB.NET

<DefaultValue(RichEditCommentVisibility.Auto)>
Public Property Visibility As RichEditCommentVisibility

Property Value

Type	Default	Description
RichEditCommentVisibility	**Auto**	A RichEditCommentVisibility enumeration value.

Available values:

Name	Description
Auto	Comment visibility is determined automatically.
Visible	Comments are always visible.
Hidden	Comments are always hidden.

Property Paths

You can access this nested property as listed below:

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

Remarks

When the CommentOptions.Visibility is set to RichEditCommentVisibility.Visible, the comment balloons are displayed and document ranges are highlighted. You can hide comments and highlight commented ranges by setting the Visibility to Hidden and the CommentOptions.HighlightCommentedRange option - to true. Note that the Visibility property value changes to Visible after adding a new comment.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Visibility property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-richedit-document-api-e5219/CS/RichEditAPISample/DisplayResultControl.cs#L20

InitializeComponent();
richEditControl1.Options.Comments.Visibility = DevExpress.XtraRichEdit.RichEditCommentVisibility.Hidden;
richEditControl1.Options.Comments.ShowAllAuthors = true;

VB.NET

winforms-richedit-document-api-e5219/VB/RichEditAPISample/DisplayResultControl.vb#L19

InitializeComponent()
richEditControl1.Options.Comments.Visibility = DevExpress.XtraRichEdit.RichEditCommentVisibility.Hidden
richEditControl1.Options.Comments.ShowAllAuthors = True