HaruAnnotation::setHighlightMode

(PECL haru >= 0.0.1)
Set the highlighting mode of the annotation
bool HaruAnnotation::setHighlightMode ( int $mode )

Defines the appearance of the annotation when clicked. This function may be used with link annotations only.

Parameters:
mode

The highlighting mode of the annotation. Can take only these values:

  • HaruAnnotation::NO_HIGHLIGHT - no highlighting.
  • HaruAnnotation::INVERT_BOX - invert the contents of the annotation.
  • HaruAnnotation::INVERT_BORDER - invert the border of the annotation.
  • HaruAnnotation::DOWN_APPEARANCE - dent the annotation.
Returns:

Returns TRUE on success.

Exception:

Throws a HaruException on error.

doc_php
2016-02-24 16:03:34
Comments
Leave a Comment

Please login to continue.