Click or drag to resize

PdfDocumentEditorSearch Method

Searches the document for one or more keywords / terms / words in this Document.

Namespace:  RadPdf.Data.Document
Assembly:  RadPdf (in RadPdf.dll) Version: 3.20.5.0 (3.20.5.0)
Syntax
public PdfSearchResult[] Search(
	string value
)

Parameters

value
Type: SystemString
The search string to look for in this PdfDocument. RAD PDF does not support any search operators at this time. Any keyword in the search string can be matched.

Return Value

Type: PdfSearchResult

An array of PdfSearchResult instances for each search result found.

If the search string value contains more than one word, this array will contain the results for each word provided. This is nearly equivalent (although faster) to calling Search(String) multiple times with each individual word you wish to search for and then merging the results. This is often referred to as an OR Search.

Remarks

This method will also return partial matches. (e.g. "example" will be found if value is "example", "amp", or "a")

This method is case-insensitive. (e.g. "example" will be found if value is "example", "EXAMPLE", or "exAMPle")

RAD PDF considers the following characters to be whitespace characters and are used to deliminate between search keywords / terms:

Unicode Code Point(s) Description
U+0000 NULL
U+0009–U+000D Control Characters, containing Tab, CR and LF
U+0020 SPACE
U+0085 NEL (control character next line)
U+00A0 NBSP (NO-BREAK SPACE)
U+1680 OGHAM SPACE MARK
U+180E MONGOLIAN VOWEL SEPARATOR
U+2000–U+200A Additional Unicode spaces
U+2028 LS (LINE SEPARATOR)
U+2029 PS (PARAGRAPH SEPARATOR)
U+202F NNBSP (NARROW NO-BREAK SPACE)
U+205F MMSP (MEDIUM MATHEMATICAL SPACE)
U+3000 IDEOGRAPHIC SPACE

Because RAD PDF stores document text separately from document instances, this method may create and use a database connection.

If DisableSearchText is set for this Document, this method will throw an exception.

This method will create and use a database connection.

See Also