4D v13.4
OBJECT GET BEST SIZE
- 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 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.
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: Object Properties
Number:
717
Created: 4D 2003
Renamed: 4D v12
