4D v14.3
OBJECT Get format
- 4D Language Reference
-
- Objects (Forms)
-
- Object Properties
- GET STYLE SHEET INFONew
- LIST OF STYLE SHEETSNew
- OBJECT DUPLICATE
- OBJECT Get actionNew
- OBJECT Get auto spellcheck
- OBJECT GET BEST SIZE
- OBJECT Get border styleNew
- OBJECT Get context menuNew
- OBJECT GET COORDINATES
- OBJECT Get data sourceNew
- OBJECT GET DRAG AND DROP OPTIONS
- OBJECT Get enabled
- OBJECT Get enterable
- OBJECT GET EVENTSNew
- OBJECT Get filter
- OBJECT Get focus rectangle invisible
- OBJECT Get font
- OBJECT Get font size
- OBJECT Get font style
- OBJECT Get format
- OBJECT Get help tip
- OBJECT Get horizontal alignment
- OBJECT Get indicator typeNew
- OBJECT Get keyboard layout
- OBJECT Get list nameUpd
- OBJECT Get list referenceNew
- OBJECT GET MAXIMUM VALUENew
- OBJECT GET MINIMUM VALUENew
- OBJECT Get multilineNew
- OBJECT Get placeholderNew
- OBJECT GET PRINT VARIABLE FRAMENew
- OBJECT GET RESIZING OPTIONS
- OBJECT GET RGB COLORS
- OBJECT GET SCROLL POSITION
- OBJECT GET SCROLLBARUpd
- OBJECT GET SHORTCUT
- OBJECT Get style sheetNew
- OBJECT GET SUBFORM
- OBJECT GET SUBFORM CONTAINER SIZE
- OBJECT Get text orientationNew
- OBJECT Get three states checkboxNew
- OBJECT Get title
- OBJECT Get typeNew
- OBJECT Get vertical alignment
- OBJECT Get visible
- OBJECT Is styled textNew
- OBJECT MOVE
- OBJECT SET ACTIONNew
- OBJECT SET AUTO SPELLCHECK
- OBJECT SET BORDER STYLENew
- OBJECT SET COLOR
- OBJECT SET CONTEXT MENUNew
- OBJECT SET COORDINATESNew
- OBJECT SET DATA SOURCENew
- OBJECT SET DRAG AND DROP OPTIONS
- OBJECT SET ENABLED
- OBJECT SET ENTERABLE
- OBJECT SET EVENTSNew
- OBJECT SET FILTER
- OBJECT SET FOCUS RECTANGLE INVISIBLE
- OBJECT SET FONT SIZE
- OBJECT SET FONT STYLE
- OBJECT SET FONTUpd
- OBJECT SET FORMAT
- OBJECT SET HELP TIP
- OBJECT SET HORIZONTAL ALIGNMENT
- OBJECT SET INDICATOR TYPENew
- OBJECT SET KEYBOARD LAYOUT
- OBJECT SET LIST BY NAMEUpd
- OBJECT SET LIST BY REFERENCENew
- OBJECT SET MAXIMUM VALUENew
- OBJECT SET MINIMUM VALUENew
- OBJECT SET MULTILINENew
- OBJECT SET PLACEHOLDERNew
- OBJECT SET PRINT VARIABLE FRAMENew
- OBJECT SET RESIZING OPTIONS
- OBJECT SET RGB COLORSUpd
- OBJECT SET SCROLL POSITION
- OBJECT SET SCROLLBARUpd
- OBJECT SET SHORTCUT
- OBJECT SET STYLE SHEETNew
- OBJECT SET SUBFORM
- OBJECT SET TEXT ORIENTATIONNew
- OBJECT SET THREE STATES CHECKBOXNew
- OBJECT SET TITLE
- OBJECT SET VERTICAL ALIGNMENT
- OBJECT SET VISIBLE
- DISABLE BUTTON
- ENABLE BUTTON
OBJECT Get format
| OBJECT Get format ( {* ;} object ) -> Function result | ||||||||
| Parameter | Type | Description | ||||||
| * | Operator |
|
If specified, object is an object name (string) If omitted, object is a field or a variable | |||||
| object | Form object |
|
Object name (if * is specified) or Field or variable (if * is omitted) | |||||
| Function result | String |
|
Object display format | |||||
The OBJECT Get format command returns the current display format applied to the object specified in the object parameter.
If you pass the optional * parameter, you indicate that the object parameter is an object name (in this case, pass a string in object). If you do not pass this parameter, you indicate that the object parameter is a field or variable. In this case, you do not pass a string, but a field or variable reference.
This command returns the current display format of the object; in other words, the format as defined in the Design environment or using the OBJECT SET FORMAT command. OBJECT Get format works with all types of form objects (fields or variables) that accept a display format: Boolean, date, time, picture, string, number, as well as button grids, dials, thermometers, rulers, picture pop-up menus, picture buttons and 3D buttons. For more information on the display formats of these objects, refer to the documentation for the OBJECT SET FORMAT command.
Note: If you apply the command to a set of objects, the form of the last object selected is returned.
When the OBJECT Get format command is applied to date, time or picture objects (formats defined as constants), the string returned corresponds to the character code of the constant. To obtain the value of the constant, simply apply the Character code function to the result (see below).
This example allows you to obtain the value of the format constant applied to the picture variable named “myphoto”:
C_STRING(2;$format)
OBJECT SET FORMAT(*;"myphoto";Char(On background))
`Apply background format (value = 3)
$format:=OBJECT Get format(*;"myphoto")
ALERT("Format number:"+String(Character code($format)))
`Display value "3"
Product: 4D
Theme: Objects (Forms)
Number:
894
Created: 4D 2004
Renamed: 4D v12
4D Language Reference ( 4D v12.4)
4D Language Reference ( 4D v14 R3)
4D Language Reference ( 4D v14 R2)
4D Language Reference ( 4D v13.5)
4D Language Reference ( 4D v14.3)
4D Language Reference ( 4D v14 R4)
Inherited from : Get format ( 4D v11 SQL Release 6)
