Class PdfViewerCommentFilterSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
PdfViewerCommentFilterSettingsBuilder
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.EJ2.PdfViewer
Assembly: Syncfusion.AspNetMvc.PdfViewer.dll
Syntax
public class PdfViewerCommentFilterSettingsBuilder : ControlBuilderConstructors
PdfViewerCommentFilterSettingsBuilder()
Declaration
public PdfViewerCommentFilterSettingsBuilder()PdfViewerCommentFilterSettingsBuilder(PdfViewerCommentFilterSettings)
Declaration
public PdfViewerCommentFilterSettingsBuilder(PdfViewerCommentFilterSettings model)Parameters
| Type | Name | Description |
|---|---|---|
| PdfViewerCommentFilterSettings | model |
Methods
ApplyToDocument(Boolean)
Apply filtering to both comment panel and document annotations.
- false: Comment Panel only (default)
- true: Comment Panel + Document annotations
Declaration
public PdfViewerCommentFilterSettingsBuilder ApplyToDocument(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
| Type |
|---|
| PdfViewerCommentFilterSettingsBuilder |
Author(String[])
Filter by comment author name.
Declaration
public PdfViewerCommentFilterSettingsBuilder Author(string[] value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String[] | value |
Returns
| Type |
|---|
| PdfViewerCommentFilterSettingsBuilder |
Color(String[])
Filter by annotation color (hex or named). Examples: '#FF0000', 'red', '#FFC000'
Declaration
public PdfViewerCommentFilterSettingsBuilder Color(string[] value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String[] | value |
Returns
| Type |
|---|
| PdfViewerCommentFilterSettingsBuilder |
IncludeReplies(Boolean)
When author filtering is active, include reply threads by any author or only parent author.
- true: Show threads if parent OR any reply matches author filter
- false: Show threads only if parent matches author filter
Declaration
public PdfViewerCommentFilterSettingsBuilder IncludeReplies(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
| Type |
|---|
| PdfViewerCommentFilterSettingsBuilder |
ModifiedDate(String[])
Filter by collection of specific modified dates (ISO 8601). Format: ['2026-05-01', '2026-05-04', '2026-05-10'] Annotations matching any date in the collection are shown.
Declaration
public PdfViewerCommentFilterSettingsBuilder ModifiedDate(string[] value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String[] | value |
Returns
| Type |
|---|
| PdfViewerCommentFilterSettingsBuilder |
Status(CommentStatus)
Filter by comment status.
Declaration
public PdfViewerCommentFilterSettingsBuilder Status(CommentStatus value)Parameters
| Type | Name | Description |
|---|---|---|
| CommentStatus | value |
Returns
| Type |
|---|
| PdfViewerCommentFilterSettingsBuilder |
Type(AnnotationType)
Filter by annotation type. Supported values: 'Highlight', 'StickNote', 'Rectangle', 'Circle', 'Polygon', 'Polyline', 'Line', 'Arrow', 'FreeText', 'Measure', 'Stamp', 'Ink', 'Redaction', 'Signature', 'InkSignature'
Declaration
public PdfViewerCommentFilterSettingsBuilder Type(AnnotationType value)Parameters
| Type | Name | Description |
|---|---|---|
| AnnotationType | value |
Returns
| Type |
|---|
| PdfViewerCommentFilterSettingsBuilder |