Archive site for Autodesk Ecotect Analysis educational resources, notes and tutorials



WizardMaker/Interactive Edits

In order to allow users of your wizard to interactively enter numeric values using the mouse wheel and/or the PageUp & PageDown keys, you need to assign each such TEdit control a units category or display format.

Entering a format.

You assign formats within the ImeName property of the edit box. This can be found within the property editor to the right of the wizard in the DESIGN page. The assignment itself comprises an initial format specifier followed by optional parameters to define the base increment value as well as the minimum and maximum allowed values.

The initial format specifier always starts with a percentage (%) character and can contain either a units category identifier or a printf format string in the following format:

%format [inc [min [max]]] 

The square brackets indicate the additional parameters are optional. You can find details on printf format specifiers at the cpp-reference-printf website. However, because the data will always be sent as a floating point value, you can only use the %f, %g and %G variants.

Available Units Categories

If you use a units category identifier, the exact units displayed will be determined by the user's preferences setting. Any data input by the user will be converted back to standard SI values when you call its get.wizard.PageX.EditX.Text or get.wizard.PageX.EditX.Value properties.

The following units category identifiers are available. Whilst, in most cases, only the first three non-numeric characters are used to identify the units, is is good practice to include the full name for the benefit of others examining your wizard (i.e.: %dimension, %conductance, illuminance, etc).

token units
%0.1f See printf.
%angle Angle units
%area Area units
%conductivity Thermal Conductivity units
%conductance Thermal Conductance units
%density Density units
%dimension Dimension values
%distance Distance units
%energy Energy units
%flowrate Fluid flow units
%gains Heat/Energy Gains units
%illuminance Illuminance units
%incidence Incident radiation/energy units
%luminance Luminance units
%power Power units
%resistance Thermal Resistance units
%specificheat Specific Heat units
%temperature Temperature units
%velocity Velocity units
%volume Volume units
%weight Weight units

Setting Default Values

When using a default value in the TEdit box at design time, make sure you include its units abbreviation. This way, the default value will be properly converted to and displayed in the user's prefered units. Thus, to specify a default value of one meter, enter either 1m, 1000.0mm or 3' 3" 3/8. To specify a weight, use 15.1lb or 6.849kg.

For a full list of all the available units as well as their abbreviations and conversion factors, see the Units Conversions page.

Examples

To display a formatted dimension values within a TEdit control, simply use the %dimension specifier. Then, when opened in ECOTECT, it will display with whatever units the user has selected.

%dimension

To specify an angle between 0 and 180 degrees with an increment of 5, use:

%angle 5 0 180

To specify an arbitraty number with two decimal places between 0 and 4 with an increment of 0.1, use:

%0.2f 0.1 0.0 4.00 


WizardMaker
WizardMaker/User Scripts

HOW WOULD YOU RATE THIS PAGE/DEFINITION ?

No votes yet


Navigation

User login

Translate Site To: