Help > Web Development > Object Reference > Object Reference > ISYSDocumentDisplay > SetDisplayOptions Method
<a name="kanchor355"></a>ISYSDocumentDisplay:SetDisplayOptions Method
Set the options used when outputting the document text.

Syntax
[VBScript]
sub ISYSDocumentDisplay.SetDisplayOptions(_
  long Option, _ 
  string strText_ 
)
[C#]
void IISYSDocumentDisplay.SetDisplayOptions(
  long Option, 
  string strText
);
[ColdFusion/Java]
void IISYSDocumentDisplay.SetDisplayOptions(
  long Option, 
  java.lang.String strText
) throws ComException;
Parameters
OptionThe display option that you are setting
doBeforeHit0Text to display before each hit (except for the first)
doAfterHit1Text to display after each hit (except for the last)
doBeforeFirstHit2Text to display before the first hit
doAfterLastHit3Text to display after the last hit
doImageUrl4Text to emit to replace the path portion of an embedded image link. By default the path specifies a location on the local disk, but this lets you replace the path portion to transform the link into a URL
doBoldEnter5Text to display when bolded text is encountered
doBoldLeave6Text to display when leaving bolded area
doItalicEnter7Text to display when italic text is encountered
doItalicLeave8Text to display when leaving italic area
doUnderlineEnter9Text to display when underlined text is encountered
doUnderlineLeave10Text to display when leaving underline area
doParagraph11Text to display on a new paragraph
doAnnotation12Text to display for each annotation
doBeforeHitByTerm13Text to display before each hit, including term information allowing for different colors to be expressed.
doAfterHitByTerm14Text to display before each hit, including term information allowing for different colors to be expressed.
doBeforeFirstHitByTerm15Text to display before the first hit, including term information allowing for different colors to be expressed.
doAfterLastHitByTerm16Text to display before the last hit, including term information allowing for different colors to be expressed.
doFormFeed17
doLinkDetect18Enable/disable hyperlink detection in the document.
doImageDetect19Enable/disable image detection in the document.
doImageExtensions20Specify a semicolon separated list of image extensions to use during Image Detection.
doHideMetadata21Enable/disable the display of metadata at the top of the document during rendering.
doAnnotationInsert22Text to display where annotations can be inserted.
doEmailDetect23Enable/disable email address detection in the document.
doForceRichHTML24Force RichHTML conversion, even if the document was not indexed with RichHTML
doEntityEnter25Text to display before each entity
doEntityLeave26Text to display after each entity
strTextThe text for the option that is being set
%HIT%The number of the current hit
%NEXT_HIT%The number of the next hit
%PREV_HIT%The number of the previous hit
%LINE%The current line number
%COL%The current column number
%INDEX%Annotation Only - Indicates the index of the current annotation
%TEXT%Annotation Only - Indicates the text of the current annotation
%ENCODED_TEXT%Annotation Only - Indicates the encoded text of the current annotation, used to pass into javascript
%TYPE%Annotation Only - Indicates the type of the current annotation. (Note, Graphic, Hyperactivity, Query, Link)
%ENTITYINDEX%
%NEXTENTITYINDEX%
%ENTITYCORE%
%ENTITYNAME%
%ENTITYCOUNT%
%ENTITYTYPENAME%
%ENTITYTYPE%
%ENTITYID%
%ANCHOR%
%HIT_COLOR_FG%
%HIT_COLOR%
%PREV_TERM_HIT%
%NEXT_TERM_HIT%
%TERM_HIT_ID%
%TERM_HIT%
%TERM%

Examples
[VBScript]
<% set document = results.Item(i) set display = document.Display ' Setup Hit-to-Hit Navigation display.SetDisplayOption doBeforeHit, _ "<A NAME=""hit%HIT%""></A>" & _ "<A HREF=""#hit%PREV_HIT%""><IMG SRC=""images/back.gif"" border=""0"" align=""absmiddle""></A>" & _ "<span style=""background-color:#FFFF00"">" display.SetDisplayOption doAfterHit, _ "</SPAN><A HREF=""#hit%NEXT_HIT%""><IMG SRC=""images/next.gif"" border=""0"" align=""absmiddle""></A>" display.SetDisplayOption doBeforeFirstHit, _ "<A NAME=""hit%HIT%""></A><span style=""background-color:#FFFF00"">" display.SetDisplayOption doAfterLastHit, _ "</SPAN>" display.SetDisplayOption doParagraph, _ "<BR>" ' Annotation handling, show how to display an image and the annotation text display.SetDisplayOption doAnnotation, _ "<A HREF=""javascript:EditAnnotation(%INDEX%)"" " & _ "onmouseover=""javascript:AnnoHint(encode('%ENCODED_TEXT%'))"">" & _ "<IMG src=""images/annotation.gif"" id=""AnnotationImage%INDEX%"" border=""0"" align=""absmiddle"">" & _ "</A>" %> <%= display.AsHTML %>