Click or drag to resize

Highlights Class

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.
Inheritance Hierarchy
SystemObject
  pdftron.PDFHighlights

Namespace:  pdftron.PDF
Assembly:  pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax
public sealed class Highlights : IClosable

The Highlights type exposes the following members.

Constructors
  NameDescription
Public methodHighlights
Creates a default Highlights object
Public methodHighlights(Highlights)
Creates a Hightlights from a given object
Top
Methods
  NameDescription
Public methodAdd
Add extra Highlight information into the class.
Public methodBegin
Rewind the internal pointer to the first highlight.
Public methodClear
Clear the current Highlight information in the class.
Public methodClose
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetCurrentPageNumber
Get the page number of the current highlight.
Public methodGetCurrentQuads
Get the corresponding quadrangles of the current highlight.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasNext
Query if there is any subsequent highlight after the current highlight.
Public methodLoad
Load the Highlight information from a file. Note that the pre-existing Highlight information is discarded.
Public methodLoadAsync
Loads the Highlight information from a filter. Note that the pre-existing Highlight information will be discarded.
Public methodNext
Move the current highlight to the next highlight.
Public methodSave
Save the current Highlight information in the class to a file.
Public methodSaveAsync
Save the current Highlight information in the class to a filter.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
For a sample code, please take a look at the TextSearchTest sample project.
See Also