Skip to content

SetModeButtonTextN.md

Latest commit

 

History

History
74 lines (59 loc) · 2.16 KB

SetModeButtonTextN.md

File metadata and controls

74 lines (59 loc) · 2.16 KB
Raw

SetModeButtonTextN

Description

Sets a mode bar button help text.

PROCEDURE SetModeButtonTextN(
				modeName : STRING;
				modeHelp : STRING;
				modeType : INTEGER);
def vs.SetModeButtonTextN(modeName, modeHelp, modeType):
    return None

Parameters

Name Type Description
modeName STRING The name of the mode.
modeHelp STRING Help message of the mode
modeType INTEGER The type of the mode. Types: RadioMode = 0, ButtonMode = 1, PrefButtonMode = 2, CheckMode = 3, EditTextMode = 4, PullDownMode = 5

Examples

BeginModeButtonsText;

SetModeButtonTextN( 'Mode1', 'help msg 1', 1 );

SetModeButtonTextN( 'Mode2', 'help msg 2', 0 );

EndModeButtonsText;
{set the beginning baloon help string}
vstSetModeHelpBase (11045);
BeginModeButtonsText;
SetModeButtonTextN( GetPluginString( kOval ), 				GetPluginString( 7001 ), 0 );
SetModeButtonTextN( GetPluginString( kRectangular ), 		GetPluginString( 7002 ), 0 );
SetModeButtonTextN( GetPluginString( kRegularPolygon ), 	GetPluginString( 7003 ), 0 );
SetModeButtonTextN( GetPluginString( kFreehandPolygon ), 	GetPluginString( 7004 ), 0 );
SetModeButtonTextN( GetPluginString( kPreferences ), 		GetPluginString( 7005 ), 2 );

{set the beginning baloon help string}
vstSetModeHelpBase (kModeButton_1_ID);
BeginModeButtonsText;
SetModeButtonTextN( GetPluginString( 3001 ), GetPluginString( 8001 ), 0 );
SetModeButtonTextN( GetPluginString( 3002 ), GetPluginString( 8002 ), 0 );
SetModeButtonTextN( GetPluginString( 3003 ), GetPluginString( 8003 ), 0 );
SetModeButtonTextN( GetPluginString( 3004 ), GetPluginString( 8004 ), 0 );
SetModeButtonTextN( GetPluginString( 3005 ), GetPluginString( 8005 ), 0 );
import vs

# Sets a mode bar button help text.
modeName = 'Example'
modeHelp = 'Example'
modeType = 0

vs.SetModeButtonTextN(modeName, modeHelp, modeType)

See Also

VS Functions: BeginModeButtonsText| EndModeButtonsText

Version

Availability: from Vectorworks 2026

Category