DelName Object Names 
MiniCAD

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.



  GetColorName Object Names 
Vectorworks 2011

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  



  GetDashStyleName Object Names 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   GetDashStyleName
( DashStyleIndex:INTEGER ) :STRING ;

Python:

def  vs.GetDashStyleName(DashStyleIndex):
   return STRING

Description:

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:

SetDashStyleName  



  GetName Object Names 
MiniCAD

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  



  GetObject Object Names 
MiniCAD

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.

Parameters:

name Object name.



  Index2Name Object Names 
VectorWorks8.0

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.



  Name2Index Object Names 
VectorWorks8.0

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  



  NameList Object Names 
MiniCAD

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).



  NameNum Object Names 
MiniCAD

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.




  NameObject Object Names 
MiniCAD

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);



  SetColorName Object Names 
Vectorworks 2011

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.

See Also:

GetColorName  



  SetDashStyleName Object Names 
Vectorworks 2011

VectorScript Declaration:

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

Python:

def  vs.SetDashStyleName(DashStyleIndex, DashStyleName):
   return BOOLEAN

Description:

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

Parameters:

DashStyleIndex The index of the dash style to be named.
DashStyleName The new name of the dash style specified by the index.

Result:

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

See Also:

GetDashStyleName  



  SetName Object Names 
MiniCAD

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