ArrowHead Object Attributes 

Declaration:

PROCEDURE   ArrowHead
( arrow:INTEGER ) ;

Special Notes:

ArrowHead is obsolete as of VectorWorks 8.0

Description:

Obsolete procedure.

Parameters:

arrow Arrow style constant.

See Also:

Marker  



  ArrowSize Object Attributes 

Declaration:

PROCEDURE   ArrowSize
( size:INTEGER ) ;

Special Notes:

ArrowSize is obsolete as of VectorWorks 8.0

Description:

Obsolete procedure.

Parameters:

size Arrow length.

See Also:

Marker  



  GetClass Object Attributes 

Declaration:

FUNCTION   GetClass
( h:HANDLE ) :STRING ;

Description:

Function GetClass returns the class assigned to the referenced object. None is returned if the object has no class assigned to it.

Parameters:

h Handle to object.

Example:

ObjectClass:=GetClass(handleToObject);



  GetFillBack Object Attributes 

Declaration:

PROCEDURE   GetFillBack
(   h :HANDLE;
  VAR  red :LONGINT;
  VAR  green :LONGINT;
  VAR  blue :LONGINT
) ;

Description:

Procedure GetFillBack returns the fill background color of the referenced object. The RGB color components are returned to the indicated parameters.

A color table listing with associated index values can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
red Returns RGB color component value.
green Returns RGB color component value.
blue Returns RGB color component value.

Example:

GetFillBack(handleToObject,redValue,greenValue,blueValue);

See Also:

RGBToColorIndex   ColorIndexToRGB  



  GetFillFore Object Attributes 

Declaration:

PROCEDURE   GetFillFore
(   h :HANDLE;
  VAR  red :LONGINT;
  VAR  green :LONGINT;
  VAR  blue :LONGINT
) ;

Description:

Procedure GetFillFore returns the fill foreground color of the referenced object. The RGB color components are returned to the indicated parameters.

A color table listing with associated index values can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
red Returns RGB color component value.
green Returns RGB color component value.
blue Returns RGB color component value.

Example:

GetFillFore(handleToObject,redValue,greenValue,blueValue);

See Also:

RGBToColorIndex   ColorIndexToRGB  



  GetFPat Object Attributes 

Declaration:

FUNCTION   GetFPat
( h:HANDLE ) :INTEGER ;

Description:

Function GetFPat returns the fill pattern of the referenced object.

Fill patterns and their associated constants can be found in the VectorScript Appendix.

Parameters:

h Handle to object.

Example:

FPatValue:=GetFPat(HandleToObj);



  GetLS Object Attributes 

Declaration:

FUNCTION   GetLS
( h:HANDLE ) :INTEGER ;

Description:

Function GetLS returns the line style of the referenced object.

Parameters:

h Handle to object.

Example:

lStyleValue:=GetLS(handleToObject);



  GetLW Object Attributes 

Declaration:

FUNCTION   GetLW
( h:HANDLE ) :INTEGER ;

Description:

Function GetLW returns the line weight of the referenced object. The value returned represents the width in mils.

Parameters:

h Handle to object.

Example:

lweightValue:=GetLW(handleToObject);



  GetPenBack Object Attributes 

Declaration:

PROCEDURE   GetPenBack
(   h :HANDLE;
  VAR  red :LONGINT;
  VAR  green :LONGINT;
  VAR  blue :LONGINT
) ;

Description:

Procedure GetPenBack returns the pen background color of the referenced object. The RGB color components are returned to the indicated parameters.

A color table listing with associated index values can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
red Returns RGB color component value.
green Returns RGB color component value.
blue Returns RGB color component value.

Example:

GetPenBack(handleToObject,redValue,greenValue,blueValue);

See Also:

RGBToColorIndex   ColorIndexToRGB  



  GetPenFore Object Attributes 

Declaration:

PROCEDURE   GetPenFore
(   h :HANDLE;
  VAR  red :LONGINT;
  VAR  green :LONGINT;
  VAR  blue :LONGINT
) ;

Description:

Procedure GetPenFore returns the pen foreground color components of the referenced object.

A color table listing with associated index values can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
red Returns RGB color component value.
green Returns RGB color component value.
blue Returns RGB color component value.

Example:

GetPenFore(handleToObject,redValue,greenValue,blueValue);

See Also:

ColorIndexToRGB   RGBToColorIndex  



  IsFillColorByClass Object Attributes 

Declaration:

FUNCTION   IsFillColorByClass
( h:HANDLE ) :BOOLEAN ;

Description:

Function IsFillColorByClass returns whether class fill colors are used for the referenced object.

Parameters:

h Handle to object.



  IsFPatByClass Object Attributes 

Declaration:

FUNCTION   IsFPatByClass
( h:HANDLE ) :BOOLEAN ;

Description:

Function IsFPatByClass whether a class fill pattern is used for the referenced object.

Parameters:

h Handle to object.



  IsLSByClass Object Attributes 

Declaration:

FUNCTION   IsLSByClass
( h:HANDLE ) :BOOLEAN ;

Description:

Function IsLSByClass returns whether a class line style is used for the referenced object.

Parameters:

h Handle to object.



  IsLWByClass Object Attributes 

Declaration:

FUNCTION   IsLWByClass
( h:HANDLE ) :BOOLEAN ;

Description:

Function IsLWByClass returns whether a class line weight is used for the referenced object.

Parameters:

h Handle to object.



  IsMarkerByClass Object Attributes 

Declaration:

FUNCTION   IsMarkerByClass
( h:HANDLE ) :BOOLEAN ;

Description:

Function IsMarkerByClass returns whether a class marker style is used for the referenced object.

Parameters:

h Handle to object.



  IsPenColorByClass Object Attributes 

Declaration:

FUNCTION   IsPenColorByClass
( h:HANDLE ) :BOOLEAN ;

Description:

Function IsPenColorByClass returns whether class pen colors are used for the referenced object.

Parameters:

h Handle to object.



  SetClass Object Attributes 

Declaration:

PROCEDURE   SetClass
(   h :HANDLE;
    class :STRING
) ;

Description:

Procedure SetClass assigns a class to the referenced object.

Parameters:

h Handle to object.
class Name of class to assign to object.

Example:

SetClass(ObjHd,'Dimension');



  SetFillBack Object Attributes 

Declaration:

PROCEDURE   SetFillBack
(   h :HANDLE;
    colorR :LONGINT;
    colorG :LONGINT;
    colorB :LONGINT
) ;

Description:

Procedure SetFillBack sets the fill background color setting of the specified object.

A color table listing with associated index values can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
color RGB color value.

Example:


See Also:

RGBToColorIndex   ColorIndexToRGB  



  SetFillColorByClass Object Attributes 

Declaration:

PROCEDURE   SetFillColorByClass
( h:HANDLE ) ;

Description:

Procedure SetFillColorByClass sets the referenced object to use the class attribute fill colors.

Parameters:

h Handle to object.



  SetFillFore Object Attributes 

Declaration:

PROCEDURE   SetFillFore
(   h :HANDLE;
    colorR :LONGINT;
    colorG :LONGINT;
    colorB :LONGINT
) ;

Description:

Procedure SetFillFore sets the fill foreground color setting of the referenced object.

A color table listing with associated index values can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
color RGB color value.

Example:

S

See Also:

RGBToColorIndex   ColorIndexToRGB  



  SetFPat Object Attributes 

Declaration:

PROCEDURE   SetFPat
(   h :HANDLE;
    fillPattern :INTEGER
) ;

Description:

Procedure SetFPat sets the fill pattern of the referenced object.

Fill patterns and their associated constants can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
fillPattern Fill pattern index value.

Example:

SetFPat(ObjHd,47);



  SetFPatByClass Object Attributes 

Declaration:

PROCEDURE   SetFPatByClass
( h:HANDLE ) ;

Description:

Procedure SetFPatByClass sets the referenced object to use the class attribute fill pattern.

Parameters:

h Handle to object.



  SetLS Object Attributes 

Declaration:

PROCEDURE   SetLS
(   h :HANDLE;
    ls :INTEGER
) ;

Description:

Procedure SetLS sets the linestyle of the referenced object.

If the value is in the range 0 to 71, the specified pen pattern is applied as the linestyle; a value in the range of -1 to -8 will apply the specified linestyle.

Parameters:

h Handle to object.
ls Linestyle to apply to object.

Example:

SetLS(objHd,-3);
{applies a linestyle to the referenced object}

SetLS(objHd,32);
{applies a fill pattern to the referenced object}



  SetLSByClass Object Attributes 

Declaration:

PROCEDURE   SetLSByClass
( h:HANDLE ) ;

Description:

Procedure SetLSByClass sets the referenced object to use the class attribute line style.

Parameters:

h Handle to object.



  SetLW Object Attributes 

Declaration:

PROCEDURE   SetLW
(   h :HANDLE;
    lw :INTEGER
) ;

Description:

Procedure SetLW sets the line weight of the referenced object.

Parameters:

h Handle to object
lw Line wieght to be applied to object(in mils).

Example:

SetLW(ObjHd,12);



  SetLWByClass Object Attributes 

Declaration:

PROCEDURE   SetLWByClass
( h:HANDLE ) ;

Description:

Procedure SetLWByClass sets the referenced object to use the class attribute line weight.

Parameters:

h Handle to object.



  SetMarkerByClass Object Attributes 

Declaration:

PROCEDURE   SetMarkerByClass
( h:HANDLE ) ;

Description:

Procedure SetMarkerByClass sets the referenced object to use the class attribute marker style.

Parameters:

h Handle to object.



  SetPenBack Object Attributes 

Declaration:

PROCEDURE   SetPenBack
(   h :HANDLE;
    colorR :LONGINT;
    colorG :LONGINT;
    colorB :LONGINT
) ;

Description:

Procedure SetPenBack sets the pen background color of the referenced object.

A color table listing with associated index values can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
color RGB color value.

See Also:

RGBToColorIndex   ColorIndexToRGB  



  SetPenColorByClass Object Attributes 

Declaration:

PROCEDURE   SetPenColorByClass
( h:HANDLE ) ;

Description:

Procedure SetPenColorByClass sets the referenced object to use the class attribute pen colors.

Parameters:

h Handle to object.



  SetPenFore Object Attributes 

Declaration:

PROCEDURE   SetPenFore
(   h :HANDLE;
    colorR :LONGINT;
    colorG :LONGINT;
    colorB :LONGINT
) ;

Description:

Procedure SetPenFore sets the pen foreground color of the referenced object.

A color table listing with associated index values can be found in the VectorScript Appendix.

Parameters:

h Handle to object.
color RGB color value.

Example:

SetPenFore(HandleToObj,65535,0,39321); 

See Also:

RGBToColorIndex   ColorIndexToRGB