HaruAnnotation::setHighlightMode

(PECL haru >= 0.0.1)

HaruAnnotation::setHighlightModeSet the highlighting mode of the annotation

Opis

HaruAnnotation::setHighlightMode ( int $mode ) : bool

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

Parametry

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.

Zwracane wartości

Returns TRUE on success.

Błędy/Wyjątki

Zgłasza wyjątek HaruException gdy wystąpi błąd.

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top