Skip navigation links
com.groupdocs.search.options

Class HighlightOptions

    • Constructor Detail

      • HighlightOptions

        public HighlightOptions()
        Initializes a new instance of the HighlightOptions class.

    • Method Detail

      • getTermsBefore

        public final int getTermsBefore()
        Gets the maximum number of words in a text snippet before highlighted word. The value must be in the range from 0 to 10000. The default value is 7.
        Returns:
        The maximum number of words in a text snippet before highlighted word.

      • setTermsBefore

        public final void setTermsBefore(int value)
        Sets the maximum number of words in a text snippet before highlighted word. The value must be in the range from 0 to 10000. The default value is 7.
        Parameters:
        value - The maximum number of words in a text snippet before highlighted word.

      • getTermsAfter

        public final int getTermsAfter()
        Gets the maximum number of words in a text snippet after highlighted word. The value must be in the range from 0 to 10000. The default value is 7.
        Returns:
        The maximum number of words in a text snippet after highlighted word.

      • setTermsAfter

        public final void setTermsAfter(int value)
        Sets the maximum number of words in a text snippet after highlighted word. The value must be in the range from 0 to 10000. The default value is 7.
        Parameters:
        value - The maximum number of words in a text snippet after highlighted word.

      • getTermsTotal

        public final int getTermsTotal()
        Gets the maximum number of words in a text snippet. The value must be in the range from 0 to 10000. The default value is 21.
        Returns:
        The maximum number of words in a text snippet.

      • setTermsTotal

        public final void setTermsTotal(int value)
        Sets the maximum number of words in a text snippet. The value must be in the range from 0 to 10000. The default value is 21.
        Parameters:
        value - The maximum number of words in a text snippet.

      • getUseInlineStyles

        public final boolean getUseInlineStyles()
        Gets a value indicating whether inline styles are used to highlight occurrences. The default value is true.
        Returns:
        A value indicating whether inline styles are used to highlight occurrences.

      • setUseInlineStyles

        public final void setUseInlineStyles(boolean value)
        Sets a value indicating whether inline styles are used to highlight occurrences. The default value is true.
        Parameters:
        value - A value indicating whether inline styles are used to highlight occurrences.

      • getHighlightColor

        public final Color getHighlightColor()
        Gets a color that is used to highlight occurrences. The default value is #FFD800.
        Returns:
        A color that is used to highlight occurrences.

      • setHighlightColor

        public final void setHighlightColor(Color value)
        Sets a color that is used to highlight occurrences. The default value is #FFD800.
        Parameters:
        value - A color that is used to highlight occurrences.

      • getTermHighlightStartTag

        public final String getTermHighlightStartTag()
        Gets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.
        Returns:
        The start tag of the highlighting of the found word.

      • setTermHighlightStartTag

        public final void setTermHighlightStartTag(String value)
        Sets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.
        Parameters:
        value - The start tag of the highlighting of the found word.

      • getTermHighlightEndTag

        public final String getTermHighlightEndTag()
        Gets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.
        Returns:
        The end tag of the highlighting of the found word.

      • setTermHighlightEndTag

        public final void setTermHighlightEndTag(String value)
        Sets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.
        Parameters:
        value - The end tag of the highlighting of the found word.