4D v13.4
OBJECT Get format
- 4D Language Reference
-
- Object Properties
-
- Object Properties
- DISABLE BUTTON
- ENABLE BUTTON
- OBJECT DUPLICATE
- OBJECT Get auto spellcheckNew
- OBJECT GET BEST SIZE
- OBJECT Get choice list name
- OBJECT GET COORDINATES
- OBJECT GET DRAG AND DROP OPTIONSNew
- OBJECT Get enabled
- OBJECT Get enterable
- OBJECT Get filter
- OBJECT Get focus rectangle invisibleNew
- OBJECT Get font
- OBJECT Get font size
- OBJECT Get font style
- OBJECT Get format
- OBJECT Get help tipNew
- OBJECT Get horizontal alignment
- OBJECT Get keyboard layoutNew
- OBJECT Get plain text
- OBJECT GET RESIZING OPTIONSNew
- OBJECT GET RGB COLORS
- OBJECT GET SCROLL POSITION
- OBJECT GET SCROLLBAR
- OBJECT GET SHORTCUTNew
- OBJECT Get styled text
- OBJECT GET STYLED TEXT ATTRIBUTES
- OBJECT GET SUBFORM CONTAINER SIZENew
- OBJECT GET SUBFORMNew
- OBJECT Get title
- OBJECT Get vertical alignmentNew
- OBJECT Get visible
- OBJECT MOVE
- OBJECT SET AUTO SPELLCHECKNew
- OBJECT SET CHOICE LIST NAME
- OBJECT SET COLOR
- OBJECT SET DRAG AND DROP OPTIONSNew
- OBJECT SET ENABLED
- OBJECT SET ENTERABLE
- OBJECT SET FILTER
- OBJECT SET FOCUS RECTANGLE INVISIBLENew
- OBJECT SET FONT
- OBJECT SET FONT SIZE
- OBJECT SET FONT STYLE
- OBJECT SET FORMAT
- OBJECT SET HELP TIPNew
- OBJECT SET HORIZONTAL ALIGNMENT
- OBJECT SET KEYBOARD LAYOUTNew
- OBJECT SET PLAIN TEXT
- OBJECT SET RESIZING OPTIONSNew
- OBJECT SET RGB COLORS
- OBJECT SET SCROLL POSITION
- OBJECT SET SCROLLBAR
- OBJECT SET SHORTCUTNew
- OBJECT SET STYLED TEXT
- OBJECT SET STYLED TEXT ATTRIBUTES
- OBJECT SET SUBFORMNew
- OBJECT SET TITLE
- OBJECT SET VERTICAL ALIGNMENTNew
- OBJECT SET VISIBLE
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"This example allows you to obtain the format applied to the Boolean field [Members]Marital_status:
C_STRING(30;$format)
$format:=OBJECT Get format([Members]Marital_status)
ALERT($format) `Display format, for example "Married;Single"
Product: 4D
Theme: Object Properties
Number:
894
Created: 4D 2004
Renamed: 4D v12
