Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Base
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.FluentDesignSystem
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Collapse]DevExpress.XtraPdfViewer
   [Expand]IPdfViewerCommandFactoryService Interface
   [Expand]PdfAnnotationDeletingEventArgs Class
    PdfAnnotationDeletingEventHandler Delegate
   [Expand]PdfCancelSaveOperationException Class
    PdfContentMarginMode Enumeration
   [Expand]PdfCurrentPageChangedEventArgs Class
    PdfCurrentPageChangedEventHandler Delegate
    PdfCursorMode Enumeration
   [Expand]PdfDocumentChangedEventArgs Class
    PdfDocumentChangedEventHandler Delegate
   [Expand]PdfDocumentClosingEventArgs Class
    PdfDocumentClosingEventHandler Delegate
   [Expand]PdfDocumentProperties Class
   [Expand]PdfFileAttachmentOpeningEventArgs Class
    PdfFileAttachmentOpeningEventHandler Delegate
   [Expand]PdfFindDialogOptions Structure
   [Expand]PdfFindDialogVisibilityChangedEventArgs Class
    PdfFindDialogVisibilityChangedEventHandler Delegate
   [Expand]PdfFormFieldFocusEventArgs Class
    PdfFormFieldFocusEventHandler Delegate
   [Expand]PdfFormFieldValueChangedEventArgs Class
    PdfFormFieldValueChangedEventHandler Delegate
   [Expand]PdfFormFieldValueChangingEventArgs Class
    PdfFormFieldValueChangingEventHandler Delegate
   [Expand]PdfMarkupAnnotationGotFocusEventArgs Class
    PdfMarkupAnnotationGotFocusEventHandler Delegate
   [Expand]PdfMarkupAnnotationLostFocusEventArgs Class
    PdfMarkupAnnotationLostFocusEventHandler Delegate
   [Expand]PdfMarkupToolsSettings Class
    PdfNavigationPanePage Enumeration
    PdfNavigationPanePageVisibility Enumeration
   [Expand]PdfNavigationPaneSelectedPageChangedEventArgs Class
    PdfNavigationPaneSelectedPageChangedEventHandler Delegate
    PdfNavigationPaneVisibility Enumeration
   [Expand]PdfNavigationPaneVisibilityChangedEventArgs Class
    PdfNavigationPaneVisibilityChangedEventHandler Delegate
    PdfOutlineNodeTextSize Enumeration
   [Expand]PdfOutlineViewerSettings Class
   [Expand]PdfPageSetupDialogShowingEventArgs Class
    PdfPageSetupDialogShowingEventHandler Delegate
    PdfPopupMenuKind Enumeration
   [Expand]PdfPopupMenuShowingEventArgs Class
    PdfPopupMenuShowingEventHandler Delegate
   [Expand]PdfReferencedDocumentOpeningEventArgs Class
    PdfReferencedDocumentOpeningEventHandler Delegate
   [Expand]PdfScrollPositionChangedEventArgs Class
    PdfScrollPositionChangedEventHandler Delegate
   [Expand]PdfSelectionContent Structure
    PdfSelectionContentType Enumeration
   [Expand]PdfSelectionEventArgs Class
    PdfSelectionPerformedEventHandler Delegate
   [Expand]PdfTextMarkupAnnotationChangedEventArgs Class
    PdfTextMarkupAnnotationChangedEventHandler Delegate
   [Expand]PdfTextMarkupAnnotationCreatedEventArgs Class
    PdfTextMarkupAnnotationCreatedEventHandler Delegate
   [Expand]PdfTextMarkupAnnotationCreatingEventArgs Class
    PdfTextMarkupAnnotationCreatingEventHandler Delegate
   [Expand]PdfUriOpeningEventArgs Class
    PdfUriOpeningEventHandler Delegate
   [Collapse]PdfViewer Class
     PdfViewer Members
     PdfViewer Constructor
    [Expand]PdfViewer Properties
    [Expand]PdfViewer Events
    [Collapse]PdfViewer Methods
      About Method
     [Expand]AddService Method
      ClearSelection Method
      CloseDocument Method
      CopyToClipboard Method
     [Expand]CreateBars Method
      CreateBitmap Method
     [Expand]CreateRibbon Method
     [Expand]CreateTiff Method
      EnsureVisibility Method
     [Collapse]FindText Method
       FindText(String) Method
       FindText(String, PdfTextSearchParameters) Method
       FindText(String, PdfTextSearchParameters, Func<Int32, Boolean>) Method
      GetClientPoint Method
      GetContentInfo Method
     [Expand]GetDocumentPosition Method
      GetPageSize Method
      GetSelectionContent Method
      GetService<T> Method
     [Expand]HideFindDialog Method
     [Expand]HighlightSelectedText Method
      IsVisible Method
     [Expand]LoadDocument Method
     [Expand]Print Method
     [Expand]RemoveService Method
     [Expand]SaveDocument Method
      ScrollHorizontal Method
      ScrollVertical Method
     [Expand]Select Method
      SelectAllText Method
      SelectAnnotation Method
      ShowDocumentClosingWarning Method
     [Expand]ShowFindDialog Method
     [Expand]StrikethroughSelectedText Method
     [Expand]UnderlineSelectedText Method
    PdfViewerToolbarKind Enumeration
   [Expand]PdfZoomChangedEventArgs Class
    PdfZoomChangedEventHandler Delegate
    PdfZoomMode Enumeration
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

PdfViewer.FindText(String, PdfTextSearchParameters) Method

Searches for the specified text in the current document with the applied parameters.

Namespace:DevExpress.XtraPdfViewer
Assembly:DevExpress.XtraPdfViewer.v18.1.dll

Expanded Syntax

Parameters

text
Type: String
A System.String value, specifying the text to find in the PDF.
parameters
Type: PdfTextSearchParameters
A DevExpress.Pdf.PdfTextSearchParameters object.

Return value

Type: PdfTextSearchResults
A DevExpress.Pdf.PdfTextSearchResults object.

Expanded Remarks

The FindText method stops searching when it finds the first occurrence of the search text, highlights the occurrence and navigates to the highlighted text. See Searching for Text for more details.

Note

The overloaded FindText method uses the page coordinate system. See the Coordinate Systems topic to learn more.

Expanded Example

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T601532.

This example shows how to execute the Find Next action by pressing the F3 shortcut, after an end-user has specified text search options in the Find Text dialog.

To do this, handle the PdfViewer.KeyDown event. If the F3 key is pressed, call the overloaded FindText method and pass the text to search and search parameters obtained from the Find Text dialog to this method.

The text search settings (e.g, search text, whole words, case sensitive) applied by an end-user in the Find Text dialog can be accessed using the FindDialogOptions property.

Expanded See Also

Is this topic helpful?​​​​​​​