Click or drag to resize

DocumentSearchingEventArgs Class

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

Namespace:  RadPdf.Integration
Assembly:  RadPdf (in RadPdf.dll) Version: 3.26.0.0 (3.26.0.0)
Syntax
public class DocumentSearchingEventArgs : DocumentCancelEventArgs

The DocumentSearchingEventArgs type exposes the following members.

Properties
  NameDescription
Public propertyCancel
Gets or sets a value indicating whether the event should be canceled.
(Inherited from CancelEventArgs.)
Public propertyCancelMessage
Gets or sets a value representing the cancel message displayed to the client if Cancel is true.
Public propertyDocumentID
Gets a value representing the DocumentID associated with this event as an Int32.
(Inherited from DocumentCancelEventArgs.)
Public propertyDocumentKey
Gets a value representing the DocumentKey associated with this event as a String.
(Inherited from DocumentCancelEventArgs.)
Public propertyDocumentProperties
Gets a PdfDocumentProperties class containing common properties describing the document being searched.
Public propertyIsLiteDocument
Gets a value indicating whether this document is a Lite Document (created with PdfWebControlLite) or not (and hence created with PdfWebControl).
(Inherited from DocumentCancelEventArgs.)
Public propertyLiteSession
Gets the PdfLiteSession associated with this Lite Document.
(Inherited from DocumentCancelEventArgs.)
Public propertySearchString
Gets or sets a value representing the document search string.
Public propertySearchTermMinLength
Gets or sets a value representing the length of the shortest search term allowed.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetSearchTerms
Gets an array of search terms from the current value of SearchString.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also