Data Sheets

Data Sheets
Vectorworks 2020.1

VectorScript Declaration:

FUNCTION DSH_GetDSCount

( hObject :HANDLE;

VAR outCount :INTEGER

) :BOOLEAN ;

Python:

def vs.DSH_GetDSCount(hObject):
return (BOOLEAN, outCount)

Description:

Gets Data Sheets count for Object.

説明

オブジェクトのデータシートの数を返します。

DSH_GetDSFieldInfoAt

Data Sheets
Vectorworks 2020.1

VectorScript Declaration:

FUNCTION DSH_GetDSFieldInfoAt

( hObject :HANDLE;

dsName :STRING;

VAR fieldIndex :INTEGER;

VAR outUniSrc :STRING;

VAR outLocSrc :STRING;

VAR outLabel :STRING

) :BOOLEAN ;

Python:

def vs.DSH_GetDSFieldInfoAt(hObject, dsName):
return (BOOLEAN, fieldIndex, outUniSrc, outLocSrc, outLabel)

Description:

Gets Object's Data Sheet field universal and localized sources and label.

説明

オブジェクトのデータシートフィールドのユニバーサルソースとローカライズソース、ラベルの値をそれぞれ返します。

DSH_GetDSFieldsCount

Data Sheets
Vectorworks 2020.1

VectorScript Declaration:

FUNCTION DSH_GetDSFieldsCount

( hObject :HANDLE;

dsName :STRING;

VAR outCount :INTEGER

) :BOOLEAN ;

Python:

def vs.DSH_GetDSFieldsCount(hObject, dsName):
return (BOOLEAN, outCount)

Description:

Gets Object's Data Sheet fields count.

説明

オブジェクトのデータシートフィールドの数を返します。

DSH_GetDSFieldValue

Data Sheets
Vectorworks 2020.1

VectorScript Declaration:

FUNCTION DSH_GetDSFieldValue

( hObject :HANDLE;

dsName :STRING;

fieldLabel :STRING;

VAR outValue :STRING;

VAR outStatus :INTEGER;

VAR outType :INTEGER

) :BOOLEAN ;

Python:

def vs.DSH_GetDSFieldValue(hObject, dsName, fieldLabel):
return (BOOLEAN, outValue, outStatus, outType)

Description:

Gets Object's Data Sheet field value, operation status(disabled/enabled/invisible/black/red), value source type (not set/from instance/from mapping).

説明

オブジェクトのデータシートフィールドの値、動作状態（無効/有効/非表示/黒字表示/赤字表示）、値のソースタイプ（未設定/インスタンスから/マッピングから）を返します。

DSH_GetDSNameAt

Data Sheets
Vectorworks 2020.1

VectorScript Declaration:

FUNCTION DSH_GetDSNameAt

( hObject :HANDLE;

VAR dsIndex :INTEGER;

VAR outDataSheetName :STRING

) :BOOLEAN ;

Python:

def vs.DSH_GetDSNameAt(hObject):
return (BOOLEAN, dsIndex, outDataSheetName)

Description:

Gets Object's Data Sheet Name for specified index.

説明

指定したインデックスのオブジェクトのデータシートの名前を返します。

DSH_SetDSFieldValue

Data Sheets
Vectorworks 2020.1

VectorScript Declaration:

FUNCTION DSH_SetDSFieldValue

( hObject :HANDLE;

dsName :STRING;

fieldLabel :STRING;

value :STRING;

VAR outStatus :INTEGER

) :BOOLEAN ;

Python:

def vs.DSH_SetDSFieldValue(hObject, dsName, fieldLabel, value):
return (BOOLEAN, outStatus)

Description:

Sets Object's Data Sheet field value and returns the operation status(disabled/enabled/invisible/black/red).

説明

オブジェクトのデータシートフィールドの値を設定して、その動作状態（無効/有効/非表示/黒字表示/赤字表示）を返します。