Table of Contents

DocumentViewerSearchOptions Class

Definition

Namespace
GleamTech.DocumentUltimate.AspNet.UI
Assembly
GleamTech.DocumentUltimate.dll

Represents text search options of the document viewer.

If you specify a search term, an automatic search will be done when the document is displayed, i.e. the specified term will be searched and results with clickable positions will be listed on the left pane and the term will be highlighted in the pages. For example, if you launch the document viewer from a search results page, you can pass the same search term to the document viewer.

public class DocumentViewerSearchOptions
Inheritance
DocumentViewerSearchOptions

Constructors

DocumentViewerSearchOptions()

Initializes a new instance of the DocumentViewerSearchOptions class.

Properties

ActiveHighlightColor

Gets or sets the color to use for highlighting active (current) search result. Default is orange.

HighlightAll

Gets or sets a value that specifies whether to highlight all search results, i.e. not only active (current) search result. Default value is true.

HighlightColor

Gets or sets the color to use for highlighting search results. Default is yellow.

MatchOptions

Gets or sets a value that specifies the match options for text search.

Term

Gets or sets a value that specifies the search term used.

Refer to MatchAnyWord to see how to specify multiple phrases inside a query.