HighlightInformation Property

Help > Web Development > Object Reference > Object Reference > ISYSDocument > HighlightInformation Property

<a name="kanchor323"></a>ISYSDocument:HighlightInformation Property

Returns hit-highlighting information for use with PDF documents. This allows you to enable hit highlighting when viewing PDF documents in Adobe Acrobat Reader. Read-Only.

Syntax
	[VBScript] *ReadOnly property ISYSDocument.HighlightInformation as string* [C#] *string IISYSDocument.HighlightInformation {get;}* [ColdFusion/Java] *java.lang.String ISYSDocument.HighlightInformation() throws ComException;*
Examples
	[VBScript] <% ' URL is pdfxml.asp?searchId=n&docId=n Set Results = ISYSSearch.Execute Set document = Results.Item(CLng(Request("docId"))) Response.Write document.HighlightInformation %>
Remarks
	Adobe Acrobat allows you to have hit highlighting when a PDF document is displayed in Adobe Acrobat Reader. The highlight information is passed in to Acrobat as an xml document that is appended to the requesting url as shown below: http://servername/docs/document.pdf#xml=[url_to_xml] This function returns the contents of the XML document that is to be passed to acrobat reader. You will need to manufacture the URL on the result list page to include a page that returns this XML.