VS:SetToolHelpMessage

From Vectorworks Developer
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

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

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.

Version

Availability: from Vectorworks 2013