PHP Dokumentation: Function haruannotation-sethighlightmode
12. Januar 2010 von werner
HaruAnnotation::setHighlightMode
(PECL haru >= 0.0.1)
HaruAnnotation::setHighlightMode — Set the highlighting mode of the annotation
Beschreibung
bool HaruAnnotation::setHighlightMode ( int $mode )
Defines the appearance of the annotation when clicked. This function may be used with link annotations only.
Parameter-Liste
- 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.
Rückgabewerte
Returns TRUE on success.
Fehler/Exceptions
Throws a HaruException on error.