VectorScript Declaration:

PROCEDURE   DelName

( name:STRING ) ;

Python:

def  vs.DelName(name):

   return None

Description:

Procedure DelName deletes an object name from a Vectorworks document. The associated object is not affected by the name deletion.

説明

図形の名前をドキュメントから削除します。図形そのものは削除されません。

Parameters:

name

Object name to be deleted.

図形の名前

VectorScript Declaration:

FUNCTION   GetColorName

( ColorIndex:INTEGER ) :STRING ;

Python:

def  vs.GetColorName(ColorIndex):

   return STRING

Description:

Retrieves the color name of the specified color index.

説明

指定した色番号の名前を返します。

Parameters:

ColorIndex

The index of the color

色番号

Result:

The name of the color specified by the index.

返り値

指定したカラーインデックスの名前

See Also:

SetColorName  

VectorScript Declaration:

FUNCTION   GetDashLineTypeName

( DashStyleIndex:LONGINT ) :STRING ;

Python:

def  vs.GetDashLineTypeName(DashStyleIndex):

   return STRING

Description:

Retrieves the dash style name for the specified dash style using its negated internal index.

説明

指定した負の値の内部インデックスに合致する、破線/ラインタイプリソースの名前を返します。

Parameters:

DashStyleIndex

The negated internal index of the dash style.

破線の種類のインデックス(負の値)

Result:

Name of the dash style specified by the index.

返り値

インデックスで指定した破線/ラインタイプの名前を返します。

See Also:

SetDashLineTypeName  

VectorScript Declaration:

FUNCTION   GetDashStyleName

( DashStyleIndex:INTEGER ) :STRING ;

Python:

def  vs.GetDashStyleName(DashStyleIndex):

   return STRING

Special Notes:

GetDashStyleName is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetDashLineTypeName instead.

Retrieves the dash style name of the specified dash style index.

説明

指定した破線番号の名前を返します。

Parameters:

DashStyleIndex

The the index of the dash style.

破線種類の番号

Result:

Name of the dash style specified by the index.

返り値

破線種類の名前

See Also:

GetDashLineTypeName  

VectorScript Declaration:

FUNCTION   GetName

( h:HANDLE ) :STRING ;

Python:

def  vs.GetName(h):

   return STRING

Description:

Function GetName returns the object name of the referenced object. The function returns None if the object has no object name.

A handle to layer may not passed to this routine; to obtain a layer name, use GetLName.

説明

ハンドルで指定した図形の名前を返します。

Parameters:

h

Handle to object.

図形のハンドル

Example:

ObjectName:=GetName(HandleToObject);

See Also:

SetName  

VectorScript Declaration:

FUNCTION   GetObject

( name:STRING ) :HANDLE ;

Python:

def  vs.GetObject(name):

   return HANDLE

Description:

Function GetObject returns a handle to a named object. If the name does not exist, NIL is returned.

説明

指定した名前が付いた図形のハンドルを返します。図形が存在しない場合はNILを返します。

Parameters:

name

Object name.

図形の名前

VectorScript Declaration:

FUNCTION   Index2Name

( index:LONGINT ) :STRING ;

Python:

def  vs.Index2Name(index):

   return STRING

Description:

Function Index2Name returns the name of the object with specified index number.

説明

内部で使用している索引番号を文字列で返します。

Parameters:

index

Object index number.

索引番号

返り値

文字列

VectorScript Declaration:

FUNCTION   Name2Index

( name:STRING ) :LONGINT ;

Python:

def  vs.Name2Index(name):

   return LONGINT

Description:

Function Name2Index returns the internal index number for the specified object.

説明

内部で使用している文字列の索引番号を返します。

Parameters:

name

Name of object.

文字列

返り値

インデックス番号

See Also:

SetSkylight   CreateSkylight   AddCavity  

VectorScript Declaration:

FUNCTION   NameList

( index:LONGINT ) :STRING ;

Python:

def  vs.NameList(index):

   return STRING

Description:

Function NameList returns the specified object name from the object name list.

説明

指定した索引番号の名前を返します。

Parameters:

index

Name list position index (in a arange of 1 - n).

索引番号

返り値

図形の名前

VectorScript Declaration:

FUNCTION   NameNum

:LONGINT ;

Python:

def  vs.NameNum():

   return LONGINT

Description:

Function NameNum returns the number of different object names in the active Vectorworks document.

説明

アクティブなドキュメント内の名前が付いている図形の数を返します。

返り値

名前の数

VectorScript Declaration:

PROCEDURE   NameObject

( objName:STRING ) ;

Python:

def  vs.NameObject(objName):

   return None

Description:

Procedure NameObject assigns an object name to the next object created.

説明

直後に作成される図形やワークシートに名前を付けます。

Parameters:

objName

Name to be assigned to object.

図形の名前

Example:

NameObject('Part 5257');
Rect(0,2,2,0);

VectorScript Declaration:

FUNCTION   SetColorName

(   ColorIndex :INTEGER;     ColorName :STRING ) :BOOLEAN ;

Python:

def  vs.SetColorName(ColorIndex, ColorName):

   return BOOLEAN

Description:

Sets the color name of the specified color index.

説明

指定した色番号の名前を設定します。

Parameters:

ColorIndex	The index of the color to be named.	色番号
ColorName	The new name of the color specified by the index.	色番号の名前

Result:

'true' if the operation was successful.
'false' otherwise.

返り値

成功したらTRUE、その他はFALSEを返します。

See Also:

GetColorName  

VectorScript Declaration:

FUNCTION   SetDashLineTypeName

(   DashStyleIndex :LONGINT;     DashStyleName :STRING ) :BOOLEAN ;

Python:

def  vs.SetDashLineTypeName(DashStyleIndex, DashStyleName):

   return BOOLEAN

Description:

Sets the dash style name for the specified dash style using its negated internal index.

説明

指定した負の値の内部インデックスを使用して、破線/ラインタイプリソースの名前を設定します。

Parameters:

DashStyleIndex	The negated internal index of the dash style to be named.	破線の種類のインデックス
DashStyleName	The new name of the line type.	破線の種類の名前

Result:

'true' if the operation was successful.
'false' otherwise.

返り値

成功した場合TRUEを返します。
それ以外の場合はFALSEを返します。

See Also:

GetDashLineTypeName  

VectorScript Declaration:

FUNCTION   SetDashStyleName

(   DashStyleIndex :INTEGER;     DashStyleName :STRING ) :BOOLEAN ;

Python:

def  vs.SetDashStyleName(DashStyleIndex, DashStyleName):

   return BOOLEAN

Special Notes:

SetDashStyleName is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use SetDashLineTypeName instead.

説明

指定した破線番号の名前を設定します。

Parameters:

DashStyleIndex	The index of the dash style to be named.	破線種類の番号
DashStyleName	The new name of the dash style specified by the index.	破線種類の名前

返り値

成功したらTRUE、その他はFALSEを返します。

See Also:

SetDashLineTypeName  

VectorScript Declaration:

PROCEDURE   SetName

(   h :HANDLE;     name :STRING ) ;

Python:

def  vs.SetName(h, name):

   return None

Description:

Procedure SetName assigns a name to the referenced object.

説明

ハンドルで指定した図形の名前を設定します。

Parameters:

h	Handle to object.	図形のハンドル
name	Name to be assigned to object.	図形の名前

Example:

PROCEDURE Example;
VAR
	h1    :HANDLE;
	SName :STRING;
BEGIN
	SName := 'Fred';
	h1 := CreateSphere(0, 0, 0, 1000);
	SetName(h1, SName);
END;
RUN(Example);

See Also:

GetName