AnnotationOptions Class

Provides options for annotations (comments and tracked changes).

Namespace: DevExpress.XtraRichEdit

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

[ComVisible(false)]
public class AnnotationOptions :
    RichEditAnnotationOptionsBase

VB.NET

<ComVisible(False)>
Public Class AnnotationOptions
    Inherits RichEditAnnotationOptionsBase

Related API Members

The following members return AnnotationOptions objects:

• RichEditControlOptionsBase.Annotations

Remarks

The AnnotationOptions class provides options used to manage annotation authors and display options for comments and tracked changes.

Use the AnnotationOptions.Comments property to access comment options. The AnnotationOptions.TrackChanges property provides access to Track Changes options.

The AnnotationOptions.Author, AnnotationOptions.ShowAllAuthors and AnnotationOptions.VisibleAuthors property values are common for all annotations.

C#

richEditControl.Options.Annotations.Author = "Anne Dodsworth";

//Disable showing revisions from all authors
richEditControl.Options.Annotations.ShowAllAuthors = false;

//Remove authors whose revisions should not be displayed:
richEditControl.Options.Annotations.VisibleAuthors.Remove("Ryan Anita W");
richEditControl.Options.Annotations.VisibleAuthors.Remove("Michael Suyama");

VB.NET

richEditControl.Options.Annotations.Author = "Anne Dodsworth"

'Disable showing revisions from all authors
richEditControl.Options.Annotations.ShowAllAuthors = False

'Remove authors whose revisions should not be displayed:
richEditControl.Options.Annotations.VisibleAuthors.Remove("Ryan Anita W")
richEditControl.Options.Annotations.VisibleAuthors.Remove("Michael Suyama")

Implements

INotifyPropertyChanged

Inheritance

Object

ViewStatePersisterCore

BaseOptions

RichEditNotificationOptions

DevExpress.XtraRichEdit.RichEditAnnotationOptionsBase

AnnotationOptions