PDFTron pdfnet-node

Class: Highlights

PDFNet. Highlights

new Highlights()

Highlights is used to store the necessary information and perform certain tasks in accordance with Adobe's Highlight standard, whose details can be found at: http://partners.adobe.com/public/developer/en/pdf/HighlightFileFormat.pdf In a nutshell, the Highlights class maintains a set of highlights. Each highlight contains three pieces of information: page: the number of the page this Highlight is on; position: the start position (text offset) of this Highlight; length: the length of this Highlight. Possible use case scenarios for Highlights include: - Load a Highlight file (in XML format) and highlight the corresponding texts in the viewer (e.g., if the viewer is implemented using PDFViewCtrl, it can be achieved simply by calling PDFViewCtrl::SelectByHighlights() method); - Save the Highlight information (e.g., constructed by the TextSearch class) to an XML file for external uses. Note: - The Highlights class does not maintain the corresponding PDF document for its highlights. It is the user's responsibility to match them up. - The Highlights class ensures that each highlight it maintains is unique (no two highlights have the same page, position and length values). - The current implementation of Highlights only supports the 'characters' encoding for 'units' as described in the format; the 'words' encoding is not supported at this point. For a sample code, please take a look at the TextSearchTest sample project.

Extends

Methods

<static> create()

Constructor and destructor.
Returns:
A promise that resolves to an object of type: "PDFNet.Highlights"
Type
Promise.<PDFNet.Highlights>

add(hlts)

Add highlights.
Parameters:
Name Type Description
hlts PDFNet.Highlights the Highlights instance containing the highlights to be added.
Returns:
Type
Promise.<void>

begin(doc)

Rewind the internal pointer to the first highlight.
Parameters:
Name Type Description
doc PDFNet.PDFDoc | PDFNet.SDFDoc | PDFNet.FDFDoc the PDF document to which the highlights correspond. Note: the PDF document can be a dummy document unless GetCurrentQuads() is to be called.
Returns:
Type
Promise.<void>

clear()

Clear the current Highlight information in the class.
Returns:
Type
Promise.<void>

copyCtor()

Returns:
A promise that resolves to an object of type: "PDFNet.Highlights"
Type
Promise.<PDFNet.Highlights>

destroy()

Destructor
Inherited From:
Returns:
Type
Promise.<void>

getCurrentPageNumber()

Get the page number of the current highlight.
Returns:
A promise that resolves to an object of type: "number"
Type
Promise.<number>

getCurrentQuads()

Retrieves an array of Quads (each quad contains 4 points) representing the regions that were highlighted.
Returns:
A promise that resolves to an object of type: "number" (generated documentation)
Type
Promise.<Array.<PDFNet.QuadPoint>>

getCurrentTextRange()

Get a TextRange object that represents the current highlight.
Returns:
A promise that resolves to an object of type: "PDFNet.TextRange"
Type
Promise.<PDFNet.TextRange>

hasNext()

Query if there is any subsequent highlight after the current highlight.
Returns:
A promise that resolves to an object of type: "boolean"
Type
Promise.<boolean>

load(file_name)

Load the Highlight information from a file. Note that the pre-existing Highlight information is discarded.
Parameters:
Name Type Description
file_name string the name of the file to load from.
Returns:
Type
Promise.<void>

next()

Move the current highlight to the next highlight.
Returns:
Type
Promise.<void>

save(file_name)

Save the current Highlight information in the class to a file.
Parameters:
Name Type Description
file_name string the name of the file to save to.
Returns:
Type
Promise.<void>

saveToString()

Save the current Highlight information in the class to an XML string.
Returns:
A promise that resolves to the highlight XML file contents as a string
Type
Promise.<string>

takeOwnership()

Take the ownership of this object, so that PDFNet.runWithCleanup won't destroy this object.
Inherited From:
Returns:
Type
void