blob: f28dde6f94673f2c31f0df91221a668a3830a4fc [file] [log] [blame]
<!doctype html>
<!-- Generated by FreeMarker/Docgen from DocBook -->
<html lang="en" class="page-type-section">
<head prefix="og: http://ogp.me/ns#">
<meta charset="utf-8">
<title>if, else, elseif - FreeMarker Manual</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="format-detection" content="telephone=no">
<meta property="og:site_name" content="FreeMarker Manual">
<meta property="og:title" content="if, else, elseif">
<meta property="og:locale" content="en_US">
<meta property="og:url" content="http://example.com/ref_directive_if.html">
<link rel="canonical" href="http://example.com/ref_directive_if.html">
<link rel="icon" href="favicon.png" type="image/png">
<link rel="stylesheet" type="text/css" href="docgen-resources/docgen.min.css?1594338517553">
</head>
<body itemscope itemtype="https://schema.org/Code">
<meta itemprop="url" content="http://example.com/">
<meta itemprop="name" content="FreeMarker Manual">
<!--[if lte IE 9]>
<div style="background-color: #C00; color: #fff; padding: 12px 24px;">Please use a modern browser to view this website.</div>
<![endif]--><div class="header-top-bg"><div class="site-width header-top"><a class="logo" href="http://example.com" role="banner"> <img itemprop="image" src="logo.png" alt="My Logo">
</a></div></div><div class="header-bottom-bg"><div class="site-width search-row"><a href="index.html" class="navigation-header">FreeMarker Manual</a><div class="navigation-header"></div></div><div class="site-width breadcrumb-row"><ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><li class="step-0" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="index.html"><span itemprop="name">FreeMarker Manual</span></a></li><li class="step-1" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref.html"><span itemprop="name">Reference</span></a></li><li class="step-2" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref_directives.html"><span itemprop="name">Directive Reference</span></a></li><li class="step-3" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref_directive_if.html"><span itemprop="name">if, else, elseif</span></a></li></ul><div class="bookmarks" title="Bookmarks"><span class="sr-only">Bookmarks:</span><ul class="bookmark-list"><li><a href="alphaidx.html">Index</a></li><li><a href="gloss.html">Glossary</a></li><li><a href="ref.html">Reference</a></li><li><a href="app_faq.html">FAQ</a></li><li><a href="preface.html#test_target">Bőregér</a></li></ul></div></div></div> <div class="main-content site-width">
<div class="content-wrapper no-toc">
<div id="table-of-contents-wrapper" class="col-left">
</div>
<div class="col-right"><div class="page-content"><div class="page-title"><div class="pagers top"><a class="paging-arrow previous" href="ref_directives.html"><span>Previous</span></a><a class="paging-arrow next" href="ref_directive_switch.html"><span>Next</span></a></div><div class="title-wrapper">
<h1 class="content-header header-section1" id="ref_directive_if" itemprop="headline">if, else, elseif</h1>
</div></div><div class="page-menu">
<div class="page-menu-title">Page Contents</div>
<ul><li><a class="page-menu-link" href="#autoid_78" data-menu-target="autoid_78">Synopsis</a></li><li><a class="page-menu-link" href="#autoid_79" data-menu-target="autoid_79">Description</a></li></ul> </div><a name="ref.directive.if"></a><a name="ref.directive.else"></a><a name="ref.directive.elseif"></a>
<h2 class="content-header header-section2" id="autoid_78">Synopsis</h2>
<pre class="metaTemplate">
<code class="inline-code">&lt;#if <em class="code-color">condition</em>&gt;
<em class="code-color">...</em>
&lt;#elseif <em class="code-color">condition2</em>&gt;
<em class="code-color">...</em>
&lt;#elseif <em class="code-color">condition3</em>&gt;
<em class="code-color">...</em>
<em class="code-color">...</em>
&lt;#else&gt;
<em class="code-color">...</em>
&lt;/#if&gt;</code>
</pre>
<p>Where:</p>
<ul>
<li>
<code class="inline-code"><em class="code-color">condition</em></code>,
<code class="inline-code"><em class="code-color">condition2</em></code>,
...etc.: Expression evaluates to a boolean value.
</li>
</ul>
<h2 class="content-header header-section2" id="autoid_79">Description</h2>
<p>You can use <code class="inline-code">if</code>, <code class="inline-code">elseif</code>
and <code class="inline-code">else</code> directives to conditionally skip a
section of the template. The
<code class="inline-code"><em class="code-color">condition</em></code>-s must
evaluate to a boolean value, or else an error will abort template
processing. The <code class="inline-code">elseif</code>-s and
<code class="inline-code">else</code>-s must occur inside <code class="inline-code">if</code>
(that is, between the <code class="inline-code">if</code> start-tag and end-tag).
The <code class="inline-code">if</code> can contain any number of
<code class="inline-code">elseif</code>-s (including 0) and at the end optionally
one <code class="inline-code">else</code>. Examples:</p>
<p><code class="inline-code">if</code> with 0 <code class="inline-code">elseif</code> and no
<code class="inline-code">else</code>:</p>
<div class="code-wrapper"><pre class="code-block code-template">&lt;#if x == 1&gt;
x is 1
&lt;/#if&gt;</pre></div>
<p><code class="inline-code">if</code> with 0 <code class="inline-code">elseif</code> and
<code class="inline-code">else</code>:</p>
<div class="code-wrapper"><pre class="code-block code-template">&lt;#if x == 1&gt;
x is 1
&lt;#else&gt;
x is not 1
&lt;/#if&gt;</pre></div>
<p><code class="inline-code">if</code> with 2 <code class="inline-code">elseif</code> and no
<code class="inline-code">else</code>:</p>
<div class="code-wrapper"><pre class="code-block code-template">&lt;#if x == 1&gt;
x is 1
&lt;#elseif x == 2&gt;
x is 2
&lt;#elseif x == 3&gt;
x is 3
&lt;/#if&gt;</pre></div>
<p><code class="inline-code">if</code> with 3 <code class="inline-code">elseif</code> and
<code class="inline-code">else</code>:</p>
<div class="code-wrapper"><pre class="code-block code-template">&lt;#if x == 1&gt;
x is 1
&lt;#elseif x == 2&gt;
x is 2
&lt;#elseif x == 3&gt;
x is 3
&lt;#elseif x == 4&gt;
x is 4
&lt;#else&gt;
x is not 1 nor 2 nor 3 nor 4
&lt;/#if&gt;</pre></div>
<p>To see more about boolean expressions, see: <a href="dgui_template_exp.html">Template Author&#39;s Guide/The Template/Expressions</a>.</p>
<p>You can nest <code class="inline-code">if</code> directives (of
course):</p>
<div class="code-wrapper"><pre class="code-block code-template">&lt;#if x == 1&gt;
x is 1
&lt;#if y == 1&gt;
and y is 1 too
&lt;#else&gt;
but y is not
&lt;/#if&gt;
&lt;#else&gt;
x is not 1
&lt;#if y &lt; 0&gt;
and y is less than 0
&lt;/#if&gt;
&lt;/#if&gt;</pre></div>
<div class="callout note">
<strong class="callout-label">Note:</strong>
<p>How to test if x is greater than 1? <code class="inline-code">&lt;#if x &gt;
1&gt;</code> will be <em>wrong</em>, as FreeMarker
will interpret the first <code class="inline-code">&gt;</code> as the end of the
tag. Thus, either write <code class="inline-code">&lt;#if (x &gt; 1)&gt;</code>
or <code class="inline-code">&lt;#if x &amp;gt; 1&gt;</code>.</p>
</div>
<div class="bottom-pagers-wrapper"><div class="pagers bottom"><a class="paging-arrow previous" href="ref_directives.html"><span>Previous</span></a><a class="paging-arrow next" href="ref_directive_switch.html"><span>Next</span></a></div></div></div></div> </div>
</div>
<div class="site-footer"><div class="site-width"><div class="footer-bottom"> <p class="last-generated">
Last generated:
<time itemprop="dateModified" datetime="2020-07-09T23:48:37Z" title="Thursday, July 9, 2020 11:48:37 PM GMT">2020-07-09 23:48:37 GMT</time> </p>
<p class="copyright">
© <span itemprop="copyrightYear">1999</span>–2020
<a itemtype="http://schema.org/Organization" itemprop="copyrightHolder" href="https://apache.org/">The Apache Software Foundation</a> </p>
</div></div></div></body>
</html>