4D v16.3
OBJECT Get format
- 4D Language Reference
-
- Objects (Forms)
-
- Object Properties
- GET STYLE SHEET INFO
- LIST OF STYLE SHEETS
- OBJECT DUPLICATE
- OBJECT Get action
- OBJECT Get auto spellcheck
- OBJECT GET BEST SIZE
- OBJECT Get border style
- OBJECT Get context menu
- OBJECT GET COORDINATES
- OBJECT Get corner radius
- OBJECT Get data source
- OBJECT GET DRAG AND DROP OPTIONS
- OBJECT Get enabled
- OBJECT Get enterable
- OBJECT GET EVENTS
- 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 type
- OBJECT Get keyboard layout
- OBJECT Get list name
- OBJECT Get list reference
- OBJECT GET MAXIMUM VALUE
- OBJECT GET MINIMUM VALUE
- OBJECT Get multiline
- OBJECT Get name
- OBJECT Get placeholder
- OBJECT Get pointer
- OBJECT GET PRINT VARIABLE FRAME
- OBJECT GET RESIZING OPTIONS
- OBJECT GET RGB COLORS
- OBJECT GET SCROLL POSITION
- OBJECT GET SCROLLBAR
- OBJECT GET SHORTCUT
- OBJECT Get style sheet
- OBJECT GET SUBFORM
- OBJECT GET SUBFORM CONTAINER SIZE
- OBJECT Get text orientation
- OBJECT Get three states checkbox
- OBJECT Get title
- OBJECT Get type
- OBJECT Get vertical alignment
- OBJECT Get visible
- OBJECT Is styled text
- OBJECT MOVE
- OBJECT SET ACTION
- OBJECT SET AUTO SPELLCHECK
- OBJECT SET BORDER STYLE
- OBJECT SET COLOR
- OBJECT SET CONTEXT MENU
- OBJECT SET COORDINATES
- OBJECT SET CORNER RADIUS
- OBJECT SET DATA SOURCE
- OBJECT SET DRAG AND DROP OPTIONS
- OBJECT SET ENABLED
- OBJECT SET ENTERABLE
- OBJECT SET EVENTS
- OBJECT SET FILTER
- OBJECT SET FOCUS RECTANGLE INVISIBLE
- OBJECT SET FONT
- OBJECT SET FONT SIZE
- OBJECT SET FONT STYLE
- OBJECT SET FORMAT
- OBJECT SET HELP TIP
- OBJECT SET HORIZONTAL ALIGNMENT
- OBJECT SET INDICATOR TYPE
- OBJECT SET KEYBOARD LAYOUT
- OBJECT SET LIST BY NAME
- OBJECT SET LIST BY REFERENCE
- OBJECT SET MAXIMUM VALUE
- OBJECT SET MINIMUM VALUE
- OBJECT SET MULTILINE
- OBJECT SET PLACEHOLDER
- OBJECT SET PRINT VARIABLE FRAME
- OBJECT SET RESIZING OPTIONS
- OBJECT SET RGB COLORS
- OBJECT SET SCROLL POSITION
- OBJECT SET SCROLLBAR
- OBJECT SET SHORTCUT
- OBJECT SET STYLE SHEET
- OBJECT SET SUBFORM
- OBJECT SET TEXT ORIENTATION
- OBJECT SET THREE STATES CHECKBOX
- OBJECT SET TITLE
- OBJECT SET VERTICAL ALIGNMENT
- OBJECT SET VISIBLE
- _o_DISABLE BUTTON
- _o_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, 3D buttons, and list box headers. 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: Objects (Forms)
Number:
894
Created: 4D 2004
Renamed: 4D v12
Modified: 4D v15 R5
4D Language Reference ( 4D v16)
4D Language Reference ( 4D v16.1)
4D Language Reference ( 4D v16.2)
4D Language Reference ( 4D v16.3)
