{"id":1363,"date":"2008-09-11T03:45:55","date_gmt":"2008-09-11T08:45:55","guid":{"rendered":"http:\/\/www.mrc-productivity.com\/docs\/?page_id=1363"},"modified":"2023-09-26T13:11:30","modified_gmt":"2023-09-26T18:11:30","slug":"string-functions-within-freemarker","status":"publish","type":"ht_kb","link":"https:\/\/www.mrc-productivity.com\/docs\/knowledge-base\/string-functions-within-freemarker","title":{"rendered":"String Functions within Freemarker"},"content":{"rendered":"\n

Overview<\/h2>\n\n\n\n

There are many String Manipulation tools available to you within Freemarker. Often times, adding these Freemarker options will save you time, give you greater flexibility as a developer, and make your applications even more robust. To add these functions, simply open m-Painter and right click on the Field you wish to modify. Select the “User Interface” option and then “Edit Element”. Add the String Function into editor box in the correct location as desired. When completed, hit OK. Then be sure to save your application.<\/p>\n\n\n\n

Here is a list of many common and useful String Functions available to you within Freemarker Logic.<\/p>\n\n\n\n

Sub-stringing<\/strong><\/h4>\n\n\n\n

While you can sub-string as a calculation, you can also sub-string using Freemarker. An example of its usefulness would be sub-stringing a portion of a common field.<\/p>\n\n\n\n

Please remember that the 1st character of your string is the 0 position. If my ${row.CITY}<\/code> equals “CHICAGO”, the following expressions would give these results<\/p>\n\n\n\n

Freemarker Code<\/th>Result<\/th><\/tr>
${row.CITY?substring(1)}<\/code><\/td>HICAGO<\/td><\/tr>
${row.CITY?substring(3)}<\/code><\/td>CAGO<\/td><\/tr>
${row.CITY?substring(0,1)}<\/code><\/td>C<\/td><\/tr>
${row.CITY?substring(0,3)}<\/code><\/td>CHI<\/td><\/tr>
${row.CITY?substring(2,3)}<\/code><\/td>I<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Capitalize First Letter<\/strong><\/h4>\n\n\n\n

The function ${row.FIELD?cap_first}<\/code> will capitalize the first letter of your field if it is lower case. All other letters are ignored.<\/p>\n\n\n\n

Un-Capitalize First Letter<\/strong><\/h4>\n\n\n\n

This function is the exact opposite of the one listed above, and the function and is written ${row.FIELD?uncap_first}<\/code>.<\/p>\n\n\n\n

Capitalize<\/strong><\/h4>\n\n\n\n

This function will capitalize the first letter in all words and un-capitalize all other letters. This function is denoted ${row.FIELD?capitalize}<\/code><\/p>\n\n\n\n

For instance, a normal output of “LOS ANGELES” would output “Los Angeles” with the ?capitalize freemarker function.<\/p>\n\n\n\n

Upper Case<\/strong><\/h4>\n\n\n\n

This function will capitalize all letters within a string. It is noted as ${row.FIELD?upper_case}<\/code>.<\/p>\n\n\n\n

If you are in a Maintenance application and trying to ensure upper case from the user, please use the “Do not Allow Lower Case” option from the Pre-format Level.<\/p>\n\n\n\n

Lower Case<\/strong><\/h4>\n\n\n\n

This function will un-capitalize all letters within a string. It is noted as ${row.FIELD?lower_case}<\/code>.<\/p>\n\n\n\n

HTML<\/strong><\/h4>\n\n\n\n

This function will encode all fields for use within an HTML page. For instance, if your field contains an “&” it will be encoded to the HTML version of the ampersand “&amp;”. This guarantees that the browser will handle all fields correctly. This is the default encoding for all generated fields with m-Power. It is noted as ${row.FIELD?html}<\/code>.<\/p>\n\n\n\n

URL<\/strong><\/h4>\n\n\n\n

This function will encode all fields for use within an HTML’s URL. For instance, if your field contains an “#” it will be encoded to the URL version of the pound sign “%23;”. This guarantees that the browser will handle all fields correctly when being passed along the URL. This is the default encoding for all fields that a user selects through the Hyperlink Wizard within m-Painter. It is noted as ${row.FIELD?url}<\/code>.<\/p>\n\n\n\n

Trim<\/strong><\/h4>\n\n\n\n

The Freemarker Trim function will remove all leading and trailing spaces from a field. It is denoted: ${row.FIELD?trim}<\/code><\/p>\n\n\n\n

Length<\/strong><\/h4>\n\n\n\n

The Freemarker Length function will return the number of characters in the field. It is denoted: ${row.FIELD?length}<\/code><\/p>\n\n\n\n

Replace<\/strong><\/h4>\n\n\n\n

This is a very useful Freemarker function as it allows you to replace a certain value directly within your field. It is denoted:<\/p>\n\n\n\n

${row.FIELD?replace(\"FINDTHISTEXT\", \"REPLACEWITHTHISTEXT\")}<\/code><\/p>\n\n\n\n

For example, if my Field value was CHICAGO, and my function looked like this:<\/p>\n\n\n\n

${row.FIELD?replace(\"CAGO\", \"NA TOWN\")}<\/code><\/p>\n\n\n\n

My output would be “CHINA TOWN”. This is just an abbreviated list showing the most common Freemarker String Functions. A full list can be found here<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"

Overview There are many String Manipulation tools available to you within Freemarker. Often times, adding these Freemarker options will save you time, give you greater flexibility as a developer, and make your applications even more robust. To add these functions, simply open m-Painter and right click on the Field you…<\/p>\n","protected":false},"author":1,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[265],"ht-kb-tag":[],"class_list":["post-1363","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-freemarker"],"_links":{"self":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/1363","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/comments?post=1363"}],"version-history":[{"count":6,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/1363\/revisions"}],"predecessor-version":[{"id":13202,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/1363\/revisions\/13202"}],"wp:attachment":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/media?parent=1363"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb-category?post=1363"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb-tag?post=1363"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}