Web API Core | ComponentOne
C1.Web.Api.Pdf Namespace / PdfController Class / GetSearchResults Method
The full path of the pdf file.
The text used to be searched.
A boolean value indicates if search the value with case sensitive.
A boolean value indicates if search the value with matching a whole word.
0-based index of the first page to search.
The search scope.

In This Topic
    GetSearchResults Method
    In This Topic
    Gets the search result in the pdf document source instance with specified path.
    Syntax
    'Declaration
     
    
    <HttpGetAttribute()>
    <PathRouteAttribute("{*pdfPath}$pdf/search")>
    Public Overridable Function GetSearchResults( _
       ByVal pdfPath As String, _
       ByVal text As String, _
       Optional ByVal matchCase As Boolean, _
       Optional ByVal wholeWord As Boolean, _
       Optional ByVal startPageIndex As Integer, _
       Optional ByVal scope As SearchScope _
    ) As IActionResult
    [HttpGet()]
    [PathRoute("{*pdfPath}$pdf/search")]
    public virtual IActionResult GetSearchResults( 
       string pdfPath,
       string text,
       bool matchCase,
       bool wholeWord,
       int startPageIndex,
       SearchScope scope
    )

    Parameters

    pdfPath
    The full path of the pdf file.
    text
    The text used to be searched.
    matchCase
    A boolean value indicates if search the value with case sensitive.
    wholeWord
    A boolean value indicates if search the value with matching a whole word.
    startPageIndex
    0-based index of the first page to search.
    scope
    The search scope.

    Return Value

    An Microsoft.AspNetCore.Mvc.IActionResult type object with content of collection of C1.Web.Api.Document.Models.SearchResult type object.
    See Also