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.