Help > Web Development > Object Reference > Object Reference > ISYSDocument
<a name="kanchor298"></a>ISYSDocument Object
ISYSDocument is used to access properties about each document in the result list.
ISYSDocument Methods
ContextReturns a short summary of the document based on the context of the search.
GetLineWithHitAfterReturns the number of the line with the next hit after the specified line.
GetLineWithHitBeforeReturns the number of the line with the previous hit before the specified line.
GetLineWithTermAfterReturns the next line that contain the specific search term.
GetLineWithTermBeforeReturns the previous line that contain the specific search term.
IconReturns the path to an icon that can be used to represent this document. Read-Only.
KeyEntitiesReturns the key entities for the given entity type.
LineReturns the text of specified line from the document.
LinesReturns an array of lines.
MarkAsReadMark as read is used when the result list is returned from an agent. It gives you the ability to flag a document as being read so it will not be returned next time the result list is requested.
SetHighlightColorsSets the colors to use for hit-highlighting when returning HTML from the Line method.
ISYSDocument Properties
AbsoluteFilenameReturns the fully qualified file name of the document. Read-Only.
AnnotationsReturns an enumeration of the annotations associated with this document.
AssociatedImageReturns any image associated with this document
CategoryReturns the category name stored for this document. Read-Only.
ChangedIndicates if the document has changed since it was indexed. Read-Only.
DateIndexedReturns the date that the document was last indexed. Read-Only.
DateInDocumentReturns the first date that appears in the document. Intelligent date recognition required. Read-Only.
DisplayReturns the Display object that is used to render the document.
DocumentAttributesBitmask set of attributes about the document
DocumentNumberReturns the internal ISYS document number. Read-Only.
EntitiesReturns a list of entities present in this document.
FileExtensionReturns the file extension of the document, taking into account nested files (zip and attachments). Read-Only.
FilenameReturns the file name of the document as it appears in the index. Read-Only.
FilesizeReturns the size of the file as it is on disk. Read-Only.
FormatReturns the format of the document as a textual description. Read-Only.
FormatTypeReturns the format of the document as a numeric code. Read-Only.
FoundInReturns the index that this document was found in, taking into account chained indexes.
GroupReturns the group that the document belongs to.
GroupNameReturns the group name for the document based on the current sort order. Read-Only.
HighlightInformationReturns 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.
HitCountReturns the number of found hits in the document. Each individual word is counted as a hit. Read-Only.
IndexReturns the index of the document in the result list.
IsAuthorizedIndicates if the currently logged on NT user has permissions to view this document. Read-Only.
IsBestBetReturns true if the document is a best bet.
IsDuplicateReturns true if the document is a duplicate result.
IsOpenableReturns true if the document is openable, meaning the document's text is accessible.
LineCountReturns the number of lines within the document. Read-Only.
MetadataReturns the metadata stored for this document. Read-Only.
PathReturns the full file path of the document. Read-Only.
PhrasedHitsReturns the number of found hits in the document, with consecutive runs of hits counting as one. Read-Only.
RealFormatReturns a the format name of the underlying document when using ISYS:rich-html. Read-Only.
RealFormatTypeReturns an long that represents the underlying format of a document when using ISYS:rich-html. Read-Only.
RelatedReturns a list of related documents. Related documents include emails and attachments; SQL records and Blobs; and files contained within zips.
RelevanceReturns the calculated relevance of this document compared to the other documents in the same result set. Ranges from 0 to 100, where 100 is most relevant. Read-Only.
RichImagesGives you access to the embedded images of a document, used when processing RichHTML documents.
SearchTermsReturns the search terms that appear in this document.
SourceTempFileReturns the temp files that the ISYS engine creates when opening a document. Read-Only.
TimestampReturns the document time stamp, checksum or generation counter. For file-based documents, this will usually be the date/time stamp from disk. Read-Only.
TitleReturns the title of the document. Document titles are configurable, as described in the online ISYS utilities users manual. Read-Only.
WordCountReturns the total number of words in the document. Read-Only.