PTSearchResult

@interface PTSearchResult : NSObject

The result of running pdftron::PDF::TextSearch::Run()

  • Declaration

    Objective-C

    - (BOOL)IsFound;

    Swift

    func isFound() -> Bool

    Return Value

    true if a match was found.

  • Declaration

    Objective-C

    - (BOOL)IsDocEnd;

    Swift

    func isDocEnd() -> Bool

    Return Value

    true if finished searching the entire document.

  • Declaration

    Objective-C

    - (BOOL)IsPageEnd;

    Swift

    func isPageEnd() -> Bool

    Return Value

    true if finished searching a page.

  • Declaration

    Objective-C

    - (int)GetPageNumber;

    Swift

    func getPageNumber() -> Int32

    Return Value

    the number of the page with the match.

  • Declaration

    Objective-C

    - (NSString *)GetMatch;

    Swift

    func getMatch() -> String!

    Return Value

    the string that matches the search pattern.

  • Declaration

    Objective-C

    - (NSString *)GetAmbientString;

    Swift

    func getAmbientString() -> String!

    Return Value

    the ambient string of the found string (computed only if ‘e_ambient_string’ is set).

  • Declaration

    Objective-C

    - (PTHighlights *)GetHighlights;

    Swift

    func getHighlights() -> PTHighlights!

    Return Value

    The Highlights info associated with the match (computed only if ‘e_highlight’ is set).

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()