4D v14.3

OBJECT Get help tip

Home

 
4D v14.3
OBJECT Get help tip

OBJECT Get help tip 


 

OBJECT Get help tip ( {* ;} object ) -> Function result 
Parameter Type   Description
Operator in If specified, object is an object name (string)
If omitted, object is a variable
object  Form object in Object Name (if * is specified) or
Variable (if * is omitted)
Function result  Text in Help message of object

The OBJECT Get help tip command returns the help message associated with the object(s) designated by the object and * parameters for the current process.

If you pass the optional * parameter, this indicates that the object parameter is an object name (a string). If you do not pass this parameter, this indicates that the object is a variable. In this case, you pass a variable reference instead of a string.

The command returns the current help message associated with the object, as it is defined in Design mode or for the process using the OBJECT SET HELP TIP command. The string returned shows the message as it appears when the form is executed. If it contains variable items (xliff resname or 4D references), they are interpreted according to the context.

Example  

The title of a picture button is stored as a help message. This title is stored in an xliff file and differs according to the current language of the application:

 OBJECT SET HELP TIP(*;"button1";":xliff:btn_discover")
 $helpmessage:=OBJECT Get help tip(*;"button1")
  // $helpmessage contains for example "Découvrir" with a French 4D and "Discover" with an English 4D.

 
PROPERTIES 

Product: 4D
Theme: Objects (Forms)
Number: 1182

 
HISTORY 

Created: 4D v13

 
SEE ALSO 

OBJECT SET HELP TIP

 
ARTICLE USAGE

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)