formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Templates

# fz_fuim_format_float_enum

Description

Format types for a floating point variable displayed in a text field. This enum is used as a parameter for any of the floating point number set range API functions. It determines how a variable's value is displayed in a dialog.

enum fz_fuim_format_float_enum {

FZ_FUIM_FORMAT_FLOAT_DEFAULT,

FZ_FUIM_FORMAT_FLOAT_DISTANCE,

FZ_FUIM_FORMAT_FLOAT_ANGLE,

FZ_FUIM_FORMAT_FLOAT_PERCENT,

FZ_FUIM_FORMAT_FLOAT_CURRENCY_NATIVE,

FZ_FUIM_FORMAT_FLOAT_AREA_SQIN,

FZ_FUIM_FORMAT_FLOAT_AREA_SQFT,

FZ_FUIM_FORMAT_FLOAT_AREA_SQYD,

FZ_FUIM_FORMAT_FLOAT_AREA_ACRE,

FZ_FUIM_FORMAT_FLOAT_AREA_SQMI,

FZ_FUIM_FORMAT_FLOAT_AREA_SQMM,

FZ_FUIM_FORMAT_FLOAT_AREA_SQCM,

FZ_FUIM_FORMAT_FLOAT_AREA_SQMT,

FZ_FUIM_FORMAT_FLOAT_AREA_SQKM,

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUIN,

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUFT,

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUYD,

FZ_FUIM_FORMAT_FLOAT_VOLUME_GAL,

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUMM,

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUCM,

FZ_FUIM_FORMAT_FLOAT_VOLUME_LITR,

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUMT,

FZ_FUIM_FORMAT_FLOAT_WEIGHT_OZ,

FZ_FUIM_FORMAT_FLOAT_WEIGHT_LBS,

FZ_FUIM_FORMAT_FLOAT_WEIGHT_ETON,

FZ_FUIM_FORMAT_FLOAT_WEIGHT_G,

FZ_FUIM_FORMAT_FLOAT_WEIGHT_KG,

FZ_FUIM_FORMAT_FLOAT_WEIGHT_MTON,

FZ_FUIM_FORMAT_FLOAT_DURATION_SECONDS,

FZ_FUIM_FORMAT_FLOAT_DURATION_HMS,

FZ_FUIM_FORMAT_FLOAT_DURATION_ANIM_DEFAULT };

Members

FZ_FUIM_FORMAT_FLOAT_DEFAULT

The floating point value is displayed as a fraction, with the whole and fractional part of the number separated by a decimal point.

FZ_FUIM_FORMAT_FLOAT_DISTANCE

The floating point value is displayed as a distance value. The ultimate format is determined by the setting in the Working Units dialog. For example, when English units are selected the default linear distances are displayed with the feet and inch notation.

FZ_FUIM_FORMAT_FLOAT_ANGLE

The floating point value is displayed as an angle. The variable's value is expected to be in radians. The display of an angle is shown in degrees in the text field.

FZ_FUIM_FORMAT_FLOAT_PERCENT

The floating point value is displayed as a percentage value. That is, the variable's value is multiplied by 100 before it is displayed in the text field. This allows a value to be stored in a variable in a normalized range (0.0 to 1.0) but display it to the user as a percentage (0.0 to 100.0).

FZ_FUIM_FORMAT_FLOAT_CURRENCY_NATIVE

The floating point value is displayed as a currency, formatted according to the language setting of the operating .

FZ_FUIM_FORMAT_FLOAT_AREA_SQIN

The floating point value is displayed as an area value, converted to and formatted as square inches. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_AREA_SQFT

The floating point value is displayed as an area value, converted to and formatted as square feet. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_AREA_SQYD

The floating point value is displayed as an area value, converted to and formatted as square yards. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_AREA_ACRE

The floating point value is displayed as an area value, converted to and formatted as acres. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_AREA_SQMI

The floating point value is displayed as an area value, converted to and formatted as square miles. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_AREA_SQMM

The floating point value is displayed as an area value, converted to and formatted as square millimeters. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_AREA_SQCM

The floating point value is displayed as an area value, converted to and formatted as square centimeters. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_AREA_SQMT

The floating point value is displayed as an area value, converted to and formatted as square meters. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_AREA_SQKM

The floating point value is displayed as an area value, converted to and formatted as square kilometers. The floating point value is assumed to represent square inches in an English project or square centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUIN

The floating point value is displayed as a volumetric value, converted to and formatted as cubic inches. The floating point value is assumed to represent cubic inches in an English project or cubic centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUFT

The floating point value is displayed as a volumetric value, converted to and formatted as cubic feet. The floating point value is assumed to represent cubic inches in an English project or cubic centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUYD

The floating point value is displayed as a volumetric value, converted to and formatted as cubic yards. The floating point value is assumed to represent cubic inches in an English project or cubic centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_VOLUME_GAL

The floating point value is displayed as a volumetric value, converted to and formatted as gallons. The floating point value is assumed to represent cubic inches in an English project or cubic centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUMM

The floating point value is displayed as a volumetric value, converted to and formatted as cubic millimeters. The floating point value is assumed to represent cubic inches in an English project or cubic centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUCM

The floating point value is displayed as a volumetric value, converted to and formatted as cubic centimeters. The floating point value is assumed to represent cubic inches in an English project or cubic centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_VOLUME_LITR

The floating point value is displayed as a volumetric value, converted to and formatted as liters (cubic decimeter). The floating point value is assumed to represent cubic inches in an English project or cubic centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_VOLUME_CUMT

The floating point value is displayed as a volumetric value, converted to and formatted as cubic meters. The floating point value is assumed to represent cubic inches in an English project or cubic centimeters in a metric project.

FZ_FUIM_FORMAT_FLOAT_WEIGHT_OZ

The floating point value is displayed as a weight value, converted to and formatted as ounces. The floating point value is assumed to represent grams.

FZ_FUIM_FORMAT_FLOAT_WEIGHT_LBS

The floating point value is displayed as a weight value, converted to and formatted as pounds (16 ounces). The floating point value is assumed to represent grams.

FZ_FUIM_FORMAT_FLOAT_WEIGHT_ETON

The floating point value is displayed as a weight value, converted to and formatted as English tons. The floating point value is assumed to represent grams.

FZ_FUIM_FORMAT_FLOAT_WEIGHT_G

The floating point value is displayed as a weight value, converted to and formatted as grams. The floating point value is assumed to represent grams.

FZ_FUIM_FORMAT_FLOAT_WEIGHT_KG

The floating point value is displayed as a weight value, converted to and formatted as kilo grams. The floating point value is assumed to represent grams.

FZ_FUIM_FORMAT_FLOAT_WEIGHT_MTON

The floating point value is displayed as a weight value, converted to and formatted as metric tons. The floating point value is assumed to represent grams.

FZ_FUIM_FORMAT_FLOAT_DURATION_SECONDS

The floating point value is displayed as a time value. The variable's value is expected to be in seconds. The display of the duration is shown as seconds.

FZ_FUIM_FORMAT_FLOAT_DURATION_HMS

The floating point value is displayed as a time value. The variable's value is expected to be in seconds. The display of the duration is shown as hours:minutes:seconds.

FZ_FUIM_FORMAT_FLOAT_DURATION_ANIM_DEFAULT

The floating point value is displayed as a time value. The variable's value is expected to be in seconds. The display of the duration is shown according to the animatio ndefault settings of the current project.

Availability

5.0.0.0

See Also

fz_fuim_format_int_enum, fz_fuim_item_range_double, fz_fuim_item_range_float, fz_fuim_new_text_info_double, fz_fuim_new_text_info_float, fz_shdr_set_flt_parm

Defined in

fz_fuim_api.h