C1.Web.Api.Pdf.PdfController.GetSearchResults
GetSearchResults Method
GetSearchResults(string, string, bool, bool, int, SearchScope)
Gets the search result in the pdf document source instance with specified path.
Declaration
public virtual IHttpActionResult GetSearchResults(string pdfPath, string text, bool matchCase = false, bool wholeWord = false, int startPageIndex = 0, SearchScope scope = SearchScope.WholeDocument)Parameters
| Type | Name | Description |
|---|---|---|
| string | pdfPath | The full path of the pdf file. |
| string | text | The text used to be searched. |
| bool | matchCase | A boolean value indicates if search the value with case sensitive. |
| bool | wholeWord | A boolean value indicates if search the value with matching a whole word. |
| int | startPageIndex | 0-based index of the first page to search. |
| SearchScope | scope | The search scope. |
Returns
| Type | Description |
|---|---|
| IHttpActionResult | An System.Web.Http.IHttpActionResult type object with content of collection of SearchResult type object. |