| <!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>assign - 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="assign"> |
| <meta property="og:locale" content="en_US"> |
| <meta property="og:url" content="http://example.com/ref_directive_assign.html"> |
| <link rel="canonical" href="http://example.com/ref_directive_assign.html"> |
| <link rel="icon" href="favicon.png" type="image/png"> |
| <link rel="stylesheet" type="text/css" href="docgen-resources/docgen.min.css?1594338519184"> |
| </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_assign.html"><span itemprop="name">assign</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><li><a href="api/index.html">API</a></li><li><a href="../index.html">Home</a></li></ul></div></div></div> <div class="main-content site-width"> |
| <div class="content-wrapper"> |
| <div id="table-of-contents-wrapper" class="col-left"> |
| <script>var breadcrumb = ["FreeMarker Manual","Reference","Directive Reference","assign"];</script> |
| <script src="toc.js?1594338519184"></script> |
| <script src="docgen-resources/main.min.js?1594338519184"></script> |
| </div> |
| <div class="col-right"><div class="page-content"><div class="page-title"><div class="pagers top"><a class="paging-arrow previous" href="ref_directive_escape.html"><span>Previous</span></a><a class="paging-arrow next" href="ref_directive_global.html"><span>Next</span></a></div><div class="title-wrapper"> |
| <h1 class="content-header header-section1" id="ref_directive_assign" itemprop="headline">assign</h1> |
| </div></div><div class="page-menu"> |
| <div class="page-menu-title">Page Contents</div> |
| <ul><li><a class="page-menu-link" href="#autoid_94" data-menu-target="autoid_94">Synopsis</a></li><li><a class="page-menu-link" href="#autoid_95" data-menu-target="autoid_95">Description</a></li></ul> </div><a name="ref.directive.assign"></a> |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_94">Synopsis</h2> |
| |
| |
| |
| <pre class="metaTemplate"> |
| <code class="inline-code"><#assign <em class="code-color">name</em>=<em class="code-color">value</em>></code> |
| or |
| <code class="inline-code"><#assign <em class="code-color">name1</em>=<em class="code-color">value1</em> <em class="code-color">name2</em>=<em class="code-color">value2</em> <em class="code-color">... nameN</em>=<em class="code-color">valueN</em>></code> |
| or |
| <code class="inline-code"><#assign <em class="code-color">same as above...</em> in <em class="code-color">namespacehash</em>></code> |
| or |
| <code class="inline-code"><#assign <em class="code-color">name</em>> |
| <em class="code-color">capture this</em> |
| </#assign></code> |
| or |
| <code class="inline-code"><#assign <em class="code-color">name</em> in <em class="code-color">namespacehash</em>> |
| <em class="code-color">capture this</em> |
| </#assign></code> |
| </pre> |
| |
| |
| <p>Where:</p> |
| |
| <ul> |
| <li> |
| <code class="inline-code"><em class="code-color">name</em></code>: name |
| of the variable. It is not expression. However, it can be |
| written as a string literal, which is useful if the variable |
| name contains reserved characters, for example |
| <code class="inline-code"><#assign "foo-bar" = 1></code>. Note that this |
| string literal does not expand interpolations (as |
| <code class="inline-code">"${foo}"</code>). |
| </li> |
| |
| <li> |
| <code class="inline-code"><em class="code-color">value</em></code>: the |
| value to store. Expression. |
| </li> |
| |
| <li> |
| <code class="inline-code"><em class="code-color">namespacehash</em></code>: |
| a hash that was created for a namespace (by <a href="ref_directive_import.html#ref.directive.import"><code>import</code></a>). |
| Expression. |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_95">Description</h2> |
| |
| |
| <p>With this you can create a new variable, or replace an |
| existing variable. Note that only top-level variables can be |
| created/replaced (i.e. you can't create/replace |
| <code class="inline-code">some_hash.subvar</code>, but |
| <code class="inline-code">some_hash</code>).</p> |
| |
| <p>For more information about variables, read this: <a href="dgui_misc_var.html">Template Author's Guide/Miscellaneous/Defining variables in the template</a></p> |
| |
| <p>Example: variable <code class="inline-code">seasons</code> will store a |
| sequence:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><#assign seasons = ["winter", "spring", "summer", "autumn"]></pre></div> |
| |
| <p>Example: Increments the numerical value stored in variable |
| <code class="inline-code">test</code>:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><#assign test = test + 1></pre></div> |
| |
| <p>As a convenience feature, you can do more assignments with one |
| <code class="inline-code">assign</code> tag. For example this will do the same as |
| the two previous examples:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><#assign |
| seasons = ["winter", "spring", "summer", "autumn"] |
| test = test + 1 |
| ></pre></div> |
| |
| <p>If you know what namespaces are: <code class="inline-code">assign</code> |
| directive creates variables in namespaces. Normally it creates the |
| variable in the current namespace (i.e. in the namespace associated |
| with the template where the tag is). However, if you use <code class="inline-code">in |
| <em class="code-color">namespacehash</em></code> then you can |
| create/replace a variable of another <a href="dgui_misc_namespace.html">namespace</a> than the current |
| namespace. For example, here you create/replace variable |
| <code class="inline-code">bgColor</code> of the namespace used for |
| <code class="inline-code">/mylib.ftl</code>:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><#import "/mylib.ftl" as my> |
| <#assign bgColor="red" in my></pre></div> |
| |
| <p>An extreme usage of <code class="inline-code">assign</code> is when it |
| captures the output generated between its start-tag and end-tag. |
| That is, things that are printed between the tags will not be shown |
| on the page, but will be stored in the variable. For example:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><#macro myMacro>foo</#macro> |
| <#assign x> |
| <#list 1..3 as n> |
| ${n} <@myMacro /> |
| </#list> |
| </#assign> |
| Number of words: ${x?word_list?size} |
| ${x}</pre></div> |
| |
| <p>will print:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-output">Number of words: 6 |
| 1 foo |
| 2 foo |
| 3 foo |
| </pre></div> |
| |
| <p>Please note that you should not to use this to insert |
| variables into strings:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><#assign x>Hello ${user}!</#assign> <#-- BAD PRACTICE! --></pre></div> |
| |
| <p>You should simply write:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><#assign x="Hello ${user}!"></pre></div> |
| <div class="bottom-pagers-wrapper"><div class="pagers bottom"><a class="paging-arrow previous" href="ref_directive_escape.html"><span>Previous</span></a><a class="paging-arrow next" href="ref_directive_global.html"><span>Next</span></a></div></div></div></div> </div> |
| </div> |
| <div class="site-footer"><div class="site-width"><div class="footer-top"><div class="col-left sitemap"></div><div class="col-right"><a class="xxe" href="http://www.xmlmind.com/xmleditor/" rel="nofollow" title="Edited with XMLMind XML Editor"><span>Edited with XMLMind XML Editor</span></a></div></div><div class="footer-bottom"> <p class="last-generated"> |
| Last generated: |
| <time itemprop="dateModified" datetime="2020-07-09T23:48:39Z" title="Thursday, July 9, 2020 11:48:39 PM GMT">2020-07-09 23:48:39 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> |