Skip to content

SetModeButtonText.md

Latest commit

 

History

History
73 lines (60 loc) · 1.67 KB

SetModeButtonText.md

File metadata and controls

73 lines (60 loc) · 1.67 KB
Raw

SetModeButtonText

Description

Sets a mode bar button help text.

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

Parameters

Name Type Description
modeName STRING The name of the mode.
modeType INTEGER The type of the mode.

Examples

BeginModeButtonsText;
SetModeButtonText( 'Mode1', 1 );
SetModeButtonText( 'Mode2', 0 );
EndModeButtonsText;
BeginModeButtonsText;
SetModeButtonText( GetPluginString( kConstrLine ), 0 );
SetModeButtonText( GetPluginString( kUnconstrLine ), 0 );
EndModeButtonsText;

{ ---------------------------------}
kOnToolDoSetupEventID: BEGIN
	AddButtonMode('VWMiscSmallImages/11016.png');
	BeginModeButtonsText;
	SetModeButtonText( GetPluginString( 6000 ), 2 );
	EndModeButtonsText;
	vstSetPtBehavior(kPolyPointTool);
	vstSetModeHelpBase( -2322 );
END;

BeginModeButtonsText;
SetModeButtonText( GetPluginString( 3001 ), 0 );
SetModeButtonText( GetPluginString( 3002 ), 0 );
SetModeButtonText( GetPluginString( 3003 ), 0 );
SetModeButtonText( GetPluginString( 3004 ), 0 );
SetModeButtonText( GetPluginString( 3005 ), 0 );
import vs

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

vs.SetModeButtonText(modeName, modeType)

See Also

VS Functions: BeginModeButtonsText | EndModeButtonsText

Version

Availability: from Vectorworks 2013

Category