Home > PHP > Function > > HaruAnnotation::setHighlightMode()

HaruAnnotation::setHighlightMode()

HaruAnnotation::setHighlightMode - Set the highlighting mode of the annotation

Syntax

bool HaruAnnotation::setHighlightMode (int $mode)

Arguments

  • 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.

Description

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

Version

PHP PECL haru >= 0.0.1

Return value

Returns TRUE on success.