VectorScript Declaration:

FUNCTION   ActiveClass

:STRING ;

Python:

def  vs.ActiveClass():

   return STRING

Description:

Returns the name of the active class of the document.

説明

アクティブなクラスの名前を返します。

Example:

activeClName:= ActiveClass;

See Also:

ActLayer   ActSymDef  

VectorScript Declaration:

FUNCTION   ClassList

( index:LONGINT ) :STRING ;

Python:

def  vs.ClassList(index):

   return STRING

Description:

Returns the name of the specified class in the document class list. For example, ClassList(4) will return the name of the fourth class in the list.

説明

指定した索引番号をもつクラスの名前を返します。例えば、索引番号を4とすると4番目のクラスの名前を返します。

Parameters:

index

Index of class in class list (range of 1- n).

索引番号（1からnの範囲）

Example:

noneClass := ClassList(1);
dimensionClass := ClassList(2);
classNumber3 := ClassList(3);
classNumber4 := ClassList(4);

See Also:

ClassNum  

VectorScript Declaration:

FUNCTION   ClassNum

:LONGINT ;

Python:

def  vs.ClassNum():

   return LONGINT

Description:

Returns the total number of classes in the active document.

説明

アクティブなドキュメント内のクラスの数を返します。

Example:

numOfClasses:= ClassNum;

VectorScript Declaration:

FUNCTION   CLDropShadowEnabled

( className:STRING ) :BOOLEAN ;

Python:

def  vs.CLDropShadowEnabled(className):

   return BOOLEAN

VectorScript Declaration:

PROCEDURE   DelClass

( className:STRING ) ;

Python:

def  vs.DelClass(className):

   return None

Description:

Deletes the specified class from the active document. If there are objects in the class to be deleted, they are reassigned to the None class.

説明

アクティブなドキュメントから指定した名前のクラスを削除します。削除するクラスにある図形は「一般」クラスに割り当てられます。

Parameters:

className

Name of class to delete.

クラスの名前

Example:

DelClass('Future Construction');

VectorScript Declaration:

PROCEDURE   EnableCLDropShadow

(   className :STRING;     enable :BOOLEAN ) ;

Python:

def  vs.EnableCLDropShadow(className, enable):

   return None

VectorScript Declaration:

PROCEDURE   FillColorByClass

;

Python:

def  vs.FillColorByClass():

   return None

Description:

Sets the default document fill colors to the fill colors of the active class.

説明

デフォルトの面の色として、アクティブなクラスの面の色を使います。

See Also:

PenColorByClass   MarkerByClass   FPatByClass  

VectorScript Declaration:

PROCEDURE   FPatByClass

;

Python:

def  vs.FPatByClass():

   return None

Description:

Sets the default document fill pattern to the fill pattern of the active class.

説明

デフォルトの面の模様として、アクティブなクラスの面の模様を使います。

See Also:

PenColorByClass   MarkerByClass   FillColorByClass  

VectorScript Declaration:

PROCEDURE   GetClassArrow

(   className :STRING;   VAR  style :INTEGER;   VAR  size :REAL;   VAR  angle :INTEGER ) ;

Python:

def  vs.GetClassArrow(className):

   return (style, size, angle)

Special Notes:

GetClassArrow is obsolete as of VectorWorks 2008

Description:

Procedure GetClassArrow returns the arrow style parameters for the indicated class.

説明

クラスに設定されているマーカスタイル、長さ（インチ）、角度（度数）を返します。

VW2008で使用できなくなった関数／手続きです。
GetClassBeginningMarker、GetClassEndMarkerをご利用ください。

Parameters:

className	The indicated class.	クラスの名前
style	Returns arrow style.	スタイル
size	Returns arrow size in inches measured in page space.	長さ（インチ）
angle	Returns arrow angle (in degrees).	角度（度数）

Example:

PROCEDURE ShowNoneClassArrowValues;
VAR
	style :INTEGER;
	size  :REAL;
	ang   :INTEGER;
BEGIN
	GetClassArrow('None', style, size, ang);
	Message(style, ' ', size, ' ', ang);
END;
RUN(ShowNoneClassArrowValues);

VectorScript Declaration:

FUNCTION   GetClassBeginningMarker

(   name :STRING;   VAR  style :LONGINT;   VAR  angle :INTEGER;   VAR  size :REAL;   VAR  width :REAL;   VAR  thicknessBasis :INTEGER;   VAR  thickness :REAL ) :BOOLEAN ;

Python:

def  vs.GetClassBeginningMarker(name):

   return (BOOLEAN, style, angle, size, width, thicknessBasis, thickness)

Description:

Gets all properties for the named class' beginning marker. Return TRUE if operation was successful.

説明

指定したクラスの始点マーカのすべての設定値を返します。正常終了するとTRUEが返されます。

Parameters:

name	Name of the class	クラスの名前
style	The marker style (see comments for details)	タイプ
angle	The marker angle in degrees (0 to 90)	角度（度数、0から90）
size	The marker size in pages inches	長さ（インチ）
width	The marker width in page inches	幅（インチ）
thicknessBasis	The marker thickness basis. ( see comments for details)	太さ
thickness	The marker thickness	カスタム設定の太さ

Example:

PROCEDURE Example;
VAR
	ok : BOOLEAN;
style: INTEGER;
	angle: INTEGER;
	size: REAL;
	width: REAL;
	thickBasis: INTEGER;
	thickness: REAL;
	
BEGIN
	ok := GetClassBeginningMarker('None', style, angle, size, width, thickBasis, thickness);	
Message (style, ' /  ', angle, '  /  ', size, '  /  ', width, ' /  ', thickBasis, ' /  ', thickness);	

END;

RUN(Example);

See Also:

GetClassEndMarker  

VectorScript Declaration:

FUNCTION   GetClassEndMarker

(   name :STRING;   VAR  style :LONGINT;   VAR  angle :INTEGER;   VAR  size :REAL;   VAR  width :REAL;   VAR  thicknessBasis :INTEGER;   VAR  thickness :REAL ) :BOOLEAN ;

Python:

def  vs.GetClassEndMarker(name):

   return (BOOLEAN, style, angle, size, width, thicknessBasis, thickness)

Description:

Gets all properties for the named class's end marker. Return TRUE if operation was successful.

説明

指定したクラスの終点マーカのすべての設定値を返します。正常終了するとTRUEが返されます。

Parameters:

name	Name of the class	クラスの名前
style	The marker style (see comments for details)	タイプ
angle	The marker angle in degrees (0 to 90)	角度（度数、0から90）
size	The marker size in pages inches	長さ（インチ）
width	The marker width in page inches	幅（インチ）
thicknessBasis	The marker thickness basis. ( see comments for details)	太さ
thickness	The marker thickness	カスタム設定の太さ

Example:

PROCEDURE Example;
VAR
	ok : BOOLEAN;
style: INTEGER;
	angle: INTEGER;
	size: REAL;
	width: REAL;
	thickBasis: INTEGER;
	thickness: REAL;
	
BEGIN
	ok := GetClassEndMarker('None', style, angle, size, width, thickBasis, thickness);	
Message (style, ' /  ', angle, '  /  ', size, '  /  ', width, ' /  ', thickBasis, ' /  ', thickness);	

END;

RUN(Example);

VectorScript Declaration:

FUNCTION   GetClassOptions

:INTEGER ;

Python:

def  vs.GetClassOptions():

   return INTEGER

Description:

Returns the class visibility setting for the active document.

Visibility	Index
Active Only	1
Gray Others	2
Gray/Snap Others	6
Show Others	3
Show/Snap Others	4
Show/Snap/Modify Others	5

説明

アクティブなドキュメントの、他のクラスの表示方法を値で返します。

Result:

An INTEGER value indicating the current class visibility setting for the document.

返り値

クラス表示値を返します。

See Also:

SetClassOptions  

VectorScript Declaration:

PROCEDURE   GetCLDrpShadowData

(   className :STRING;   VAR  nUnits :INTEGER;   VAR  dOffset :REAL;   VAR  dBlurRadius :REAL;   VAR  dAngle :REAL;   VAR  nOpacity :INTEGER;   VAR  colorRV :INTEGER;   VAR  colorGV :INTEGER;   VAR  colorBV :INTEGER ) ;

Python:

def  vs.GetCLDrpShadowData(className):

   return (nUnits, dOffset, dBlurRadius, dAngle, nOpacity, colorRV, colorGV, colorBV)

VectorScript Declaration:

PROCEDURE   GetClFillBack

(   className :STRING;   VAR  colorRV :LONGINT;   VAR  colorGV :LONGINT;   VAR  colorBV :LONGINT ) ;

Python:

def  vs.GetClFillBack(className):

   return (colorRV, colorGV, colorBV)

Description:

Returns the fill background color setting of the specified class. The color is returned as the three RGB components of the color. RGB values are in the range of 0~65535.

説明

クラスに設定されている面の地色の成分を返します。色は赤、緑、青の成分として返されます。値の範囲は0から65535までです。

Parameters:

className	Name of class.	クラスの名前
colorRV	Returns RGB color component (red).	赤の成分
colorGV	Returns RGB color component (green).	緑の成分
colorBV	Returns RGB color component (blue).	青の成分

Example:

GetClFillBack('Grassy Cover',cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);

VectorScript Declaration:

PROCEDURE   GetClFillFore

(   className :STRING;   VAR  colorRV :LONGINT;   VAR  colorGV :LONGINT;   VAR  colorBV :LONGINT ) ;

Python:

def  vs.GetClFillFore(className):

   return (colorRV, colorGV, colorBV)

Description:

Returns the fill foreground color setting of the specified class. The color is returned as the RGB components of the color. RGB values are in the range of 0~65535.

説明

クラスに設定されている面の色成分を返します。色は赤、緑、青の成分として返されます。値の範囲は0から65535までです。

Parameters:

className	Name of class.	クラスの名前
colorRV	Returns RGB color component (red).	赤の成分
colorGV	Returns RGB color component (green).	緑の成分
colorBV	Returns RGB color component (blue).	青の成分

Example:

GetClFillFore('Grassy Cover',cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);

VectorScript Declaration:

FUNCTION   GetClFPat

( className:STRING ) :LONGINT ;

Python:

def  vs.GetClFPat(className):

   return LONGINT

Description:

Returns the fill or hatch pattern of the specified class.

A positive return value in a range of 0 to 71 is the index of the bitmap fill pattern of the class. A negative value is the negative of the fill pattern index (index * -1).

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

説明

クラスに設定されている面の模様を返します。

ビットマップは0から71までの正の値で示されています。ハッチングは負の値で示されています。

Parameters:

className

Name of class.

クラスの名前

Example:

pbFillStyl:= GetClFPat('Grassy Cover');

VectorScript Declaration:

FUNCTION   GetClLS

( className:STRING ) :INTEGER ;

Python:

def  vs.GetClLS(className):

   return INTEGER

Special Notes:

GetClLS is obsolete as of Vectorworks 2013

Description:

Deprecated - will generate error. Use GetClLSN instead.
Returns the line style of the specified class.

説明

クラスに設定されている線の種類を返します。

Parameters:

className

Name of class.

クラスの名前

Example:

pbLineSty:= GetClLS('Property Bounds');

See Also:

GetClLSN   

VectorScript Declaration:

FUNCTION   GetClLSN

( className:STRING ) :LONGINT ;

Python:

def  vs.GetClLSN(className):

   return LONGINT

Description:

Returns the line style of the specified class.

説明

クラスに設定されている線の種類を返します。

Parameters:

className

Name of class.

クラスの名前

See Also:

SetClLSN  

VectorScript Declaration:

FUNCTION   GetClLW

( className:STRING ) :INTEGER ;

Python:

def  vs.GetClLW(className):

   return INTEGER

Description:

Returns the line weight of the specified class.

説明

クラスに設定されている線の太さを返します。

Parameters:

className

Name of class.

クラスの名前

Example:

pbLineWt:= GetClLW('Property Bounds');

VectorScript Declaration:

FUNCTION   GetClOpacity

( className:STRING ) :INTEGER ;

Python:

def  vs.GetClOpacity(className):

   return INTEGER

Description:

Gets the opacity of the specified class.

説明

指定したクラスの不透明度を返します。

VectorScript Declaration:

PROCEDURE   GetClOpacityN

(   strClassName :STRING;   VAR  outFillOpacity :INTEGER;   VAR  outPenOpacity :INTEGER ) ;

Python:

def  vs.GetClOpacityN(strClassName):

   return (outFillOpacity, outPenOpacity)

VectorScript Declaration:

PROCEDURE   GetClPenBack

(   className :STRING;   VAR  colorRV :LONGINT;   VAR  colorGV :LONGINT;   VAR  colorBV :LONGINT ) ;

Python:

def  vs.GetClPenBack(className):

   return (colorRV, colorGV, colorBV)

Description:

Returns the pen background color setting of the specified class. The color is returned as the three RGB components of the color. RGB values are in the range of 0~65535.

説明

クラスに設定されている線の地色の成分を返します。色は赤、緑、青の成分として返されます。値の範囲は0から65535までです。

Parameters:

className	Name of class.	クラスの名前
colorRV	Returns RGB color component (red).	赤の成分
colorGV	Returns RGB color component (green).	緑の成分
colorBV	Returns RGB color component (blue).	青の成分

VectorScript Declaration:

PROCEDURE   GetClPenFore

(   className :STRING;   VAR  colorRV :LONGINT;   VAR  colorGV :LONGINT;   VAR  colorBV :LONGINT ) ;

Python:

def  vs.GetClPenFore(className):

   return (colorRV, colorGV, colorBV)

Description:

Returns the pen foreground color setting of the specified class. The color is returned as the three RGB components of the color. RGB values are in the range of 0~65535.

説明

クラスに設定されている線の色成分を返します。色は赤、緑、青の成分として返されます。値の範囲は0から65535までです。

Parameters:

className	Name of class.	クラスの名前
colorRV	Returns RGB color component (red).	赤の成分
colorGV	Returns RGB color component (green).	緑の成分
colorBV	Returns RGB color component (blue).	青の成分

Example:

GetClPenFore('Grassy Cover',cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);

VectorScript Declaration:

FUNCTION   GetClTextStyleRef

( className:STRING ) :LONGINT ;

Python:

def  vs.GetClTextStyleRef(className):

   return LONGINT

Description:

Function GetClTextStyleRef gets the text style of the specified class. The integer style is the internal index of the text style.

説明

指定したクラスの文字スタイルのインデックスを返します。

Parameters:

className

Name of class

クラスの名前

See Also:

SetClUseTextStyle   GetClUseTextStyle   SetClTextStyleRef  

VectorScript Declaration:

FUNCTION   GetClUseGraphic

( className:STRING ) :BOOLEAN ;

Python:

def  vs.GetClUseGraphic(className):

   return BOOLEAN

Description:

Returns whether the graphic attributes of the specified class will be used at object creation.

説明

クラスに設定されているグラフィック属性が有効か無効かを返します。

Parameters:

className

Name of class.

クラスの名前

Result:

True indicates that this class is set to use its graphic attributes when objects are created in this class. False indicates that the objects created in this class will get default attributes from the default global attribute settings.

返り値

TRUE：グラフィック属性が有効です。
FALSE：グラフィック属性が無効です。

VectorScript Declaration:

FUNCTION   GetClUseTextStyle

( className:STRING ) :BOOLEAN ;

Python:

def  vs.GetClUseTextStyle(className):

   return BOOLEAN

Description:

Function GetClUseTextStyle returns whether the text style of the specified class is used at object creation.

説明

指定したクラスの文字スタイルの使用の有無を返します。

Parameters:

className

Name of class

クラスの名前

See Also:

SetClUseTextStyle   SetClTextStyleRef   GetClTextStyleRef  

VectorScript Declaration:

FUNCTION   GetClVectorFill

(   className :STRING;   VAR  hatchName :STRING ) :BOOLEAN ;

Python:

def  vs.GetClVectorFill(className):

   return (BOOLEAN, hatchName)

Description:

Returns the name of the hatch pattern setting of the specified class.

The function return value will be TRUE if the class uses a hatch pattern, and will be FALSE if the class does not use a hatch pattern.

説明

クラスに設定されているハッチングの名前を返します。

そのクラスがハッチングを利用している場合はTRUE、利用していない場合はFALSEを返します。

Parameters:

className	Name of class.	クラスの名前
hatchName	Name of active hatch pattern (if it exists).	ハッチングの名前

VectorScript Declaration:

FUNCTION   GetCVis

( className:STRING ) :INTEGER ;

Python:

def  vs.GetCVis(className):

   return INTEGER

Description:

Returns the visibility status of the specified class.

Visibility	Index Value
Visible	0
Hidden	-1
Grayed	2

説明

クラスの表示状態を返します。

Parameters:

className

Name of class.

クラスの名前

Result:

Visibility	Index Value
Visible	0
Hidden	-1
Grayed	2

返り値

表示状態を返します。表示状態：表示＝0／非表示＝－1／グレイ表示＝2

Example:

PROCEDURE Example;
BEGIN
	Message(GetCVis('Dimension'));
END;
RUN(Example);

VectorScript Declaration:

PROCEDURE   GrayClass

( className:STRING ) ;

Python:

def  vs.GrayClass(className):

   return None

Description:

Sets the visibility of the specified class to grayed status.

説明

指定したクラスをグレイ表示にします。

Parameters:

className

Name of class.

クラスの名前

Example:

GrayClass('Phase 2 Construction');

VectorScript Declaration:

PROCEDURE   HideClass

( className:STRING ) ;

Python:

def  vs.HideClass(className):

   return None

Description:

Sets the class visibility of the specified class to hidden (invisible) status.

説明

指定したクラスを隠します。

Parameters:

className

Name of class.

クラスの名前

Example:

HideClass('Dimension');

See Also:

ShowClass  

VectorScript Declaration:

PROCEDURE   LSByClass

;

Python:

def  vs.LSByClass():

   return None

Description:

Sets the default document line style to the line style of the active class.

説明

デフォルトの線の種類として、アクティブなクラスの線の種類を使います。

VectorScript Declaration:

PROCEDURE   LWByClass

;

Python:

def  vs.LWByClass():

   return None

Description:

Sets the default document line weight to the line weight of the active class.

説明

デフォルトの線の太さとして、アクティブなクラスの線の太さを使います。

VectorScript Declaration:

PROCEDURE   MarkerByClass

;

Python:

def  vs.MarkerByClass():

   return None

Description:

Sets the default document marker style to the marker style of the active class.

説明

デフォルトのマーカの種類として、アクティブなクラスのマーカの種類を使います。

VectorScript Declaration:

PROCEDURE   NameClass

( className:STRING ) ;

Python:

def  vs.NameClass(className):

   return None

Description:

Creates a new class in a Vectorworks document, which then become the active class.
If the specified class already exists, then it will become the active class of the document.

Note: Class names cannot exceed 20 characters.

説明

新しいクラスを指定した名前で作成し、アクティブにします。
指定した名前のクラスが存在する場合は、そのクラスがアクティブになります。

Parameters:

className

Name of class.

クラスの名前

Example:

NameClass('Revisions');
Rect(4,4,6,6);

{Create a class 'Revisions' in the document}
{The rectangle is then assigned this class }

VectorScript Declaration:

PROCEDURE   OpacityByClass

;

Python:

def  vs.OpacityByClass():

   return None

Description:

Sets the document default settings to the opacity of the active class.

説明

アクティブクラスの不透明度にファイルのデフォルト設定を使用します。

VectorScript Declaration:

PROCEDURE   OpacityByClassN

(   fillOpacityByClass :BOOLEAN;     penOpacityByClass :BOOLEAN ) ;

Python:

def  vs.OpacityByClassN(fillOpacityByClass, penOpacityByClass):

   return None

VectorScript Declaration:

PROCEDURE   PenColorByClass

;

Python:

def  vs.PenColorByClass():

   return None

Description:

Sets the default document pen colors to the pen colors of the active class.

説明

デフォルトの線の色として、アクティブなクラスの線の色を使います。

See Also:

FillColorByClass  

VectorScript Declaration:

PROCEDURE   RenameClass

(   className :STRING;     newName :STRING ) ;

Python:

def  vs.RenameClass(className, newName):

   return None

Description:

Renames the specified class.

All objects assigned to the class being renamed are updated.

説明

クラスの名前を変更します。

変更されたクラスに割り当てられていたオブジェクトがすべて更新されます。

Parameters:

className	Existing name of the class.	現在のクラス名
newName	New name for the class.	新しいクラス名

VectorScript Declaration:

PROCEDURE   SetClassArrow

(   className :STRING;     style :INTEGER;     size :REAL;     angle :INTEGER ) ;

Python:

def  vs.SetClassArrow(className, style, size, angle):

   return None

Special Notes:

SetClassArrow is obsolete as of VectorWorks 2008

Description:

Procedure SetClassArrow sets the arrow style parameters for the indicated class.

説明

クラスのマーカを設定します。

VW2008で使用できなくなった関数／手続きです。
SetClassBeginningMarker、SetClassEndMarkerをご利用ください。

Parameters:

className	The indicated class.	クラスの名前
style	The arrow style.	スタイル
size	The arrow size in inches measured in page space.	長さ（インチ）
angle	The arrow angle (in degrees).	角度（度）

Example:

SetClassArrow('None', 2, 0.25, 15);

VectorScript Declaration:

FUNCTION   SetClassBeginningMarker

(   name :STRING;     style :LONGINT;     angle :INTEGER;     size :REAL;     width :REAL;     thicknessBasis :INTEGER;     thickness :REAL ) :BOOLEAN ;

Python:

def  vs.SetClassBeginningMarker(name, style, angle, size, width, thicknessBasis, thickness):

   return BOOLEAN

Description:

Sets all properties for the named class' beginning marker. Return TRUE if operation was successful.

説明

指定したクラスの始点マーカのすべての設定値を設定します。正常終了するとTRUEが返されます。

Parameters:

name	Name of the class	クラスの名前
style	The marker style (see comments for details)	タイプ
angle	The marker angle in degrees (0 to 90)	角度（度数、0から90）
size	The marker size in pages inches	長さ（インチ）
width	The marker width in page inches	幅（インチ）
thicknessBasis	The marker thickness basis. ( see comments for details)	太さ
thickness	The marker thickness	カスタム設定の太さ

Example:

PROCEDURE Example;
VAR
	ok : BOOLEAN;	
BEGIN
	ok := SetClassBeginningMarker('None', 1280, 45, 0.25, 0.25, 0, 2);	
END;

RUN(Example);

See Also:

SetClassEndMarker  

VectorScript Declaration:

FUNCTION   SetClassEndMarker

(   name :STRING;     style :LONGINT;     angle :INTEGER;     size :REAL;     width :REAL;     thicknessBasis :INTEGER;     thickness :REAL ) :BOOLEAN ;

Python:

def  vs.SetClassEndMarker(name, style, angle, size, width, thicknessBasis, thickness):

   return BOOLEAN

Description:

Sets all properties for the named class's end marker. Return TRUE if operation was successful.

説明

指定したクラスの終点マーカのすべての設定値を設定します。正常終了するとTRUEが返されます。

Parameters:

name	Name of the class.	クラスの名前
style	The marker style. (see comments for details)	タイプ
angle	The marker angle in degrees. (0 to 90)	角度（度数、0から90）
size	The marker size in page inches.	長さ（インチ）
width	The marker width in page inches.	幅（インチ）
thicknessBasis	The marker thickness basis. ( see comments for details)	太さ
thickness	The marker thickness.	カスタム設定の太さ

Example:

PROCEDURE Example;
VAR
	ok : BOOLEAN;
BEGIN
	ok := SetClassEndMarker('None', 1280, 25, 0.125, 0.125, 0, 2);
END;

RUN(Example);

See Also:

SetClassBeginningMarker  

VectorScript Declaration:

PROCEDURE   SetClassOptions

( classOpts:INTEGER ) ;

Python:

def  vs.SetClassOptions(classOpts):

   return None

Description:

Sets class visibility setting for the active document.

Visibility	Index
Active Only	1
Gray Others	2
Gray/Snap Others	6
Show Others	3
Show/Snap Others	4
Show/Snap/Modify Others	5

説明

他のクラスの表示状態を設定します。

Parameters:

classOpts

New class visibility setting.

表示状態

VectorScript Declaration:

PROCEDURE   SetCLDrpShadowData

(   className :STRING;     nUnits :INTEGER;     dOffset :REAL;     dBlurRadius :REAL;     dAngle :REAL;     nOpacity :INTEGER;     colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.SetCLDrpShadowData(className, nUnits, dOffset, dBlurRadius, dAngle, nOpacity, color):

   return None

VectorScript Declaration:

PROCEDURE   SetClFillBack

(   className :STRING;     colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.SetClFillBack(className, color):

   return None

Description:

Sets the fill background color of the specified class. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

説明

クラスの面の地色を設定します。色は赤、緑、青の成分で指定します。値の範囲は0から65535までです。

Parameters:

className	Name of class.	クラスの名前
color	RGB color value.	赤、緑、青の成分

Example:

ColorIndexToRGB(98,cRed,cGrn,cBlu);
SetClFillBack('Grassy Cover',cRed,cGrn,cBlu);

VectorScript Declaration:

PROCEDURE   SetClFillFore

(   className :STRING;     colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.SetClFillFore(className, color):

   return None

Description:

Sets the fill foreground color of the specified class. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

説明

クラスの面の色を設定します。色は赤、緑、青の成分で指定します。値の範囲は0から65535までです。

Parameters:

className	Name of class.	クラスの名前
color	RGB color value.	赤、緑、青の成分

Example:

ColorIndexToRGB(24,cRed,cGrn,cBlu);
SetClFillFore('Grassy Cover',cRed,cGrn,cBlu);

VectorScript Declaration:

PROCEDURE   SetClFPat

(   className :STRING;     fillpattern :LONGINT ) ;

Python:

def  vs.SetClFPat(className, fillpattern):

   return None

Description:

Sets the fill pattern of the specified class.

To apply a bitmap fill pattern, use a positive value corresponding to the desired fill pattern index. To apply a vector fill, use the negative of the index of the vector fill (index * -1).

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

説明

クラスの面の模様を設定します。

ビットマップは0から71までの正の値で示されています。ハッチングは負の値で示されています。

Parameters:

className	Name of class.	クラスの名前
fillpattern	Fill pattern index value.	模様番号

Example:

SetClFPat('Grassy Cover',42);

VectorScript Declaration:

PROCEDURE   SetClLS

(   className :STRING;     LS :INTEGER ) ;

Python:

def  vs.SetClLS(className, LS):

   return None

Special Notes:

SetClLS is obsolete as of Vectorworks 2013

Description:

Deprecated - will generate error. Use SetClLSN instead.

説明

クラスの線の種類を設定します。

Parameters:

className	Name of class.	クラスの名前
LS	Line style index value.	線の種類

Example:

SetClLS('Property Parcels',-4);

See Also:

SetClLSN   

VectorScript Declaration:

PROCEDURE   SetClLSN

(   className :STRING;     lineStyle :LONGINT ) ;

Python:

def  vs.SetClLSN(className, lineStyle):

   return None

Description:

Sets the line style of the specified class.

説明

クラスの線の種類を設定します。

Parameters:

className	Name of class.	クラスの名前
lineStyle	Line style index value.	線の種類

See Also:

GetClLSN  

VectorScript Declaration:

PROCEDURE   SetClLW

(   className :STRING;     LW :INTEGER ) ;

Python:

def  vs.SetClLW(className, LW):

   return None

Description:

Sets the line weight of the specified class.

説明

クラスの線の太さを設定します。

Parameters:

className	Name of class.	クラスの名前
LW	Line weight value (in mils).	線の太さ（ミル単位）

Example:

SetClLW('To Be Demolished',28);

VectorScript Declaration:

PROCEDURE   SetClOpacity

(   className :STRING;     opacity :INTEGER ) ;

Python:

def  vs.SetClOpacity(className, opacity):

   return None

Description:

Sets the opacity persentage of a class. The opacity is specified by percentage value in range [0-100].

説明

指定したクラスの不透明度を設定します。

Parameters:

className	Name of class.	クラスの名前
opacity	Opacity specified by percentage value in range [0-100].	不透明度

Example:

{set opacity of 25%}
SetClOpacity('Cold Water Supply',25);

VectorScript Declaration:

PROCEDURE   SetCLOpacityN

(   className :STRING;     fillOpacity :INTEGER;     penOpacity :INTEGER ) ;

Python:

def  vs.SetCLOpacityN(className, fillOpacity, penOpacity):

   return None

VectorScript Declaration:

PROCEDURE   SetClPenBack

(   className :STRING;     colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.SetClPenBack(className, color):

   return None

Description:

Procedure SetClPenBack sets the pen background color of the specified class. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

説明

クラスの線の地色を設定します。色は赤、緑、青の成分で指定します。値の範囲は0から65535までです。

Parameters:

className	Name of class.	クラスの名前
color	RGB color value.	赤、緑、青の成分

Example:

ColorIndexToRGB(214,cRed,cGrn,cBlu);
SetClPenBack('Cold Water Supply',cRed,cGrn,cBlu);

VectorScript Declaration:

PROCEDURE   SetClPenFore

(   className :STRING;     colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.SetClPenFore(className, color):

   return None

Description:

Sets the pen foreground color of the specified class. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

説明

クラスの線の色を設定します。色は赤、緑、青の成分で指定します。値の範囲は0から65535までです。

Parameters:

className	Name of class.	クラスの名前
color	RGB color value.	赤、緑、青の成分

Example:

ColorIndexToRGB(214,cRed,cGrn,cBlu);
SetClPenFore('Cold Water Supply',cRed,cGrn,cBlu);

VectorScript Declaration:

PROCEDURE   SetClTextStyleRef

(   className :STRING;     textStyleRef :LONGINT ) ;

Python:

def  vs.SetClTextStyleRef(className, textStyleRef):

   return None

Description:

Function SetClTextStyleRef sets the text style of the specified class. The integer style is the internal index of the text style.

説明

指定したクラスの文字スタイルを設定します。 textStyleRefに文字スタイルのインデックスを指定します。

Parameters:

className	Name of class	クラスの名前
textStyleRef	text style reference id	文字スタイルのインデックス

See Also:

SetClUseTextStyle   GetClUseTextStyle   GetClTextStyleRef  

VectorScript Declaration:

PROCEDURE   SetClUseGraphic

(   className :STRING;     use :BOOLEAN ) ;

Python:

def  vs.SetClUseGraphic(className, use):

   return None

Description:

Toggles the document setting for using the graphic attributes of the specified class at object creation.

説明

クラスのグラフィック属性を設定します。

Parameters:

className	Name of class.	クラスの名前
use	Use graphic attributes on-off setting.	グラフィック属性の有無

Example:

SetClUseGraphic('Forested Cover',TRUE);

VectorScript Declaration:

PROCEDURE   SetClUseTextStyle

(   className :STRING;     use :BOOLEAN ) ;

Python:

def  vs.SetClUseTextStyle(className, use):

   return None

Description:

Controls whether the text style of the specified class is used at object creation.

説明

指定したクラスの文字スタイルの使用の有無を設定します。

Parameters:

className	Name of class	クラスの名前
use	Use text style on-off setting.	文字スタイルを使用する(TRUE)／しない(FALSE)

See Also:

GetClUseTextStyle   SetClTextStyleRef   GetClTextStyleRef  

VectorScript Declaration:

PROCEDURE   SetClUseTexture

(   className :STRING;     use :BOOLEAN ) ;

Python:

def  vs.SetClUseTexture(className, use):

   return None

Description:

Toggles the document setting for using the texture attributes of the specified class at object creation.

説明

クラスのテクスチャ使用の有無を設定します。

Parameters:

className	Name of class.	クラスの名前
use	Use texture attributes on-off setting.	テクスチャ使用を有効にする場合はTRUE

Example:

SetClUseTexture('Proposed Roof',TRUE);

VectorScript Declaration:

FUNCTION   SetClVectorFill

(   className :STRING;     hatchName :STRING ) :BOOLEAN ;

Python:

def  vs.SetClVectorFill(className, hatchName):

   return BOOLEAN

Description:

Sets the class fill style to use the specified hatch pattern. The function return value will be TRUE if the operation was successful.

説明

クラスのハッチングを設定します。

Parameters:

className	Name of class.	クラスの名前
hatchName	Name of hatch pattern.	ハッチングの名前

返り値

正しく設定された場合はTRUE

VectorScript Declaration:

PROCEDURE   ShowClass

( className:STRING ) ;

Python:

def  vs.ShowClass(className):

   return None

Description:

Sets the visibility of the specified class to normal (visible) status.

説明

指定したクラスを表示します。

Parameters:

className

Name of class.

クラスの名前

Example:

ShowClass('Dimension');

See Also:

HideClass