This file describes syntax of 24U SimpleHelp Plug-In's functions.
SHelp_Version ( {versionFormat} )
Returns version string of the active 24U SimpleHelp Plug-In, formatted as requested by the parameter. Use:
"short" to get just the version number "long" to get the plug-in name followed by its version number "platform" to get the platform of the code currently running
SHelp_Register ( registrationCode )
Attempts to unlock (register) your copy of 24U SimpleHelp Plug-In with the specified code. If the code is valid, 24U SimpleHelp Plug-In gets unlocked and stays in this state until you quit the FileMaker Pro application, deactivate the plug-in, or the registration code expires. While unlocked, 24U SimpleHelp Plug-In is fully functional and does not bother the user with a shareware reminder.
Returns a non-zero result when operation is not permitted.
SHelp_AttachTooltips( tooltip { ; tooltip... } )
This command attaches tooltips to given hot rectangles.
tooltip = tipType ; tipPosition ; tipContent; {tipProperty { ; tipProperty ...}}
tipContent = scriptName ; scriptParameter
tipProperty = propertyType ; propertyValue
propertyValue = titlePosition ; titleContent
propertyValue = buttonPosition ; buttonText ; buttonScript ; scriptParameter
propertyValue = width in pixels
propertyValue = height in pixels
propertyValue is not present at all
Function returns 0 if everything is OK or negative number of error code.
Examples:Attaches standard tooltip to the layout object with the name "my button"
Attaches standard tooltip to the hot rectangle defined by coordinates 10;10;50;50
combines the previous two calls into one call
Attaches advanced tooltip to the layout object with the name "my area". The tooltip will have the title "Help to my area" and will contain one button named "show it". After clicking the button, FM script "show script" with parameter "" will be called.
Attaches HTML tooltip to the layout object with the name "my button"
Attaches script tooltip to the layout object with the name "my button". After activating the tooltip, FM script "help script" with parameter "X3" will be called
Reads layout coordinates of the layout object with the name "my button" on current FM layout and then attaches textual toltip to those coordinates.
SimpleHelp 4.0 is backward compatible with previous versions. SHelp_AttachTooltips function is succesor of SHelp_AttachTags function and have the same ID so that old solution will automatically use SHelp_AttachTooltips. Old tooltips definitions can be used as well. Parameters from old versions of SimpleHelp are recognised and translated internally and do not need any user attention. Plug-In preferes new parameters in any case of misunderstating.
SHelp_AttachTags( "10,10,90,30" ; "This is the Tooltip text" ) means: SHelp_AttachTooltips( "text" ; 10 ; 10 ; 90 ; 30 ; "This is the Tooltip text" ) or SHelp_AttachTags( "10,10,90,30|This is the Tooltip text" ) means also: SHelp_AttachTooltips( "text" ; 10 ; 10 ; 90 ; 30 ; "This is the Tooltip text" ) or SHelp_AttachTags( "10,10,90,30|$$myScript" ) means: SHelp_AttachTooltips( "script" ; 10 ; 10 ; 90 ; 30 ; myScript ; "" )
SHelp_DetachTooltips( { more } { ; tipPosition { ; tipPosition... } } )
This command dettaches given tooltips.
Function returns 0 if everything is OK or negative number of error code.
Examples:will undefine tooltip which has been attached to this position.
will undefine tooltip which has been attached to layout element with specified name "Address".
SimpleHelp 4.0 is backward compatible with previous versions. SHelp_DetachTooltips function is succesor of SHelp_DetachTags function and have the same ID so that old solution will automatically use SHelp_DetachTooltips. Plug-In preferes new parameters in any case of misunderstating.
SHelp_DetachTags( "10,10,90,30" ) means: SHelp_DetachTooltips( 10 ; 10 ; 90 ; 30 ) or SHelp_DetachTags( "10,10,90,30|60,10,150,30" ) means: SHelp_DetachTooltips( 10 ; 10 ; 90 ; 30 ; 60 ; 10 ; 150 ; 30 ) Tooltips defined by old parameters can be undefined by new parameters and vice versa.
SHelp_Get( selector )
This command gets values of options or status information
Function returns number or text depending on selector or negative number of error code. Any color value is represented by a string formatted as "#RRGGBB", where RR is a hexadecimal value of the red component, GG is a hexadecimal value of the green component, and BB is a hexadecimal value of the blue component in the standard RGB color space. The same format is used by the HTML standard.
SimpleHelp < 4.0 compatibility:SimpleHelp 4.0 is backward compatible with previous versions.
SHelp_Set( selector { ; value } )
This command gets usefull information
value = scriptName { ; scriptParameter} Default value is to trigger no script. Calling FileMaker scripts is very useful when creating roll-over effects. For more information see 24uSimpleHelpTutorial. If there is no active hot rectangle an error code -50 paramErr is returned.
value = scriptName { ; scriptParameter} Default value is to trigger no script.
See SHelp_Get for the reference of valid types of values for particulat selectors.
Function returns text or number defined in value if successful or an error code if it is not.
SimpleHelp < 4.0 compatibility:This function is fully backward compatible with older versions.
SHelp_Coachmark( {coachPosition {;command} })
Function circles the specified object with a colored oval called coachmark or removes previously defined coachmark.
Function returns 0 if everything is OK or negative number of error code.
Examples:Shows coachmark around layout object with the name "my button"
hides the previosly defined coachmark
hides all coachmarks
SimpleHelp 4.0 is backward compatible with previous versions. SHelp_Coachmark function is succesor of SHelp_ShowCoach function and has the same ID so that old solution will automatically use SHelp_Coachmark. Old tooltip definitions can be used as well:.
SHelp_ShowCoach( "10,10,90,30" ) means: SHelp_Coachmark( 10 ; 10 ; 90 ; 30 )
SHelp_PersistentTooltip({tipType, tipPosition ; {tipContent ;{tipPropertty ;{tipProperty ...}} } })
Shows persistent tooltip on demand - persistent tooltip remains on screen until it is hidden manually or time specified with SHelp_Set expires.
Function returns 0 if everything is OK or negative number of error code.
Examples:
SHelp_PersistentTooltip("text", 50;50 ;"hello boys";"button";"";"butname";"butfn";"param") - displays persistent tooltip on 50,50. Toltip will contain text "hello boys" and button "butname". After clicking the button, script "butfn" with parameteer "param" is executed SHelp_PersistentTooltip("text", 50;50) - hides the previosly created tooltip
SHelp_TemporaryTooltip(tipType, tipPosition ; tipContent ;{tipProperty {; tipProperty}} )
Shows non-persistent tooltip on demand. Cursor must be inside hot rectangle in calling time. After exiting the hot rectangle, tooltip is hidden and forgotten. Second call to this function with the same parameters automatically hides the previous. Temporary tooltips are useful in two scenarios:
Function returns "" if everything is OK or negative number of error code. !! This function returns "" on success unlike the other functions which returns 0.
SHelp_ShowTag
This function is deprecated. Use SHelpPersistentTooltip or SHelpTemporaryTooltip instead.
SimpleHelp < 4.0 compatibility:SimpleHelp 4.0 is backward compatible with previous versions. Old tooltip definitions can be used as well:
SHelp_ShowTag( "10,40" ; "Some text of the tooltip" ) means: SHelp_PersistentTooltip( "text", 10 ; 40;"Some text of the tooltip" ) or SHelp_ShowTag( "10,40" ; "" ) means: SHelp_PersistentTooltip("text"; 10 ; 40) or SHelp_ShowTag( "this" ; "Some text of the toolTip" ) means: SHelp_TemporaryTooltip("text","this","Some text of the tooltip")
On Coordinate Systems
The coordinates used by SimpleHelp are relative to the upper left corner of the layout. We call these coordinates "layout coordinates". FileMaker Pro uses coordinates relative to the left-most corner below the menu bar or toolbar. This coordinates of-course vary when the window with active layout is moved. We call this coordinates as screen coordinates.List of the most common error codes returned by 24U SimpleHelp Plug-In's functions
-50 Invalid parameter -1000 Plug-In requires registration (expired) 5051 Layout object not found 5052 Attempt to work with non-existing persistent tooltip