> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/string/truefalseformat.md). # TrueFalseFormat Return Yes/No based on whether the input is true/false ## Method Signature ``` TrueFalseFormat(value=[any]) ``` ### Arguments | Argument | Type | Required | Description | Default | | -------- | ----- | -------- | --------------------------------------------------- | ------- | | `value` | `any` | `true` | The value to check for true/false and return Yes/No | | ## Examples ### Numeric 1 is interpreted as true [Run Example](https://try.boxlang.io/?code=eJwrKSpNdUvMKU51yy%2FKTSzRUDBU0LTmAgBfpgcc) ```java trueFalseFormat( 1 ); ``` Result: true ### Numeric 0 is interpreted as false [Run Example](https://try.boxlang.io/?code=eJwrKSpNdUvMKU51yy%2FKTSzRUDBQ0LTmAgBfoQcb) ```java trueFalseFormat( 0 ); ``` Result: false ### String representation of 1 is interpreted as true [Run Example](https://try.boxlang.io/?code=eJwrKSpNdUvMKU51yy%2FKTSzRUFAyVFLQtOYCAG4pB2A%3D) ```java trueFalseFormat( "1" ); ``` Result: true ### String representation of 0 is interpreted as false [Run Example](https://try.boxlang.io/?code=eJwrKSpNdUvMKU51yy%2FKTSzRUFAyUFLQtOYCAG4jB18%3D) ```java trueFalseFormat( "0" ); ``` Result: false ### YES is recognized as synonym for true as well [Run Example](https://try.boxlang.io/?code=eJwrKSpNdUvMKU51yy%2FKTSzRUFCKdA1WUtC05gIAgJ4IIA%3D%3D) ```java trueFalseFormat( "YES" ); ``` Result: true ### And NO as synonym for false [Run Example](https://try.boxlang.io/?code=eJwrKSpNdUvMKU51yy%2FKTSzRUFDy81dS0LTmAgB3fgfM) ```java trueFalseFormat( "NO" ); ``` Result: false ### An empty string results in false again [Run Example](https://try.boxlang.io/?code=eJwrKSpNdUvMKU51yy%2FKTSzRUFBSUtC05gIAZoQHLw%3D%3D) ```java trueFalseFormat( "" ); ``` Result: false ### Additional Examples ```java False: #trueFalseFormat( false )#
True: #trueFalseFormat( true )#
0: #trueFalseFormat( 0 )#
1: #trueFalseFormat( 1 )#
No: #trueFalseFormat( "No" )#
Yes: #trueFalseFormat( "Yes" )# ``` ## Related * [Ascii](/boxlang-language/reference/built-in-functions/string/ascii.md) * [CamelCase](/boxlang-language/reference/built-in-functions/string/camelcase.md) * [Char](/boxlang-language/reference/built-in-functions/string/char.md) * [CharsetDecode](/boxlang-language/reference/built-in-functions/string/charsetdecode.md) * [CharsetEncode](/boxlang-language/reference/built-in-functions/string/charsetencode.md) * [Compare](/boxlang-language/reference/built-in-functions/string/compare.md) * [CompareNoCase](/boxlang-language/reference/built-in-functions/string/comparenocase.md) * [Find](/boxlang-language/reference/built-in-functions/string/find.md) * [FindNoCase](/boxlang-language/reference/built-in-functions/string/findnocase.md) * [FindOneOf](/boxlang-language/reference/built-in-functions/string/findoneof.md) * [Insert](/boxlang-language/reference/built-in-functions/string/insert.md) * [JSStringFormat](/boxlang-language/reference/built-in-functions/string/jsstringformat.md) * [Justify](/boxlang-language/reference/built-in-functions/string/justify.md) * [KebabCase](/boxlang-language/reference/built-in-functions/string/kebabcase.md) * [LCase](/boxlang-language/reference/built-in-functions/string/lcase.md) * [Left](/boxlang-language/reference/built-in-functions/string/left.md) * [ListReduce](/boxlang-language/reference/built-in-functions/string/listreduce.md) * [LJustify](/boxlang-language/reference/built-in-functions/string/ljustify.md) * [LTrim](/boxlang-language/reference/built-in-functions/string/ltrim.md) * [Mid](/boxlang-language/reference/built-in-functions/string/mid.md) * [ParagraphFormat](/boxlang-language/reference/built-in-functions/string/paragraphformat.md) * [PascalCase](/boxlang-language/reference/built-in-functions/string/pascalcase.md) * [QueryStringToStruct](/boxlang-language/reference/built-in-functions/string/querystringtostruct.md) * [ReEscape](/boxlang-language/reference/built-in-functions/string/reescape.md) * [ReFind](/boxlang-language/reference/built-in-functions/string/refind.md) * [reFindNoCase](/boxlang-language/reference/built-in-functions/string/refindnocase.md) * [ReMatch](/boxlang-language/reference/built-in-functions/string/rematch.md) * [reMatchNoCase](/boxlang-language/reference/built-in-functions/string/rematchnocase.md) * [RemoveChars](/boxlang-language/reference/built-in-functions/string/removechars.md) * [RepeatString](/boxlang-language/reference/built-in-functions/string/repeatstring.md) * [Replace](/boxlang-language/reference/built-in-functions/string/replace.md) * [ReplaceList](/boxlang-language/reference/built-in-functions/string/replacelist.md) * [ReplaceListNoCase](/boxlang-language/reference/built-in-functions/string/replacelistnocase.md) * [ReplaceNoCase](/boxlang-language/reference/built-in-functions/string/replacenocase.md) * [ReReplace](/boxlang-language/reference/built-in-functions/string/rereplace.md) * [reReplaceNoCase](/boxlang-language/reference/built-in-functions/string/rereplacenocase.md) * [Reverse](/boxlang-language/reference/built-in-functions/string/reverse.md) * [Right](/boxlang-language/reference/built-in-functions/string/right.md) * [RJustify](/boxlang-language/reference/built-in-functions/string/rjustify.md) * [RTrim](/boxlang-language/reference/built-in-functions/string/rtrim.md) * [Slugify](/boxlang-language/reference/built-in-functions/string/slugify.md) * [SnakeCase](/boxlang-language/reference/built-in-functions/string/snakecase.md) * [SpanExcluding](/boxlang-language/reference/built-in-functions/string/spanexcluding.md) * [SpanIncluding](/boxlang-language/reference/built-in-functions/string/spanincluding.md) * [SQLPrettify](/boxlang-language/reference/built-in-functions/string/sqlprettify.md) * [StringBind](/boxlang-language/reference/built-in-functions/string/stringbind.md) * [StringEach](/boxlang-language/reference/built-in-functions/string/stringeach.md) * [StringEvery](/boxlang-language/reference/built-in-functions/string/stringevery.md) * [StringFilter](/boxlang-language/reference/built-in-functions/string/stringfilter.md) * [StringMap](/boxlang-language/reference/built-in-functions/string/stringmap.md) * [StringReduce](/boxlang-language/reference/built-in-functions/string/stringreduce.md) * [StringReduceRight](/boxlang-language/reference/built-in-functions/string/stringreduceright.md) * [StringSome](/boxlang-language/reference/built-in-functions/string/stringsome.md) * [StringSort](/boxlang-language/reference/built-in-functions/string/stringsort.md) * [StripCR](/boxlang-language/reference/built-in-functions/string/stripcr.md) * [Trim](/boxlang-language/reference/built-in-functions/string/trim.md) * [UCase](/boxlang-language/reference/built-in-functions/string/ucase.md) * [UCFirst](/boxlang-language/reference/built-in-functions/string/ucfirst.md) * [Val](/boxlang-language/reference/built-in-functions/string/val.md) * [Wrap](/boxlang-language/reference/built-in-functions/string/wrap.md) * [YesNoFormat](/boxlang-language/reference/built-in-functions/string/yesnoformat.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/string/truefalseformat.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.