BFormat (Baja Format) Property Usage


In NiagaraAX, many properties that allow text entry use the Baja data type “BFormat,” which is a class that enables localization (foreign language support), among other things.

NoteLocalization is not addressed in this document, which describes only English language applications.

In Workbench property sheets or dialogs, such properties are conspicuous by a yellow “question” button, which produces a popup Format help window, with the Bajadoc description for BFormat (Figure 1).

Figure 1. Format property help popup in Workbench


Format property help popup in Workbench


This help popup may be useful if you are a NiagaraAX developer or someone already familiar with the class structures used in NiagaraAX, but may otherwise leave you confused. Also, there is no “context awareness”— the same help is shown for any property typed as BFormat. Obviously, there are many different ways you can use the “scripting” calls (inside “%” characters, with “.” dot operator) to format text in these properties.

This document provides a few usage examples, but is not a reference. The main sections are: