LabelButton command: Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:
|width="50%"| '''Action:'''
|width="50%"| '''Action:'''
|width="50%"|
|width="50%"|
<span class="f_Para">Lets you replace the label of a Client [[review_common_buttons.html|button bar button]]. </span>
<span class="f_Para">Lets you replace the label of a Client [[Button Bar|button bar button]]. </span>


'''Syntax:'''  
'''Syntax:'''  
Line 11: Line 11:
<span class="f_Para">where: </span>
<span class="f_Para">where: </span>


*''buttonName'' is button0, button1, etc; that is, the name of a currently [[intro_configurable_components.html#named_buttons|mapped]] button.  
*''buttonName'' is button0, button1, etc; that is, the name of a currently [[Introducing the configurable components#Named buttons and separators|mapped]] button.  
*''newlabel'' can be as many as 50 characters (the button is expandable).
*''newlabel'' can be as many as 50 characters (the button is expandable).


Line 17: Line 17:


<span class="f_Para">Example: </span>
<span class="f_Para">Example: </span>
<p class="syntax">
<span class="f_Para">The following macro uses </span><span class="f_Monospace">labelButton</span><span class="f_Para">: </span>
<span class="f_Para">The following macro uses </span><span class="f_Monospace">labelButton</span><span class="f_Para">: </span>


<span class="f_CodeExample">continueMacroIf &amp;&amp;blackOrWhiteList = 'black'</span><br />
<p class="syntax"><span class="f_CodeExample">continueMacroIf &amp;&amp;blackOrWhiteList = 'black'</span>
<span class="f_CodeExample">labelButton button0 BlackList On</span><br />
<span class="f_CodeExample">labelButton button0 BlackList On</span>
<span class="f_CodeExample">turnOffBlackList</span><br />
<span class="f_CodeExample">turnOffBlackList</span>
<span class="f_CodeExample">restoreTitle</span><br />
<span class="f_CodeExample">restoreTitle</span>
<span class="f_CodeExample">set &amp;changed = 1</span><br />
<span class="f_CodeExample">set &amp;changed = 1</span>
<span class="f_CodeExample">clearStatus </span>
<span class="f_CodeExample">clearStatus </span>
</p>
</p>

Revision as of 15:55, 6 December 2022

Action:

Lets you replace the label of a Client button bar button.

Syntax:

labelButton buttonName newlabel

where:

  • buttonName is button0, button1, etc; that is, the name of a currently mapped button.  
  • newlabel can be as many as 50 characters (the button is expandable).

If the command executes successfully, the label changes immediately, and you receive a Label set for: buttonName message.

Example: The following macro uses labelButton:

continueMacroIf &&blackOrWhiteList = 'black' labelButton button0 BlackList On turnOffBlackList restoreTitle set &changed = 1 clearStatus 

Client menu: --
Introduced: Build 62