AddAssociation Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   AddAssociation
(   ioOwnerObj :HANDLE;
    inKind :INTEGER;
    ioTargetObj :HANDLE
) :BOOLEAN ;

Python:

def  vs.AddAssociation(ioOwnerObj, inKind, ioTargetObj):
   return BOOLEAN



  GetEvent Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   GetEvent
:LONGINT ;

Python:

def  vs.GetEvent():
   return LONGINT



  GetXPropVersion Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   GetXPropVersion
VAR outVersion:LONGINT ) ;

Python:

def  vs.GetXPropVersion():
   return outVersion



  RemoveAssociation Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   RemoveAssociation
(   ioOwnerObj :HANDLE;
    inKind :INTEGER;
    ioTargetObj :HANDLE
) :BOOLEAN ;

Python:

def  vs.RemoveAssociation(ioOwnerObj, inKind, ioTargetObj):
   return BOOLEAN



  SetCntrlPtVis Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   SetCntrlPtVis
(   inCustomObj :HANDLE;
    inContrlPtIndex :INTEGER;
    inIsVisible :BOOLEAN
) ;

Python:

def  vs.SetCntrlPtVis(inCustomObj, inContrlPtIndex, inIsVisible):
   return None



  SetObjPropCharVS Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   SetObjPropCharVS
(   PropertyID :LONGINT;
    PropertyVal :CHAR
) :BOOLEAN ;

Python:

def  vs.SetObjPropCharVS(PropertyID, PropertyVal):
   return BOOLEAN



  SetObjPropDoubleVS Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   SetObjPropDoubleVS
(   PropertyID :LONGINT;
    PropertyVal :REAL
) :BOOLEAN ;

Python:

def  vs.SetObjPropDoubleVS(PropertyID, PropertyVal):
   return BOOLEAN



  SetObjPropVS Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   SetObjPropVS
(   PropertyID :LONGINT;
    PropertyVal :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.SetObjPropVS(PropertyID, PropertyVal):
   return BOOLEAN



  vsoAddParamWidget Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoAddParamWidget
(   widgetID :LONGINT;
    paramName :STRING;
    locName :STRING
) :BOOLEAN ;

Python:

def  vs.vsoAddParamWidget(widgetID, paramName, locName):
   return BOOLEAN

Description:

Add a widget for parameter to appear in the Object Info Palette.



  vsoAddWidget Object Events 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   vsoAddWidget
(   widgetID :LONGINT;
    widgetType :LONGINT;
    locName :STRING
) :BOOLEAN ;

Python:

def  vs.vsoAddWidget(widgetID, widgetType, locName):
   return BOOLEAN

Description:

Add a widget of the specified type and localized name to appear in the Object Info Palette.



  vsoAppendParamWidget Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoAppendParamWidget
(   parameterID :LONGINT;
    text :STRING;
    data :LONGINT
) :BOOLEAN ;

Python:

def  vs.vsoAppendParamWidget(parameterID, text, data):
   return BOOLEAN

Description:

Sets a widget to appear at the end of the widgets in the Object Info Palette.



  vsoAppendWidget Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoAppendWidget
(   widgetType :LONGINT;
    mappingID :LONGINT;
    text :STRING;
    data :LONGINT
) :BOOLEAN ;

Python:

def  vs.vsoAppendWidget(widgetType, mappingID, text, data):
   return BOOLEAN

Description:

Sets a widget to appear at the end of the widgets in the Object Info Palette.



  vsoContextM_Add Object Events 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   vsoContextM_Add
(   locName :STRING;
    itemID :INTEGER;
    helpID :STRING
) ;

Python:

def  vs.vsoContextM_Add(locName, itemID, helpID):
   return None

Description:

Add an item to the context menu of the object during ObjectContextMenuEvent::kAction_Init event.



  vsoContextM_AddSep Object Events 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   vsoContextM_AddSep
( itemID:INTEGER ) ;

Python:

def  vs.vsoContextM_AddSep(itemID):
   return None

Description:

Add a separator to the context menu of the object during ObjectContextMenuEvent::kAction_Init event.



  vsoContextM_Check Object Events 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   vsoContextM_Check
(   itemID :INTEGER;
    check :BOOLEAN
) ;

Python:

def  vs.vsoContextM_Check(itemID, check):
   return None

Description:

Check an item in the context menu of the object during ObjectContextMenuEvent::kAction_Init event.



  vsoContextM_Enable Object Events 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   vsoContextM_Enable
(   itemID :INTEGER;
    enable :BOOLEAN
) ;

Python:

def  vs.vsoContextM_Enable(itemID, enable):
   return None

Description:

Enable an item in the context menu of the object during ObjectContextMenuEvent::kAction_Init event.



  vsoContextM_GetItem Object Events 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   vsoContextM_GetItem
:INTEGER ;

Python:

def  vs.vsoContextM_GetItem():
   return INTEGER

Description:

Get selected object context menu item during ObjectContextMenuEvent::kAction_Event event.



  vsoGetCWInfo Object Events 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   vsoGetCWInfo
( VAR  width :REAL;
  VAR  height :REAL;
  VAR  centerX :REAL;
  VAR  centerY :REAL;
  VAR  index :INTEGER
) ;

Python:

def  vs.vsoGetCWInfo():
   return (width, height, centerX, centerY, index)

Description:

Gets the information about the panel and position of an object being inserted by the curtain wall tool



  vsoGetEventInfo Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoGetEventInfo
( VAR  outObjEvent :LONGINT;
  VAR  outEventData :LONGINT
) ;

Python:

def  vs.vsoGetEventInfo():
   return (outObjEvent, outEventData)

Description:

Gets the complete message information associated with an object event.



  vsoInsertAllParams Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoInsertAllParams
:BOOLEAN ;

Python:

def  vs.vsoInsertAllParams():
   return BOOLEAN

Description:

Inserts all parameters of the plug-in object as widgets to appear in the Object Info Palette.



  vsoInsertParamWidget Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoInsertParamWidget
(   position :LONGINT;
    parameterID :LONGINT;
    text :STRING;
    data :LONGINT
) :BOOLEAN ;

Python:

def  vs.vsoInsertParamWidget(position, parameterID, text, data):
   return BOOLEAN

Description:

Sets a widget to appear in the Object Info Palette.



  vsoInsertWidget Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoInsertWidget
(   paramID :LONGINT;
    widgetType :LONGINT;
    mappingID :LONGINT;
    text :STRING;
    data :LONGINT
) :BOOLEAN ;

Python:

def  vs.vsoInsertWidget(paramID, widgetType, mappingID, text, data):
   return BOOLEAN

Description:

Sets a widget to appear in the Object Info Palette.



  vsoPrmName2WidgetID Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoPrmName2WidgetID
(   recName :STRING;
    paramName :STRING;
  VAR  outWidgetID :LONGINT
) :BOOLEAN ;

Python:

def  vs.vsoPrmName2WidgetID(recName, paramName):
   return (BOOLEAN, outWidgetID)



  vsoSetEventResult Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoSetEventResult
( inEventResult:LONGINT ) ;

Python:

def  vs.vsoSetEventResult(inEventResult):
   return None



  vsoSetInCurtainWall Object Events 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   vsoSetInCurtainWall
( inCurtainWall:BOOLEAN ) ;

Python:

def  vs.vsoSetInCurtainWall(inCurtainWall):
   return None

Description:

Used during event 52 to retrun whether an object is aCurtain Wall object



  vsoSetObjToolName Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoSetObjToolName
(   eventData :LONGINT;
    toolName :STRING
) ;

Python:

def  vs.vsoSetObjToolName(eventData, toolName):
   return None

Description:

Set ToolName for similar object creation. Used inside ParametricGetToolNameMessage::kAction event.



  vsoStateAddCurrent Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateAddCurrent
(   hObj :HANDLE;
    message :LONGINT
) :LONGINT ;

Python:

def  vs.vsoStateAddCurrent(hObj, message):
   return LONGINT



  vsoStateClear Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoStateClear
( hObj:HANDLE ) ;

Python:

def  vs.vsoStateClear(hObj):
   return None



  vsoStateGet Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateGet
(   hObj :HANDLE;
    state :INTEGER
) :BOOLEAN ;

Python:

def  vs.vsoStateGet(hObj, state):
   return BOOLEAN



  vsoStateGetExitGroup Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateGetExitGroup
(   hObj :HANDLE;
  VAR  outGrpType :LONGINT
) :BOOLEAN ;

Python:

def  vs.vsoStateGetExitGroup(hObj):
   return (BOOLEAN, outGrpType)



  vsoStateGetLayrChng Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateGetLayrChng
(   hObj :HANDLE;
  VAR  outOldScale :REAL;
  VAR  outNewScale :REAL;
  VAR  outScaleText :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.vsoStateGetLayrChng(hObj):
   return (BOOLEAN, outOldScale, outNewScale, outScaleText)



  vsoStateGetNameChng Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateGetNameChng
(   hObj :HANDLE;
  VAR  outOldName :STRING;
  VAR  outNewName :STRING
) :BOOLEAN ;

Python:

def  vs.vsoStateGetNameChng(hObj):
   return (BOOLEAN, outOldName, outNewName)



  vsoStateGetObjChng Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateGetObjChng
(   hObj :HANDLE;
  VAR  outChangeID :LONGINT
) :BOOLEAN ;

Python:

def  vs.vsoStateGetObjChng(hObj):
   return (BOOLEAN, outChangeID)



  vsoStateGetParamChng Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateGetParamChng
(   hObj :HANDLE;
  VAR  outWidgID :LONGINT;
  VAR  outPrmIdx :INTEGER;
  VAR  outOldVal :STRING
) :BOOLEAN ;

Python:

def  vs.vsoStateGetParamChng(hObj):
   return (BOOLEAN, outWidgID, outPrmIdx, outOldVal)



  vsoStateGetPos Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateGetPos
(   hObj :HANDLE;
  VAR  outX :REAL;
  VAR  outY :REAL;
  VAR  outZ :REAL;
  VAR  outIs3D :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.vsoStateGetPos(hObj):
   return (BOOLEAN, outX, outY, outZ, outIs3D)



  vsoStateGetRot Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoStateGetRot
(   hObj :HANDLE;
  VAR  outDiffAng :REAL;
  VAR  outIs3D :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.vsoStateGetRot(hObj):
   return (BOOLEAN, outDiffAng, outIs3D)



  vsoWidgetGetEnable Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoWidgetGetEnable
( widgetID:LONGINT ) :BOOLEAN ;

Python:

def  vs.vsoWidgetGetEnable(widgetID):
   return BOOLEAN



  vsoWidgetGetRecParam Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoWidgetGetRecParam
( widgetID:LONGINT ) :STRING ;

Python:

def  vs.vsoWidgetGetRecParam(widgetID):
   return STRING



  vsoWidgetGetText Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoWidgetGetText
( widgetID:LONGINT ) :STRING ;

Python:

def  vs.vsoWidgetGetText(widgetID):
   return STRING



  vsoWidgetGetVisible Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoWidgetGetVisible
( widgetID:LONGINT ) :BOOLEAN ;

Python:

def  vs.vsoWidgetGetVisible(widgetID):
   return BOOLEAN



  vsoWidgetPopupAdd Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetPopupAdd
(   widgetID :LONGINT;
    id :STRING;
    text :STRING
) ;

Python:

def  vs.vsoWidgetPopupAdd(widgetID, id, text):
   return None



  vsoWidgetPopupClear Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetPopupClear
( widgetID:LONGINT ) ;

Python:

def  vs.vsoWidgetPopupClear(widgetID):
   return None



  vsoWidgetPopupGet Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetPopupGet
(   widgetID :LONGINT;
    index :LONGINT;
  VAR  outId :STRING;
  VAR  outText :STRING
) ;

Python:

def  vs.vsoWidgetPopupGet(widgetID, index):
   return (outId, outText)



  vsoWidgetPopupGetCnt Object Events 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   vsoWidgetPopupGetCnt
( widgetID:LONGINT ) :LONGINT ;

Python:

def  vs.vsoWidgetPopupGetCnt(widgetID):
   return LONGINT



  vsoWidgetPopupSet Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetPopupSet
(   widgetID :LONGINT;
    index :LONGINT;
    id :STRING;
    text :STRING
) ;

Python:

def  vs.vsoWidgetPopupSet(widgetID, index, id, text):
   return None



  vsoWidgetSetBound Object Events 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   vsoWidgetSetBound
(   widgetID_Popup :LONGINT;
    widgetID_Offset :LONGINT;
    boundID :LONGINT;
    isTop :BOOLEAN;
    offsetLegPrm :STRING
) ;

Python:

def  vs.vsoWidgetSetBound(widgetID_Popup, widgetID_Offset, boundID, isTop, offsetLegPrm):
   return None



  vsoWidgetSetEnable Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetSetEnable
(   widgetID :LONGINT;
    enabled :BOOLEAN
) ;

Python:

def  vs.vsoWidgetSetEnable(widgetID, enabled):
   return None



  vsoWidgetSetIndLvl Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetSetIndLvl
(   widgetID :LONGINT;
    indentLevel :LONGINT
) ;

Python:

def  vs.vsoWidgetSetIndLvl(widgetID, indentLevel):
   return None



  vsoWidgetSetText Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetSetText
(   widgetID :LONGINT;
    text :STRING
) ;

Python:

def  vs.vsoWidgetSetText(widgetID, text):
   return None



  vsoWidgetSetVisible Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetSetVisible
(   widgetID :LONGINT;
    visible :BOOLEAN
) ;

Python:

def  vs.vsoWidgetSetVisible(widgetID, visible):
   return None