Skip to content

4. Component methods

Gary Criblez edited this page Jul 29, 2020 · 5 revisions

New AJUI_Tip ( {temp_obj} ) -> object

  • This method returns an object variable that represents an instance of AJUI Tip. It contains all the properties and their default values as well as the formulas (member functions) to manipulate them. It is possible to pass an object as a parameter to it in order to import an AJUI Tip template (JSON file). The object expects as properties:
    • templateName : Corresponds to the name of the JSON file to import (template). If the file is not found, the method will return a new instance of AJUI Tip.
    • templatePath (optional): You can specify a path to retrieve the file otherwise, the component will search in the default folder located in the resources (.../Resources/AJUI_Tip_Templates/). You can use "#" to designate the 4D resources folder in your path.

AJUI_Tip ( {temp_obj} ) -> class

  • This method replaces New AJUI_Tip starting from V18R3, it is used to return the Tip class. The functions of the class are identical to the formulas. It is possible to pass an object as a parameter to it in order to import an AJUI Tip template (JSON file). The object expects as properties:
    • templateName : Corresponds to the name of the JSON file to import (template). If the file is not found, the method will return a new instance of AJUI Tip.
    • templatePath (optional): You can specify a path to retrieve the file otherwise, the component will search in the default folder located in the resources (.../Resources/AJUI_Tip_Templates/). You can use "#" to designate the 4D resources folder in your path.

AJUI_Tip_info () -> string

  • This method returns the version number of the component when it has been compiled.

AJUI_Tip_loadTemplates ( {folderPath} ) -> collection

  • This method allows you to load all the templates files contained in a directory. It returns all the content of the files as a collection of Tip objects. It is possible to define a target folder path as a parameter, if not, the method will use the default path : resources/AJUI_Tip_Templates/ .

AJUI_Tip_clearCache ()

  • This method allows you to clean up instances stored internally in an interprocess variable. This is important in order to free up memory. We recommend that you use this method when you close the process that contains the form(s) that display tooltips. This method cleans only the instances of the current process.
Clone this wiki locally