gui.getNumberBoxFormatString

Returns the format string assigned to the number box.

Prototype

  1. sFormatString = gui.getNumberBoxFormatString ( hComponent )

Description

Format strings determine how the number will be displayed in the box when it is longer, bigger, smaller etc. than expected.

Parameters

hComponent - valid GUI component handle

Return values

sFormatString - format string

Available since ShiVa 2.0