HaruAnnotation::setHighlightMode

(PECL haru >= 0.0.1)

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

Descrierea

HaruAnnotation::setHighlightMode ( int $mode ) : bool

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

Parametri

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.

Valorile întoarse

Returns TRUE on success.

Erori/Excepții

Emite un HaruException în caz de eroare.