<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set the highlighting mode of the annotation</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="haruannotation.setborderstyle.html">HaruAnnotation::setBorderStyle</a></div>
<div class="next" style="text-align: right; float: right;"><a href="haruannotation.seticon.html">HaruAnnotation::setIcon</a></div>
<div class="up"><a href="class.haruannotation.html">HaruAnnotation</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="haruannotation.sethighlightmode" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruAnnotation::setHighlightMode</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruAnnotation::setHighlightMode</span> — <span class="dc-title">Set the highlighting mode of the annotation</span></p>
</div>
<div class="refsect1 description" id="refsect1-haruannotation.sethighlightmode-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>HaruAnnotation::setHighlightMode</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span>
)</div>
<p class="para rdfs-comment">
Defines the appearance of the annotation when clicked.
This function may be used with link annotations only.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-haruannotation.sethighlightmode-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The highlighting mode of the annotation. Can take only these values:
<ul class="simplelist">
<li class="member">
<strong><code>HaruAnnotation::NO_HIGHLIGHT</code></strong> - no
highlighting.
</li>
<li class="member">
<strong><code>HaruAnnotation::INVERT_BOX</code></strong> - invert the contents
of the annotation.
</li>
<li class="member">
<strong><code>HaruAnnotation::INVERT_BORDER</code></strong> - invert the
border of the annotation.
</li>
<li class="member">
<strong><code>HaruAnnotation::DOWN_APPEARANCE</code></strong> - dent the
annotation.
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-haruannotation.sethighlightmode-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-haruannotation.sethighlightmode-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.html" class="classname">HaruException</a> on error.</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="haruannotation.setborderstyle.html">HaruAnnotation::setBorderStyle</a></div>
<div class="next" style="text-align: right; float: right;"><a href="haruannotation.seticon.html">HaruAnnotation::setIcon</a></div>
<div class="up"><a href="class.haruannotation.html">HaruAnnotation</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
