gui.setNumberBoxFormatString

Assigns a format string to a number box.

Prototype

  1. bOk = gui.setNumberBoxFormatString ( hComponent, sFormatString )

Description

Format strings determine how the number will be displayed in the box when it is longer, bigger, smaller etc. than expected. sFormatString follows the c-style sprint rules and needs to contain at least a %d, but the precision will be ignored. If you want a precision of 2, you will have to set %.2d

Parameters

hComponent - valid GUI component handle
sFormatString - format string

Return values

bOk - true on success

Available since ShiVa 2.0