Skip to content

SetToolByName.md

Latest commit

 

History

History
41 lines (32 loc) · 734 Bytes

SetToolByName.md

File metadata and controls

41 lines (32 loc) · 734 Bytes
Raw

SetToolByName

Description

Similar to SetTool, but takes name rather than ID. Supports plug-in tools (but not yet internal tools).

FUNCTION SetToolByName(toolName : STRING): BOOLEAN;
def vs.SetToolByName(toolName):
    return BOOLEAN

Parameters

Name Type Description
toolName STRING

Examples

resultOK := SetToolByName('Example');
import vs

# Similar to SetTool, but takes name rather than ID.
toolName = 'Example'

ok = vs.SetToolByName(toolName)
if ok:
    vs.Message('SetToolByName succeeded')
else:
    vs.Message('SetToolByName failed')

Version

Availability: from Vectorworks 2014

Category