Skip to content

Latest commit

 

History

History
52 lines (42 loc) · 1.01 KB

SetTempToolHelpStr.md

File metadata and controls

52 lines (42 loc) · 1.01 KB

SetTempToolHelpStr

Description

Sets a text to be used as help string for temp tool calls: RunTempTool, TrackObject, GetPt, GetPtL, GetPt3D, and GetPtL3D.

This function should be called prior to calling the tool.

The help string will be used for subsequent temp tool runs until changed.

PROCEDURE SetTempToolHelpStr(helpString : STRING);
def vs.SetTempToolHelpStr(helpString):
    return None

Parameters

Name Type Description
helpString STRING The help string for the next temp tool.

Examples

VectorScript

PROCEDURE Test;
VAR h : HANDLE;
  
  FUNCTION CheckObjCallback(h : HANDLE) : BOOLEAN;
  BEGIN
     {any object is ok}
     CheckObjCallback := true;
  END;

BEGIN
SetTempToolHelpStr( 'Select any object' );
TrackObject( CheckObjCallback, h );
SetSelect( h );
END;
RUN( Test );

Python



Version


Availability: from Vectorworks 2010


Category