Highlights Class

Get a Highlights object based on an array of character ranges

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.

public sealed class Highlights : IClosable

Public NotInheritable Class Highlights
	Implements IClosable

public ref class Highlights sealed : IClosable

pdftron.PDF.Highlights = function();

Type.createClass(
	'pdftron.PDF.Highlights',
	null,
	Windows.Foundation.IClosable);