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



  SetObjPropTxtVS Object Events 
Vectorworks 2017

VectorScript Declaration:

FUNCTION   SetObjPropTxtVS
(   PropertyID :LONGINT;
    PropertyVal :DYNARRAY[] of CHAR
) :BOOLEAN ;

Python:

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

Description:

Set a text value to an extended property.

説明

拡張プロパティにテキスト型の値を設定します。



  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.

説明

データパレットに、指定した種類とローカライズ名のウィジェットを追加します。



  vsoADPAddDimDef Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoADPAddDimDef
(   message :LONGINT;
    startPt3X :REAL;
    startPt3Y :REAL;
    startPt3Z :REAL;
    endPt3X :REAL;
    endPt3Y :REAL;
    endPt3Z :REAL;
    dimOffset :INTEGER
) ;

Python:

def  vs.vsoADPAddDimDef(message, startPt3, endPt3, dimOffset):
   return None

Description:

Add a dimension definition data to the result for the Auto Dimension GetDimensionDefinitions (78) message sent to a Script object.

説明

スクリプトオブジェクトに送信された 「Auto Dimension GetDimensionDefinitions (78) 」メッセージに返すデータに、寸法定義データを追加します。



  vsoADPAddDimPlace Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoADPAddDimPlace
(   message :LONGINT;
    dimType :INTEGER
) ;

Python:

def  vs.vsoADPAddDimPlace(message, dimType):
   return None

Description:

Add a dimension placement to a dimension type result that has begun for the Auto Dimension GetSupportedTypes (77) message sent to a Script object.

説明

スクリプトオブジェクトに送信された「Auto Dimension Get Supported Types (77)」メッセージが開始した寸法タイプ結果に、寸法配置を追加します。



  vsoADPBeginDimType Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoADPBeginDimType
(   message :LONGINT;
    universalName :DYNARRAY[] of CHAR;
    localizedName :DYNARRAY[] of CHAR
) ;

Python:

def  vs.vsoADPBeginDimType(message, universalName, localizedName):
   return None

Description:

Begin providing the dimension type result for the Auto Dimension GetSupportedTypes (77) message sent to a Script object.

説明

スクリプトオブジェクトに送信された 「Auto Dimension Get Supported Types (77)」 メッセージの寸法タイプ結果を提供開始します。



  vsoADPGetDimDefParms Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoADPGetDimDefParms
(   message :LONGINT;
  VAR  viewType :INTEGER;
  VAR  universalName :DYNARRAY[] of CHAR;
  VAR  dimType :INTEGER
) ;

Python:

def  vs.vsoADPGetDimDefParms(message):
   return (viewType, universalName, dimType)

Description:

Retrieve the parameters from the Auto Dimension GetDimensionDefinitions (78) message sent to a Script object.

説明

スクリプトオブジェクトに送られた「Auto Dimension Get Dimension Definitions (78) 」メッセージからパラメータを取得します。



  vsoADPGetUniTypeName Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoADPGetUniTypeName
(   message :LONGINT;
  VAR  universalName :DYNARRAY[] of CHAR
) ;

Python:

def  vs.vsoADPGetUniTypeName(message):
   return universalName

Description:

Retrieve the universal type name parameter from the Auto Dimension GetLocalizedTypeName (76) message sent to a Script object.

説明

スクリプトオブジェクトに送信された「Auto Dimension Get Localized TypeName (76) 」メッセージからユニバーサルタイプ名パラメータを取得します。



  vsoADPGetViewType Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoADPGetViewType
(   message :LONGINT;
  VAR  viewType :INTEGER
) ;

Python:

def  vs.vsoADPGetViewType(message):
   return viewType

Description:

Retrieve the view type parameter from the Auto Dimension GetSupportedTypes (77) message sent to a Script object.

説明

スクリプトオブジェクトに送信された「Auto Dimension Get Supported Types (77) 」メッセージから表示タイプパラメータを取得します。



  vsoADPSetCatName Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoADPSetCatName
(   message :LONGINT;
    universalName :DYNARRAY[] of CHAR;
    localizedName :DYNARRAY[] of CHAR
) ;

Python:

def  vs.vsoADPSetCatName(message, universalName, localizedName):
   return None

Description:

Sets the universal type name parameter and localized name parameter for the Auto Dimension GetDisplayCategoryName (79) message sent to a Script object.

説明

スクリプトオブジェクトに送信された「Auto Dimension Get Display Category Name (79)」メッセージにユニバーサルタイプ名パラメータとローカライズ名パラメータを設定します。



  vsoADPSetLocTypeName Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoADPSetLocTypeName
(   message :LONGINT;
    localizedName :DYNARRAY[] of CHAR
) ;

Python:

def  vs.vsoADPSetLocTypeName(message, localizedName):
   return None

Description:

Provide the localized type name result for the Auto Dimension GetLocalizedTypeName (76) message sent to a Script object.

説明

スクリプトオブジェクトに送信された「Auto Dimension Get Localized Type Name (76) 」メッセージにローカライズタイプ名の結果を提供します。



  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.

説明

オブジェクト情報パレットの、最後に表示するウィジェットを設定します。



  vsoButtonGetResource Object Events 
Vectorworks 2018

VectorScript Declaration:

FUNCTION   vsoButtonGetResource
(   paramName :STRING;
    objectType :INTEGER;
    folderSpec :INTEGER;
    folderName :STRING
) :BOOLEAN ;

Python:

def  vs.vsoButtonGetResource(paramName, objectType, folderSpec, folderName):
   return BOOLEAN

Description:

Show a resource popup from the current shape pane button (while handing action 35: {ParametricUIButtonHitMessage::kAction}). Parameter name is a string that will receive the resource name.

説明

ボタンからリソースポップアップを表示します (ハンドルするイベント 35: {ParametricUIButtonHitMessage::kAction})。 パラメータにはリソース名を指定します。



  vsoCanEditParam Object Events 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   vsoCanEditParam
( canEditParam:BOOLEAN ) ;

Python:

def  vs.vsoCanEditParam(canEditParam):
   return None

Description:

Inticated whether a parameter can edited by a worksheet

説明

パラメータをワークシートから編集できるようにするかどうか指定します。



  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:

Deprecated, use vsoContextM_AddN instead

説明

ObjectContextMenuEvent::kAction_Initイベントでオブジェクトのコンテキストメニューに項目を追加します。



  vsoContextM_AddN Object Events 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   vsoContextM_AddN
(   locName :STRING;
    itemID :INTEGER;
    helpID :STRING;
    helpStr :STRING
) ;

Python:

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

Description:

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

説明

ObjectContextMenuEvent::kAction_Initイベントでオブジェクトのコンテキストメニューに項目を追加します。



  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.

説明

ObjectContextMenuEvent::kAction_Initイベントでオブジェクトのコンテキストメニューに仕切り線を追加します



  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.

説明

ObjectContextMenuEvent::kAction_Initイベントでオブジェクトのコンテキストメニューの項目を確認します。



  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.

説明

ObjectContextMenuEvent::kAction_Initイベントでオブジェクトのコンテキストメニューの項目を有効にします。



  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.

説明

kObjOnContextMenuEventイベントで、オブジェクトのコンテキストメニューで選択された項目を取得します。



  vsoDisableAttrs Object Events 
Vectorworks 2020

VectorScript Declaration:

PROCEDURE   vsoDisableAttrs
( attrsBits:LONGINT ) ;

Python:

def  vs.vsoDisableAttrs(attrsBits):
   return None



  vsoEIDataGetContext Object Events 
Vectorworks 2023.4

VectorScript Declaration:

FUNCTION   vsoEIDataGetContext
( message:LONGINT ) :INTEGER ;

Python:

def  vs.vsoEIDataGetContext(message):
   return INTEGER

Description:

Gets the equipment item data context from the ParametricEquipmentItemDataMessage(92) message sent to a Script object.

説明

Scriptオブジェクトに送信されたParametricEquipmentItemDataMessage(92) メッセージから、機器アイテムのデータコンテキストを取得します。



  vsoEquipItemDataGet Object Events 
Vectorworks 2023.4

VectorScript Declaration:

FUNCTION   vsoEquipItemDataGet
(   message :LONGINT;
    dataIndex :INTEGER;
  VAR  outValue :STRING
) :BOOLEAN ;

Python:

def  vs.vsoEquipItemDataGet(message, dataIndex):
   return (BOOLEAN, outValue)

Description:

Gets the specified equipment item data from the ParametricEquipmentItemDataMessage(92) message sent to a Script object based on the dataIndex. Returns false if this value is not available.

説明

Scriptオブジェクトに送信されたParametricEquipmentItemDataMessage(92) メッセージから、dataIndexに基づいて指定された機器アイテムデータを取得します。この値がない場合はfalseを返します。



  vsoEquipItemDataSet Object Events 
Vectorworks 2023.4

VectorScript Declaration:

PROCEDURE   vsoEquipItemDataSet
(   message :LONGINT;
    dataIndex :INTEGER;
    dataValue :STRING
) ;

Python:

def  vs.vsoEquipItemDataSet(message, dataIndex, dataValue):
   return None

Description:

Sets the specified equipment item data in the ParametricEquipmentItemDataMessage(92) message sent to a Script object based on the dataIndex.

説明

Scriptオブジェクトに送信されるParametricEquipmentItemDataMessage(92)メッセージの指定された機器アイテムデータをdataIndexに基づいて設定します。



  vsoGetCatalogPath Object Events 
Vectorworks 2018

VectorScript Declaration:

PROCEDURE   vsoGetCatalogPath
(   folderSpec :INTEGER;
    relativePath :STRING
) ;

Python:

def  vs.vsoGetCatalogPath(folderSpec, relativePath):
   return None

Description:

Get the folder specifier and options path for an object catalog

説明

オブジェクトカタログのフォルダ番号と相対パスを取得します。



  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.

説明

オブジェクトイベントに関する、コンプリートなメッセージ情報を取得します。



  vsoGetIntSizeInfo Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoGetIntSizeInfo
(   message :LONGINT;
    isz_index :INTEGER;
    displayName :STRING;
    currentValue :REAL;
    defaultValue :REAL;
    readOnly :BOOLEAN;
    isSupported :BOOLEAN
) ;

Python:

def  vs.vsoGetIntSizeInfo(message, isz_index, displayName, currentValue, defaultValue, readOnly, isSupported):
   return None

Description:

Gets the parameter information needed for interactive sizeing.

説明

インタラクティブサイジングに必要なパラメータ情報を取得します。



  vsoGetPluginStyleSym Object Events 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   vsoGetPluginStyleSym
VAR hSymDef:HANDLE ) ;

Python:

def  vs.vsoGetPluginStyleSym():
   return hSymDef

Description:

Allow an object to use its own implementation in creating and maintaining a plugin style

説明

オブジェクトにプラグインスタイルを適用可能とするために使用します。



  vsoGetQTOFunction Object Events 
Vectorworks 2022

VectorScript Declaration:

PROCEDURE   vsoGetQTOFunction
(   hObject :HANDLE;
  VAR  functionIndex :INTEGER;
  VAR  option :DYNARRAY[] of CHAR
) ;

Python:

def  vs.vsoGetQTOFunction(hObject):
   return (functionIndex, option)

Description:

Get the requested function during event 84 (kParametricGetQTOValue). The function and the option will determine what value needs to be returned during this event by calling vsoSetQTOValue.

説明

イベント84(kParametricGetQTOValue)中に要求された関数を取得します。 関数とオプションは、vsoSetQTOValueを呼び出すことにより、このイベント中に返される必要のある値を決定します。



  vsoGetUseLyrCutPlane Object Events 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   vsoGetUseLyrCutPlane
( usingLyrCutPLane:BOOLEAN ) ;

Python:

def  vs.vsoGetUseLyrCutPlane(usingLyrCutPLane):
   return None

Description:

Inticated whether an object is observing the layer cut plane

説明

オブジェクトがレイヤの切断面と連動するかどうかを指定します。



  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.

説明

オブジェクト情報パレットに表示するウィジェットを設定します。



  vsoParamName2Index Object Events 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   vsoParamName2Index
(   formatName :STRING;
    paramUnivName :STRING
) :INTEGER ;

Python:

def  vs.vsoParamName2Index(formatName, paramUnivName):
   return INTEGER

Description:

Return the zero-based index of a prameter specified by its universal name. Return -1 if not found.

説明

パラメータのユニバーサルな名前から、その項目番号を返します。なかった場合-1を返します。



  vsoPFCGetContext Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoPFCGetContext
(   message :LONGINT;
  VAR  context :INTEGER;
  VAR  viewType :INTEGER;
  VAR  bgRenderMode :INTEGER;
  VAR  fgRenderMode :INTEGER
) ;

Python:

def  vs.vsoPFCGetContext(message):
   return (context, viewType, bgRenderMode, fgRenderMode)

Description:

Retrieve the context parameters from the PrepareForContext (79) message sent to a Script object.

説明

スクリプトオブジェクトに送信された「PrepareForContext (79) 」メッセージからコンテキストパラメータを取得します。



  vsoPFCSetChanged Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoPFCSetChanged
(   message :LONGINT;
    didChange :BOOLEAN
) ;

Python:

def  vs.vsoPFCSetChanged(message, didChange):
   return None

Description:

Provide the object Changed result for the PrepareForContext (79) message sent to a Script object.

説明

スクリプトオブジェクトに送信された「PrepareForContext(79)」メッセージのオブジェクトのChanged結果を提供します。



  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)



  vsoSetClosureGap Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoSetClosureGap
(   leftGapValue :REAL;
    rightGapValue :REAL;
    topGapValue :REAL;
    bottomGapValue :REAL
) ;

Python:

def  vs.vsoSetClosureGap(leftGapValue, rightGapValue, topGapValue, bottomGapValue):
   return None

Description:

Provide a Gap for Left, Right, Top, Bottom edge of Wall Closure

説明

壁との取り合い設定の左、右、上、下の端にズレを設定します。



  vsoSetEventResult Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoSetEventResult
( inEventResult:LONGINT ) ;

Python:

def  vs.vsoSetEventResult(inEventResult):
   return None



  vsoSetGlazingArea Object Events 
Vectorworks 2020

VectorScript Declaration:

PROCEDURE   vsoSetGlazingArea
( GlazingArea:REAL ) ;

Python:

def  vs.vsoSetGlazingArea(GlazingArea):
   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 a Curtain Wall object

説明

イベント52でオブジェクトがカーテンウォールオブジェクトかどうかの情報を取得します。



  vsoSetIntSizeInfo Object Events 
Vectorworks 2023

VectorScript Declaration:

PROCEDURE   vsoSetIntSizeInfo
(   message :LONGINT;
    isz_index :INTEGER;
  VAR  newValue :REAL;
  VAR  isSupported :BOOLEAN
) ;

Python:

def  vs.vsoSetIntSizeInfo(message, isz_index):
   return (newValue, isSupported)

Description:

Sets the parameter values after interactive sizeing.

説明

インタラクティブなサイズ調整後のパラメータ値を設定する。



  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.

説明

類似オブジェクト作成のために、ツール名を設定します。kObjOnGetToolNameイベント内で使用します。



  vsoSetQTOValue Object Events 
Vectorworks 2022

VectorScript Declaration:

PROCEDURE   vsoSetQTOValue
(   valueType :INTEGER;
    int :INTEGER;
    real :REAL;
    string :DYNARRAY[] of CHAR
) ;

Python:

def  vs.vsoSetQTOValue(valueType, int, real, string):
   return None

Description:

Set a requested QTO value during event 84 (kParametricGetQTOValue). Check the requested QTO value by using vsoGetQTOFunction. 'valueType' [0:real; 1:integer; 2:string] determines which parameter is considered for the value, the others can be empty (zero).

説明

イベント84中に要求されたQTO値を設定します(kParametricGetQTOValue)。 vsoGetQTOFunctionを使用して、要求されたQTO値を確認します。 'valueType' [0:real; 1:integer; 2:string]は、値に対して考慮されるパラメーターを決定します。他のパラメーターは空(ゼロ)にすることができます。



  vsoSetSubtractPanels Object Events 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   vsoSetSubtractPanels
( inSubtractPanels:BOOLEAN ) ;

Python:

def  vs.vsoSetSubtractPanels(inSubtractPanels):
   return None

Description:

Used during event 58 to retrun whether a curtain wall object will have the wall subtract the panel from the frames

説明

イベント58でカーテンウォールオブジェクトの中のパネルがフレームからインセットしているかどうかを返します。



  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)



  vsoStateGetRotN Object Events 
Vectorworks 2020

VectorScript Declaration:

FUNCTION   vsoStateGetRotN
(   hObj :HANDLE;
  VAR  outDiffAng :VECTOR;
  VAR  outIs3D :BOOLEAN
) :BOOLEAN ;

Python:

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



  vsoStateMaterialChng Object Events 
Vectorworks 2020

VectorScript Declaration:

FUNCTION   vsoStateMaterialChng
(   hObj :HANDLE;
  VAR  materialID :INTEGER;
  VAR  deleted :BOOLEAN;
  VAR  previousTexture :INTEGER
) :BOOLEAN ;

Python:

def  vs.vsoStateMaterialChng(hObj):
   return (BOOLEAN, materialID, deleted, previousTexture)

Description:

ObjectState event is sent to Parametric objects when Material is changed.

説明

マテリアルが変更されると、ObjectStateイベントをパラメトリックオブジェクトに送るようにします。



  vsoStyleWidgetChoice Object Events 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   vsoStyleWidgetChoice
VAR choice:INTEGER ) ;

Python:

def  vs.vsoStyleWidgetChoice():
   return choice

Description:

Get the item chosen in the Plug-in Object Style widget.

説明

選択されているプラグインスタイルウィジェットの項目を取得します。



  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



  vsoWidgetPopupAddN Object Events 
Vectorworks 2020

VectorScript Declaration:

PROCEDURE   vsoWidgetPopupAddN
(   widgetID :LONGINT;
    isStaticChoice :BOOLEAN;
    id :STRING;
    text :STRING;
    toolTip :STRING;
    iconSpec :STRING
) ;

Python:

def  vs.vsoWidgetPopupAddN(widgetID, isStaticChoice, id, text, toolTip, iconSpec):
   return None

Description:

Add an item to an OIP search popup widget. Static item is fixed at the top of the list, unsearchable. Non static items are searchable displayed in a list.

説明

オブジェクト情報パレットの検索ポップアップウィジェットにアイテムを追加します。静的アイテムはリストの先頭に固定され検索はできません。非静的アイテムはリストに表示され、検索可能です。



  vsoWidgetPopupClear Object Events 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   vsoWidgetPopupClear
( widgetID:LONGINT ) ;

Python:

def  vs.vsoWidgetPopupClear(widgetID):
   return None



  vsoWidgetPopupClearN Object Events 
Vectorworks 2020

VectorScript Declaration:

PROCEDURE   vsoWidgetPopupClearN
(   widgetID :LONGINT;
    staticChoices :BOOLEAN
) ;

Python:

def  vs.vsoWidgetPopupClearN(widgetID, staticChoices):
   return None

Description:

For an OIP search popup widget, clears the static or dynamic choices.

説明

オブジェクト情報パレットの検索ポップアップウィジェットで、静的または動的選択を解除します。



  vsoWidgetPopupEnergy Object Events 
Vectorworks 2016

VectorScript Declaration:

PROCEDURE   vsoWidgetPopupEnergy
(   widgetID :LONGINT;
    dataType :INTEGER
) ;

Python:

def  vs.vsoWidgetPopupEnergy(widgetID, dataType):
   return None

Description:

Attach a widget for energy data to appear in the Object Info Palette.

説明

データパレットにエネルギー解析データのウィジェットを連結します。
VS:Energos Thirdparty Support のページを参照してください。



  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



  vsoWidgetPopupGetID Object Events 
Vectorworks 2020

VectorScript Declaration:

FUNCTION   vsoWidgetPopupGetID
(   widgetID :LONGINT;
    text :STRING
) :STRING ;

Python:

def  vs.vsoWidgetPopupGetID(widgetID, text):
   return STRING

Description:

For an OIP search popup widget, returns the IDName for an item specified by it's text.

説明

オブジェクト情報パレットの検索ポップアップウィジェットで、文字列で指定したアイテムのIDNameを返します。



  vsoWidgetPopupGetTxt Object Events 
Vectorworks 2020

VectorScript Declaration:

FUNCTION   vsoWidgetPopupGetTxt
(   widgetID :LONGINT;
    id :STRING
) :STRING ;

Python:

def  vs.vsoWidgetPopupGetTxt(widgetID, id):
   return STRING

Description:

For an OIP search popup widget, returns the text of an item specified by it's id.

説明

オブジェクト情報パレットの検索ポップアップウィジェットで、IDで指定したアイテムの文字列を返します。



  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



  vsoWidgetSetType Object Events 
Vectorworks 2020

VectorScript Declaration:

PROCEDURE   vsoWidgetSetType
(   widgetID :LONGINT;
    widgetType :LONGINT
) ;

Python:

def  vs.vsoWidgetSetType(widgetID, widgetType):
   return None

Description:

Changes a type of a widget that was already added.

説明

追加済みのウィジェットのタイプを変更します。



  vsoWidgetSetVisible Object Events 
Vectorworks 2011

VectorScript Declaration:

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

Python:

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



  vsoWSGetParamForEdit Object Events 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   vsoWSGetParamForEdit
VAR paramName:STRING ) ;

Python:

def  vs.vsoWSGetParamForEdit():
   return paramName

Description:

Get the parameter that a worksheet is trying to edit.

説明

ワークシートで編集しようとしているパラメータ名を取得します。