DocumentSearchingEventArgs Class

A class containing the event data passed to a PdfIntegrationProvider instance when OnDocumentSearching(DocumentSearchingEventArgs) is called.

Inheritance Hierarchy

Namespace: RadPdf.Integration
Assembly: RadPdfStandard (in RadPdfStandard.dll) Version: 4.0.0.0 (4.0.0.0)

Syntax

public class DocumentSearchingEventArgs : DocumentCancelEventArgs

Public Class DocumentSearchingEventArgs
	Inherits DocumentCancelEventArgs

The DocumentSearchingEventArgs type exposes the following members.

Properties

	Name	Description
	CancelMessage	Gets or sets a value representing the cancel message displayed to the client if Cancel is true.
	DocumentID	Gets a value representing the DocumentID associated with this event as an Int32. (Inherited from DocumentCancelEventArgs.)
	DocumentKey	Gets a value representing the DocumentKey associated with this event as a String. (Inherited from DocumentCancelEventArgs.)
	DocumentProperties	Gets a PdfDocumentProperties class containing common properties describing the document being searched.
	IsLiteDocument	Gets a value indicating whether this document is a Lite Document (created with PdfWebControlLite) or not (and hence created with PdfWebControl). (Inherited from DocumentCancelEventArgs.)
	LiteSession	Gets the PdfLiteSession associated with this Lite Document. (Inherited from DocumentCancelEventArgs.)
	SearchString	Gets or sets a value representing the document search string.
	SearchTermMinLength	Gets or sets a value representing the length of the shortest search term allowed.

Methods

	Name	Description
	GetSearchTerms	Gets an array of search terms from the current value of SearchString.