HaruAnnotation::setHighlightMode

(PECL haru >= 0.0.1)

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

说明

HaruAnnotation::setHighlightMode ( int $mode ) : bool

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

参数

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 TRUE on success.

错误／异常

发生错误时抛出 HaruException 异常。