Skip to content

SetToolHelpMessage.md

Latest commit

 

History

History
48 lines (37 loc) · 1.02 KB

SetToolHelpMessage.md

File metadata and controls

48 lines (37 loc) · 1.02 KB
Raw

SetToolHelpMessage

Description

Sets the Tool Bar Help Text by new standard - Tool Name[: Tool Mode][. Brief usage advice.].

PROCEDURE SetToolHelpMessage(
				modeText        : STRING;
				descriptionText : STRING);
def vs.SetToolHelpMessage(modeText, descriptionText):
    return None

Parameters

Name Type Description
modeText STRING The text that will be showed like as a name of the mode.
descriptionText STRING The text that will be showed like as an advice text.

Examples

	SetToolHelpMessage( modeName, '' );
END;

	SetToolHelpMessage( helpString, '' );
END;

{set the default help string}
SetToolHelpMessage( '', GetPlugInString(5003) );
import vs

# Sets the Tool Bar Help Text by new standard - Tool Name[: Tool Mode][.
modeText = 'Example text'
descriptionText = 'Example text'

vs.SetToolHelpMessage(modeText, descriptionText)

Version

Availability: from Vectorworks 2013

Category