Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 850 Bytes

WSScript_GetEditObj.md

File metadata and controls

31 lines (24 loc) · 850 Bytes

WSScript_GetEditObj

Description

This function must be used inside a worksheet script called by 'RunScriptEdit' worksheet formula. It will return the object being edited when 'WSScript_GetEdit' returns that the script is in edit mode.

FUNCTION WSScript_GetEditObj(
				objIndex   : INTEGER;
				VAR outObj : HANDLE): BOOLEAN;
def vs.WSScript_GetEditObj(objIndex):
    return (BOOLEAN, outObj)

Parameters

Name Type Description
objIndex INTEGER Index to the object to be returned as the script can be called for a set of objects. Will return FALSE if no such object.
outObj HANDLE Output the object that is being edited.

See Also

VS Functions: WSScript_GetEdit

Version

Availability: from Vectorworks 2021

Category