Widget Class: _setHelpMode

Widget Class: _setHelpMode

Sets the help environment

Syntax
Details

Syntax

objectName._setHelpMode( );

Details

This method runs automatically when the help environment is enabled. The default behavior is to unprotect objects that are protected so that you can click them with the help mouse pointer.

Example

Suppose you want to change the region title of your object when the help environment is enabled. Use the _setHelpMode method to change the title and the _clearHelpMode method to restore it.

length _method_ title $40;

SETHELP:
 method;

   /* get the current region title and save it */
   reg = makelist();
   _self_._getRegion(reg);
   title = getnitemc(reg, 'title');
   rc = setnitemc(_self_, title, 'previous title');
   rc = dellist(reg);

   /* set the new title */
   _self_._setBorderTitle('select me for help');

   _super_._method();
 endmethod;

CLRHELP:
 method;

   /* get the previous title and restore it */
   title = getnitemc(_self_, 'previous title');
   _self_._setBorderTitle(title);
   rc = delnitem(_self_, 'previous title');

   _super_._method();
 endmethod;

Chapter Contents
Previous
Next
Top of Page