4D v16.3
OBJECT GET BEST SIZE
- 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 BEST SIZE
| OBJECT GET BEST SIZE ( {* ;} object ; bestWidth ; bestHeight {; maxWidth} ) | ||||||||
| Parameter | Type | Description | ||||||
| * | Operator |
|
If specified = object is an object name (String) If omitted = object is a variable | |||||
| object | Form object |
|
Object name (if * is specified) or Field or variable (if * is omitted) | |||||
| bestWidth | Longint |
|
Optimum object width | |||||
| bestHeight | Longint |
|
Optimum object height | |||||
| maxWidth | Longint |
|
Maximum object width | |||||
The OBJECT GET BEST SIZE command returns the bestWidth and bestHeight parameters, the “optimal” width and height of the form object designated by the * and object parameters. These values are expressed in pixels. This command is particularly useful for displaying or printing complex reports, associated with the OBJECT MOVE command.
If you pass the optional * parameter, this indicates that the object parameter is an object name (a character string). If you do not pass the * parameter, this indicates that object is a field or a variable. In this case, do not pass a string but rather a field or variable reference (object type only).
The optimal values returned indicate the minimum size of the object so that its current contents are entirely included within the limits. Usually these values are only meaningful for objects containing text. This calculation takes the font, font size, font style and object contents into account. It also takes hyphenation and carriage returns into consideration. Note that in the case of 3D buttons, the command works even when button contains only an icon. If the object specified is empty, the bestWidth returned is 0.
The size returned does not take into account any graphic frame applied around the object, nor any scrollbars. To obtain the real size of an object on screen, it is necessary to add the width of these elements.
The optional maxWidth parameter enables you to attribute a maximum width to the object. If the optimal width of the object is greater than this value, OBJECT GET BEST SIZE returns maxWidth in the bestWidth parameter and increases the optimal height as a consequence.
The following objects are handled by this command:
- Static text areas
- Text inserted in the form of references
- Fields and variables of the following types: Alpha, Text, Real, Integer, Long Integer, Date, Time, Boolean (check boxes and radio buttons)
- Buttons
- List box columns in display context (only visible rows are taken into account).
For all other form object types (group areas, tabs, rectangles, straight lines, circles/ovals, external areas, etc.), the OBJECT GET BEST SIZE command returns the current object size (defined in the form editor and possibly using the OBJECT MOVE command).
Refer to the example in the SET PRINT MARKER command.
Product: 4D
Theme: Objects (Forms)
Number:
717
Created: 4D 2003
Renamed: 4D v12
4D Language Reference ( 4D v16)
4D Language Reference ( 4D v16.1)
4D Language Reference ( 4D v16.2)
4D Language Reference ( 4D v16.3)
