ActSSheet Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   ActSSheet
:HANDLE ;

Python:

def  vs.ActSSheet():
   return HANDLE

Special Notes:

ActSSheet is obsolete as of VectorWorks9.0

Description:

Function ActSSheet returns the handle to the currently active worksheet.

説明

アクティブなワークシートのハンドルを返します。



  AddWSColumnOperator Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   AddWSColumnOperator
(   worksheet :HANDLE;
    databaseRow :INTEGER;
    column :INTEGER;
    operatorType :INTEGER
) ;

Python:

def  vs.AddWSColumnOperator(worksheet, databaseRow, column, operatorType):
   return None

Description:

Adds database column operator to specified column.

説明

ハンドルで指定したワークシートの、指定したセルに並び替え（ソート）と合計を追加します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. 行
column Column to be queried. 列
operatorType Operator type. タイプ



  AreWorksheetGridLinesVisible Worksheets 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   AreWorksheetGridLinesVisible
( h:HANDLE ) :BOOLEAN ;

Python:

def  vs.AreWorksheetGridLinesVisible(h):
   return BOOLEAN

Description:

Returns true if the grid lines are enabled for the specified worksheet.

説明

グリッドラインが、指定したワークシートで現在有効であるかどうかを返します。

Parameters:

h Handle to worksheet. ワークシートのハンドル



  AutoFitWSRowHeights Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   AutoFitWSRowHeights
(   worksheet :HANDLE;
    fromRow :INTEGER;
    toRow :INTEGER
) ;

Python:

def  vs.AutoFitWSRowHeights(worksheet, fromRow, toRow):
   return None

Description:

Auto fit the height of rows to the content of the cells in the referenced worksheet.

AutoFitWSRowHeights allows height for a range of rows to be auto fitted to the contents of cells. To auto fit the height of a single worksheet row, specify identical values for the top/bottom row range boundaries.

説明

ハンドルで指定したワークシート上の指定した行の高さを自動調整します。
指定した範囲の行の高さをセルの内容に合うように自動調整します。
1行の高さを自動調整するには、上の行、下の行パラメータに同一の値を設定します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
fromRow Top row of row range 上の行
toRow Bottom row of row range 下の行

Example:

{Auto resizes the height of all rows from row 1 to row 4} 
AutoFitWSRowHeights(sheet,1,4};



  CellHasNum Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   CellHasNum
(   h :HANDLE;
    row :INTEGER;
    col :INTEGER
) :BOOLEAN ;

Python:

def  vs.CellHasNum(h, row, col):
   return BOOLEAN

Special Notes:

CellHasNum is obsolete as of VectorWorks9.0

Description:

Function CellHasNum returns TRUE if the specified cell of a referenced worksheet contains a value or an equation which returns a numeric value.

説明

ハンドルで指定したワークシート上のセルに数値が入っている場合は、TRUEを返します。

Parameters:

h Handle to worksheet. ワークシートのハンドル
row Worksheet row index. 行
col Worksheet column index. 列



  CellHasStr Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   CellHasStr
(   h :HANDLE;
    row :INTEGER;
    col :INTEGER
) :BOOLEAN ;

Python:

def  vs.CellHasStr(h, row, col):
   return BOOLEAN

Special Notes:

CellHasStr is obsolete as of VectorWorks9.0

Description:

Function CellHasStr returns TRUE if the specified cell of a referenced worksheet contains a value or an equation which returns a numeric value.

説明

ハンドルで指定したワークシート上のセルに文字列が入っている場合は、TRUEを返します。

Parameters:

h Handle to worksheet. ワークシートのハンドル
row Worksheet row index. 行
col Worksheet column index. 列



  CellString Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   CellString
(   row :INTEGER;
    column :INTEGER
) :STRING ;

Python:

def  vs.CellString(row, column):
   return STRING

Special Notes:

CellString is obsolete as of VectorWorks9.0

Description:

Function CellString returns the string of a specified cell in the active worksheet

説明

アクティブなワークシート上の指定したセルの値を文字列で返します。

Parameters:

row Worksheet row index. 行
column Worksheet column index. 列



  CellValue Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   CellValue
(   row :INTEGER;
    column :INTEGER
) :REAL ;

Python:

def  vs.CellValue(row, column):
   return REAL

Special Notes:

CellValue is obsolete as of VectorWorks9.0

Description:

Function CellValue returns the numeric value of a specified cell in the active worksheet. If the specified cell is not a numeric type, then this function returns 0.

説明

アクティブなワークシート上の指定したセルの値を数値で返します。

Parameters:

row Worksheet row index. 行
column Worksheet column index. 列



  ClearWSCell Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   ClearWSCell
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER
) ;

Python:

def  vs.ClearWSCell(worksheet, topRow, leftColumn, bottomRow, rightColumn):
   return None

Description:

Clears content and resets attributes of a cell in the referenced worksheet.

ClearWSCell allows a rectangular range of cells to be reset. To reset a single cell, specify identical values for the top/bottom and left/right range boundaries.

説明

ハンドルで指定したワークシートの、指定したセル範囲の内容を消去します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
topRow Top row of cell range. 上の行
leftColumn Leftmost column of cell range. 左の列
bottomRow Bottom row of cell range. 下の行
rightColumn Rightmost column of cell range. 右の列



  CloseSS Worksheets 
MiniCAD6.0 - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   CloseSS
( h:HANDLE ) ;

Python:

def  vs.CloseSS(h):
   return None

Special Notes:

CloseSS is obsolete as of VectorWorks9.0

Description:

Procedure CloseSS closes the referenced worksheet.

説明

ハンドルで指定したワークシートを閉じます。

Parameters:

h Handle to worksheet. ワークシートのハンドル

Example:

CloseSS(HandleToWS);



  CreateWS Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   CreateWS
(   name :STRING;
    rows :INTEGER;
    columns :INTEGER
) :HANDLE ;

Python:

def  vs.CreateWS(name, rows, columns):
   return HANDLE

Description:

Creates a new worksheet in a Vectorworks document.

説明

ワークシートを作成します。

Parameters:

name The name of the worksheet. ワークシートの名前
rows The number of rows in the worksheet. 行数
columns The number of columns in the worksheet. 列数

Result:

Returns a HANDLE to the new worksheet.

返り値

新しく作成されたワークシートのハンドルを返します。



  CreateWSImage Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   CreateWSImage
(   worksheet :HANDLE;
    locationX :REAL;
    locationY :REAL
) :HANDLE ;

Python:

def  vs.CreateWSImage(worksheet, location):
   return HANDLE

Description:

Creates an in-document image of the specified worksheet. The specified point location is the top left corner of the image object.

説明

ハンドルで指定したワークシートを、図形モードとして用紙の上に作成します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
location X-Y coordinate location of image object. 左上の座標



  DeleteWSColumns Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   DeleteWSColumns
(   worksheet :HANDLE;
    startColumn :INTEGER;
    numColumns :INTEGER
) ;

Python:

def  vs.DeleteWSColumns(worksheet, startColumn, numColumns):
   return None

Description:

Deletes columns from the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定した列を削除します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
startColumn Start column of delete operation. 開始列
numColumns Number of columns to delete. 削除する列の数



  DeleteWSRows Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   DeleteWSRows
(   worksheet :HANDLE;
    startRow :INTEGER;
    numRows :INTEGER
) ;

Python:

def  vs.DeleteWSRows(worksheet, startRow, numRows):
   return None

Description:

Deletes rows from the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定した行を削除します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
startRow Start row of delete operation. 開始行
numRows Number of rows to be deleted. 削除する行の数



  EnableDrawingWorksheetPalette Worksheets 
Vectorworks 2009

VectorScript Declaration:

PROCEDURE   EnableDrawingWorksheetPalette
(   enable :BOOLEAN;
    worksheet :HANDLE
) ;

Python:

def  vs.EnableDrawingWorksheetPalette(enable, worksheet):
   return None

Description:

Enables/disables drawing for the specified worksheet or all displayed worksheet palettes if worksheet is nil.

To improve speed and avoid flickering, it is highly recommended to disable drawing in worksheet palettes before performing several write operations in an opened worksheet.
Enable drawing back when the operations are completed.

説明

ハンドルで指定したワークシートまたはすべてのワークシートを描画する／しないを設定します。



ワークシートを開いているときに、何回もワークシートに書き込む場合は、速度を改善し、ちらつきを避けるため、ワークシートの描画をしないようにすることを特におすすめします。
操作が終了したら描画するよう戻してください。

Parameters:

enable Specifies if worksheet palettes' drawing should be enabled or disabled. 描画する／しない
worksheet Handle to specific worksheet for which to enable/disable drawing; Set it to nil to enable/disable drawing in all displayed worksheet palettes. ワークシートのハンドル（NIL : 全てのワークシート）

Example:

{Disable drawing in all displayed worksheet palettes.}
EnableDrawingWorksheetPalette(false, nil);

{Write it worksheets ....}
...
...
...

{Enable back drawing in all displayed worksheet palettes.}
EnableDrawingWorksheetPalette(true, nil);



  GetCAlign Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetCAlign
(   h :HANDLE;
    row :INTEGER;
    col :INTEGER
) :INTEGER ;

Python:

def  vs.GetCAlign(h, row, col):
   return INTEGER

Special Notes:

GetCAlign is obsolete as of VectorWorks9.0

Description:

Function GetCAlign returns the alignment value of a cell in the referenced worksheet.

Table - Worksheet Cell Alignment

Alignment Constant
General 1
Left 2
Right 3
Center 4

説明

ハンドルで指定したワークシート上のセルの位置揃えを返します。

Parameters:

h Handle to worksheet. ワークシートのハンドル
row Worksheet row index. 行
col Worksheet column index. 列

Example:

AlignmentMode:=GetCAlign(WSheetHd,4,5);



  GetCellNum Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetCellNum
(   h :HANDLE;
    row :INTEGER;
    col :INTEGER
) :REAL ;

Python:

def  vs.GetCellNum(h, row, col):
   return REAL

Special Notes:

GetCellNum is obsolete as of VectorWorks9.0

Description:

Function GetCellNum returns the numeric value of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシート上のセルの数値を返します。

Parameters:

h Handle to worksheet. ワークシートのハンドル
row Worksheet row index. 行
col Worksheet column index. 列



  GetCellStr Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetCellStr
(   h :HANDLE;
    row :INTEGER;
    col :INTEGER
) :STRING ;

Python:

def  vs.GetCellStr(h, row, col):
   return STRING

Special Notes:

GetCellStr is obsolete as of VectorWorks9.0

Description:

Function GetCellStr returns the string value of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシート上のセルの文字列を返します。

Parameters:

h Handle to worksheet. ワークシートのハンドル
row Worksheet row index. 行
col Worksheet column index. 列



  GetCWidth Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetCWidth
(   h :HANDLE;
    row :INTEGER;
    col :INTEGER
) :INTEGER ;

Python:

def  vs.GetCWidth(h, row, col):
   return INTEGER

Special Notes:

GetCWidth is obsolete as of VectorWorks9.0

Description:

Function GetCWidth returns the column width of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシート上のセルの幅を返します。

Parameters:

h Handle to worksheet. ワークシートのハンドル
row Worksheet row index. 行
col Worksheet column index. 列



  GetSprdSortSum Worksheets 
VectorWorks8.0 - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetSprdSortSum
(   sheetHd :HANDLE;
    row :INTEGER;
  VAR  sortCol1 :INTEGER;
  VAR  sortCol2 :INTEGER;
  VAR  sortCol3 :INTEGER;
  VAR  sumCol :INTEGER
) ;

Python:

def  vs.GetSprdSortSum(sheetHd, row):
   return (sortCol1, sortCol2, sortCol3, sumCol)

Special Notes:

GetSprdSortSum is obsolete as of VectorWorks9.0

Description:

Procedure GetSprdSortSum returns sorting and summation options for a database row in the referenced worksheet.

説明

ハンドルで指定したワークシートの並び替え（ソート）の設定を返します。

Parameters:

sheetHd Handle to worksheet. ワークシートのハンドル
row Worksheet database row index. データベース設定行
sortCol1 Primary sort column index. 第1位の並び替え列
sortCol2 Secondary sort column index. 第2位の並び替え列
sortCol3 Tertiary sort column index. 第3位の並び替え列
sumCol Summation column. 合計の列



  GetSprdSortSumColumns Worksheets 
VectorWorks8.5 - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetSprdSortSumColumns
(   sheetHd :HANDLE;
    row :INTEGER;
  VAR  sortCol1 :INTEGER;
  VAR  sortCol2 :INTEGER;
  VAR  sortCol3 :INTEGER;
  VAR  sumCol1 :INTEGER;
  VAR  sumCol2 :INTEGER;
  VAR  sumCol3 :INTEGER
) ;

Python:

def  vs.GetSprdSortSumColumns(sheetHd, row):
   return (sortCol1, sortCol2, sortCol3, sumCol1, sumCol2, sumCol3)

Special Notes:

GetSprdSortSumColumns is obsolete as of VectorWorks9.0

Description:

Returns the sorting and summation options for a database row.

説明

ハンドルで指定したワークシートの並び替え（ソート）の設定を返します。

Parameters:

sheetHd Handle to worksheet. ワークシートのハンドル
row Database row to be queried. データベース設定行
sortCol1 Primary sort column. 第1位の並び替え列
sortCol2 Secondary sort column. 第2位の並び替え列
sortCol3 Tertiary sort column. 第3位の並び替え列
sumCol1 Primary summation column. 第1位の合計の列
sumCol2 Secondary summation column. 第2位の合計の列
sumCol3 Tertiary summation column. 第3位の合計の列



  GetTopVisibleWS Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetTopVisibleWS
:HANDLE ;

Python:

def  vs.GetTopVisibleWS():
   return HANDLE

Description:

Returns a handle to topmost visible worksheet.

説明

表示されている最上位のワークシートのハンドルを返します。

Result:

Returns a HANDLE to the worksheet whose window is at the top of the window stacking order.

返り値

ワークシートのハンドルを返します。



  GetWSAutoRecalcState Worksheets 
Vectorworks 2009

VectorScript Declaration:

FUNCTION   GetWSAutoRecalcState
( worksheet:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetWSAutoRecalcState(worksheet):
   return BOOLEAN

Description:

Gets the AutoRecalc state for the specified worksheet.

When the AutoRecalc flag is on for a worksheet, it automatically recalculates every time a cell is edited.

In order to improve speed when editing mutiple cells one after the other or in a loop, it is highly recommended to turn this flag off prior to the edits and restore it, then recalculate the worksheet when all the edits are completed.

説明

ハンドルで指定したワークシートがセル編集時に自動再計算する設定かどうかを返します。
In order to improve speed when editing mutiple cells one after the other or in a loop, it is highly recommended to turn this flag off prior to the edits and restore it, then recalculate the worksheet when all the edits are completed.

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル

Example:

{Save the current AutoRecalc state}
state := GetWSAutoRecalcState(h);

{Turn off worksheet Auto Recalculation}
SetWSAutoRecalcState(h,false);

{Execute worksheet edit operations ....}

{Restore AutoRecalc state}
SetWSAutoRecalcState(h, state);

{Recalculate the worksheet}
RecalculateWS(h);

See Also:

SetWSAutoRecalcState   RecalculateWS  



  GetWSCellAlignment Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSCellAlignment
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  cellAlignment :INTEGER
) ;

Python:

def  vs.GetWSCellAlignment(worksheet, row, column):
   return cellAlignment

Description:

Returns the horizontal alignment setting of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの位置揃えを返します。

Parameters:

worksheet Handle to a worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
cellAlignment Horizontal alignment index of cell. 位置揃えの種類



  GetWSCellBorder Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSCellBorder
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  top :BOOLEAN;
  VAR  left :BOOLEAN;
  VAR  bottom :BOOLEAN;
  VAR  right :BOOLEAN
) ;

Python:

def  vs.GetWSCellBorder(worksheet, row, column):
   return (top, left, bottom, right)

Description:

Returns the cell border of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの枠線情報を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
top Top border ON-OFF status. 上の枠線
left Left border ON-OFF status. 左の枠線
bottom Bottom border ON-OFF status. 下の枠線
right Right border ON-OFF status. 右の枠線



  GetWSCellFill Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetWSCellFill
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  style :INTEGER;
  VAR  bgcolor :LONGINT;
  VAR  fgcolor :LONGINT;
  VAR  fillpattern :INTEGER
) ;

Python:

def  vs.GetWSCellFill(worksheet, row, column):
   return (style, bgcolor, fgcolor, fillpattern)

Description:

Returns the fill style and color of a cell in the referenced worksheet

説明

ハンドルで指定したワークシートの、指定したセルの模様、及び色属性を返します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
row Row of cell to be queried 行番号
column Column of cell to be queried 列番号
style Cell fill style constant 模様
bgcolor Cell background color index 地色のパレット番号
fgcolor Cell foreground color index 色のパレット番号
fillpattern Cell pattern index 模様のパレット番号



  GetWSCellFormula Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSCellFormula
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  formula :STRING
) ;

Python:

def  vs.GetWSCellFormula(worksheet, row, column):
   return formula

Description:

Returns the formula from a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの式を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
formula Formula contained in worksheet cell. 式



  GetWSCellFormulaN Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   GetWSCellFormulaN
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  formula :DYNARRAY[] of CHAR
) ;

Python:

def  vs.GetWSCellFormulaN(worksheet, row, column):
   return formula

Description:

Returns the formula from a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの式を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
formula Formula contained in worksheet cell. 式

Example:

PROCEDURE WStest;
    VAR
       worksheet : HANDLE;
       inString, outString : DYNARRAY [] OF CHAR;
BEGIN
   worksheet := CreateWS('MyWS', 5, 5);
   inString := '';
   outString := '';

   { inserts a formula into a single cell }
   inString := '=3*2';
   SetWSCellFormulaN(worksheet, 1, 2, 1, 2, inString);

   { gets formula from cell }
   GetWSCellFormulaN(worksheet, 1, 2, outString);

   AlrtDialog(outString); { the cell formula }
END;
RUN(WStest);



  GetWSCellNumberFormat Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSCellNumberFormat
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  style :INTEGER;
  VAR  accuracy :INTEGER;
  VAR  leaderString :STRING;
  VAR  trailerString :STRING
) ;

Python:

def  vs.GetWSCellNumberFormat(worksheet, row, column):
   return (style, accuracy, leaderString, trailerString)

Description:

Returns the numeric formatting of a cell in the referenced worksheet.

Specific index values for numeric formats and accuracy are listed in the Appendix.

説明

ハンドルで指定したワークシートの、指定したセルの数字の表示形式を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
style Numeric format style index. スタイル
accuracy Numeric accuracy / secondary format index. 精度
leaderString Leader string (where applicable). 前記号
trailerString Trailer string (where applicable). 後記号



  GetWSCellsImgDPIRes Worksheets 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   GetWSCellsImgDPIRes
(   worksheet :HANDLE;
  VAR  dpiResolution :INTEGER
) ;

Python:

def  vs.GetWSCellsImgDPIRes(worksheet):
   return dpiResolution

Description:

Gets the DPI resolution for images in the specified worksheet.

説明

指定したワークシートのイメージのDPI解像度を取得します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
dpiResolution The images' DPI resolution イメージのDPI解像度



  GetWSCellString Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSCellString
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  cellString :STRING
) ;

Python:

def  vs.GetWSCellString(worksheet, row, column):
   return cellString

Description:

Returns the displayed string value of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの文字列を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
cellString The string value contained in the worksheet cell. 文字列



  GetWSCellStringN Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   GetWSCellStringN
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  cellString :DYNARRAY[] of CHAR
) ;

Python:

def  vs.GetWSCellStringN(worksheet, row, column):
   return cellString

Description:

Returns the displayed string value of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの文字列を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
cellString The string value contained in the worksheet cell. 文字列

Example:

PROCEDURE WStest;
    VAR
       worksheet : HANDLE;
       inString, outString : DYNARRAY [] OF CHAR;
BEGIN
   worksheet := CreateWS('MyWS', 5, 5);
   inString := '';
   outString := '';

   { inserts a formula into a single cell }
   inString := '=3*2';
   SetWSCellFormulaN(worksheet, 1, 2, 1, 2, inString);

   { gets string from cell }
   GetWSCellStringN(worksheet, 1, 2, outString);

   AlrtDialog(outString); { the cell formula }
END;
RUN(WStest);



  GetWSCellTextAngle Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetWSCellTextAngle
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  angle :INTEGER
) ;

Python:

def  vs.GetWSCellTextAngle(worksheet, row, column):
   return angle

Description:

Returns the text angle of a cell in the referenced worksheet

説明

ハンドルで指定したワークシートの、指定したセルの文字の角度を返します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
row Row of cell to be queried 行番号
column Column of cell to be queried 列番号
angle Text angle 角度



  GetWSCellTextColor Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetWSCellTextColor
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  color :LONGINT
) ;

Python:

def  vs.GetWSCellTextColor(worksheet, row, column):
   return color

Description:

Returns the text color of a cell in the referenced worksheet

説明

ハンドルで指定したワークシートの、指定したセルの文字色を返します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
row Row of cell to be queried 行番号
column Column of cell to be queried 列番号
color Text color index value カラー番号



  GetWSCellTextFormat Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSCellTextFormat
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  fontIndex :INTEGER;
  VAR  size :INTEGER;
  VAR  style :INTEGER
) ;

Python:

def  vs.GetWSCellTextFormat(worksheet, row, column):
   return (fontIndex, size, style)

Description:

Returns text format settings for a cell in the referenced worksheet.

Table - Text Style

Style Constant
Plain 0
Bold 1
Italic 2
Underline 4
Outline 8
Shadowed 16
Superscript 32
Subscript 64

説明

ハンドルで指定したワークシートの、指定したセルの文字属性を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
fontIndex Font index of cell text. フォントの番号
size Font size of cell text. サイズ
style Font style of cell text. スタイル



  GetWSCellValue Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSCellValue
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  cellValue :REAL
) ;

Python:

def  vs.GetWSCellValue(worksheet, row, column):
   return cellValue

Description:

Returns the displayed numeric value of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの数値を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列
cellValue Numeric value contained in worksheet cell. 数値



  GetWSCellVertAlignment Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetWSCellVertAlignment
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  vAlignment :INTEGER
) ;

Python:

def  vs.GetWSCellVertAlignment(worksheet, row, column):
   return vAlignment

Description:

Returns the vertical alignment setting of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの垂直方向の位置揃えを返します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
row Row index of cell to be queried 行番号
column Column index of cell to be queried 列番号
vAlignment Vertical alignment index of cell. 垂直方向の位置揃え



  GetWSCellWrapTextFlag Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetWSCellWrapTextFlag
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  wrapTextFlag :BOOLEAN
) ;

Python:

def  vs.GetWSCellWrapTextFlag(worksheet, row, column):
   return wrapTextFlag

Description:

Returns the wrap text state of a cell in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルのラップテキストの状態を返します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
row Row of cell to be queried 行番号
column Row of cell to be queried 列番号
wrapTextFlag Wrap text flag ラップテキストの状態



  GetWSColumnOperators Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSColumnOperators
(   worksheet :HANDLE;
    row :INTEGER;
  VAR  sort1 :INTEGER;
  VAR  sort2 :INTEGER;
  VAR  sort3 :INTEGER;
  VAR  sum1 :INTEGER;
  VAR  sum2 :INTEGER;
  VAR  sum3 :INTEGER
) ;

Python:

def  vs.GetWSColumnOperators(worksheet, row):
   return (sort1, sort2, sort3, sum1, sum2, sum3)

Description:

Returns the sort and summarize column operators for a database row in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定した行の並び替え（ソート）と合計を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row to be queried. 行
sort1 Primary sort column. ソート結果1
sort2 Secondary sort column. ソート結果2
sort3 Tertiary sort column. ソート結果3
sum1 Primary summarize column. 合計1
sum2 Secondary summarize column. 合計2
sum3 Tertiary summarize column. 合計3



  GetWSColumnSortPrecedence Worksheets 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   GetWSColumnSortPrecedence
(   worksheet :HANDLE;
    databaseRow :INTEGER;
    column :INTEGER
) :INTEGER ;

Python:

def  vs.GetWSColumnSortPrecedence(worksheet, databaseRow, column):
   return INTEGER

Description:

Gets database column sort precedence, if any.

説明

ハンドルで指定したワークシートの、指定したデータベース行のソート優先順位を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. 行
column Column to be queried. 列



  GetWSColumnSortType Worksheets 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   GetWSColumnSortType
(   worksheet :HANDLE;
    databaseRow :INTEGER;
    column :INTEGER
) :INTEGER ;

Python:

def  vs.GetWSColumnSortType(worksheet, databaseRow, column):
   return INTEGER

Description:

Gets database column's sort type.

説明

ハンドルで指定したワークシートの、指定したデータベース行のソート順を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. 行
column Column to be queried. 列



  GetWSColumnWidth Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSColumnWidth
(   worksheet :HANDLE;
    column :INTEGER;
  VAR  width :INTEGER
) ;

Python:

def  vs.GetWSColumnWidth(worksheet, column):
   return width

Description:

Returns the width of a column in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定した列の幅を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
column Column to be queried. 行
width Width of column (in pixels). 列の幅（ピクセル）



  GetWSFromImage Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetWSFromImage
( worksheetImage:HANDLE ) :HANDLE ;

Python:

def  vs.GetWSFromImage(worksheetImage):
   return HANDLE

Description:

Returns a handle to the worksheet being displayed by a worksheet image object..

説明

図形モードのワークシートのハンドルを与えると、そのワークシートのハンドルを返します。

Parameters:

worksheetImage Handle to worksheet image object. 図形モードのワークシートのハンドル

返り値

ワークシートのハンドル



  GetWSImage Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   GetWSImage
( worksheet:HANDLE ) :HANDLE ;

Python:

def  vs.GetWSImage(worksheet):
   return HANDLE

Description:

Returns a handle to the on-drawing object (image) of the referenced worksheet.

説明

ワークシートのハンドルを与えると、その図形モードのワークシートのハンドルを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル

Result:

Returns a HANDLE of the worksheet image object.

返り値

図形モードのワークシートのハンドルを返します。



  GetWSImageScaleF Worksheets 
Vectorworks 2017

VectorScript Declaration:

FUNCTION   GetWSImageScaleF
( handle:HANDLE ) :REAL ;

Python:

def  vs.GetWSImageScaleF(handle):
   return REAL

Description:

Returns the scale factor of the specified worksheet on drawing object.

説明

指定したワークシートのイメージの倍率を取得します。

Parameters:

handle The handle to the worksheet on drawing object. ワークシートのハンドル

Result:

The scale factor of the specified worksheet on drawing object.

返り値

指定したワークシートのイメージの倍率



  GetWSImgAngle Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetWSImgAngle
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  NewParam :REAL
) ;

Python:

def  vs.GetWSImgAngle(worksheet, row, column):
   return NewParam

Description:

Gets the specified worksheet cell's image angle.

説明

指定したワークシートセルのイメージの回転角を返します。

Parameters:

row The cell row. セルの行
column The cell column. セルの列
NewParam The image angle. イメージの回転角



  GetWSImgComponent Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   GetWSImgComponent
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  component :INTEGER
) ;

Python:

def  vs.GetWSImgComponent(worksheet, row, column):
   return component

Description:

Gets the specified component of a worksheet cell image.

Table - Components

Component Constant
3D 0
2D 1
2D Cut 2
Not set 4

説明

指定したワークシートセルのイメージのコンポーネントを取得します。

Table - Components

Component Constant
3D 0
2D 1
2D Cut 2
Not set 4

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行番号
column The cell column. セルの列番号
component The image component コンポーネント

See Also:

SetWSImgComponent  



  GetWSImgMarginSize Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetWSImgMarginSize
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  marginSize :INTEGER
) ;

Python:

def  vs.GetWSImgMarginSize(worksheet, row, column):
   return marginSize

Description:

Gets the worksheet cell's image margin size.

説明

ワークシートセルのイメージの余白のサイズを返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列
marginSize The image margin size. イメージの余白のサイズ



  GetWSImgRenderMode Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetWSImgRenderMode
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  renderMode :INTEGER
) ;

Python:

def  vs.GetWSImgRenderMode(worksheet, row, column):
   return renderMode

Description:

Gets the specified worksheet cell's image render mode

説明

指定したワークシートセルのイメージのレンダリングの種類を返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列
renderMode The image render mode. イメージのレンダリングの種類



  GetWSImgScale Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetWSImgScale
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  scale :REAL
) ;

Python:

def  vs.GetWSImgScale(worksheet, row, column):
   return scale

Description:

Gets the worksheet cell's image scale.

説明

ワークシートセルのイメージの縮尺を返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列
scale The image scale. イメージの縮尺



  GetWSImgShowDBHeader Worksheets 
Vectorworks 2018

VectorScript Declaration:

FUNCTION   GetWSImgShowDBHeader
( hWorksheetImage:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetWSImgShowDBHeader(hWorksheetImage):
   return BOOLEAN

Description:

Check whether worksheet image is set to show database headers.

説明

ワークシートオブジェクトがデータベースヘッダを表示するように設定されているかどうかを返します。



  GetWSImgSize Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetWSImgSize
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  height :INTEGER;
  VAR  width :INTEGER
) ;

Python:

def  vs.GetWSImgSize(worksheet, row, column):
   return (height, width)

Description:

Gets the specified worksheet cell's image size.

説明

指定したワークシートセルのイメージの大きさを返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列
height The image height. イメージの高さ
width The image width. イメージの幅



  GetWSImgSizeType Worksheets 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetWSImgSizeType
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER
) :INTEGER ;

Python:

def  vs.GetWSImgSizeType(worksheet, row, column):
   return INTEGER

Description:

Gets the worksheet cell's image size type.

説明

ワークシートセルのイメージの大きさの測り方を返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列

Result:

INTEGER specifying the cell image size type.

返り値

INTEGER specifying the cell image size type.



  GetWSImgType Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetWSImgType
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  type :INTEGER
) ;

Python:

def  vs.GetWSImgType(worksheet, row, column):
   return type

Description:

Gets the specified worksheet cell's image type.

説明

指定したワークシートセルのイメージタイプを返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列
type The image type. イメージタイプ



  GetWSImgUseLayScale Worksheets 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetWSImgUseLayScale
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetWSImgUseLayScale(worksheet, row, column):
   return BOOLEAN

Description:

Determines if the image size type is Layer Scale.

説明

イメージの大きさがレイヤの縮尺に基づくかかどうかを返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列

Result:

BOOLEAN indicating if state of cell's use layer scale.

返り値

BOOLEAN 縮尺にもとづくかどうかを示す



  GetWSImgUseObjectImg Worksheets 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetWSImgUseObjectImg
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetWSImgUseObjectImg(worksheet, row, column):
   return BOOLEAN

Description:

Determines if cell uses object image.

説明

セルがオブジェクトのイメージを使用しているかどうかを返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列

Result:

BOOLEAN indicating state of cell's use object image.

返り値

BOOLEAN セルがオブジェクトのイメージを使用しているかどうかを示す



  GetWSImgView Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   GetWSImgView
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  view :INTEGER
) ;

Python:

def  vs.GetWSImgView(worksheet, row, column):
   return view

Description:

Gets the specified worksheet cell's image view.

説明

指定したワークシートセルのイメージのビューを返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル worksheet handle.
row The cell row. セルの行
column The cell column. セルの列
view The image view. イメージのビュー



  GetWSMergedCellRange Worksheets 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   GetWSMergedCellRange
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
  VAR  topRow :INTEGER;
  VAR  leftColumn :INTEGER;
  VAR  bottomRow :INTEGER;
  VAR  rightColumn :INTEGER
) :BOOLEAN ;

Python:

def  vs.GetWSMergedCellRange(worksheet, row, column):
   return (BOOLEAN, topRow, leftColumn, bottomRow, rightColumn)

Description:

Gets the range of cells covered by the specified cell. Returns true if the specified cell is a merged cell.

説明

ハンドルで指定したワークシートの、指定したセルをカバーするセルの範囲を取得します。指定されたセルが統合セルならば、TRUEを返します。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
row Row index of merged cell from which to get the covered range. 行番号
column Column index of merged cell from which to get the covered range. 列番号
topRow Top row index of merged cell range. 上の行
leftColumn Left column index of merged cell range. 左の列
bottomRow Bottom row index of merged cell range. 下の行
rightColumn Right column index of merged cell range. 右の列

Result:

'true' if specified cell is a merged cell
'false' otherwise.

返り値

統合セルならTRUE、その他はFALSEを返します。



  GetWSPlacement Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSPlacement
(   worksheet :HANDLE;
  VAR  top :INTEGER;
  VAR  left :INTEGER;
  VAR  bottom :INTEGER;
  VAR  right :INTEGER
) ;

Python:

def  vs.GetWSPlacement(worksheet):
   return (top, left, bottom, right)

Description:

Returns the on-screen location of the referenced worksheets' window.

説明

ハンドルで指定したワークシートのウインドウ位置を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
top X-coordinate of top left corner of worksheet window. 左上のX座標
left Y-coordinate of top left corner of worksheet window. 左上のY座標
bottom X-coordinate of bottom right corner of worksheet window. 右下のX座標
right Y-coordinate of bottom right corner of worksheet window. 右下のY座標



  GetWSRowColumnCount Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSRowColumnCount
(   worksheet :HANDLE;
  VAR  numRows :INTEGER;
  VAR  numColumns :INTEGER
) ;

Python:

def  vs.GetWSRowColumnCount(worksheet):
   return (numRows, numColumns)

Description:

Returns the number of rows and columns in the referenced worksheet.

説明

ハンドルで指定したワークシートの行数と列数を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
numRows Number of rows in worksheet. 行数
numColumns Number of columns in worksheet. 列数



  GetWSRowHeight Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSRowHeight
(   worksheet :HANDLE;
    row :INTEGER;
  VAR  height :INTEGER
) ;

Python:

def  vs.GetWSRowHeight(worksheet, row):
   return height

Description:

Returns the height of a row in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定した行の高さを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row to be queried. 行
height Height of row (in pixels). 行の高さ（ピクセル）



  GetWSRowHLockState Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   GetWSRowHLockState
(   worksheet :HANDLE;
    row :INTEGER;
  VAR  lockState :BOOLEAN
) ;

Python:

def  vs.GetWSRowHLockState(worksheet, row):
   return lockState

Description:

Returns the lock state of a row in the referenced worksheet

Note: If a row height is locked, the row will not automatically resize to fit the contents of the cells when text is entered.

説明

ハンドルで指定したワークシートの指定した行のロック状態を返します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
row Worksheet row index 行番号
lockState Row Height lock state ( returns TRUE is row height is locked ; FALSE otherwise) ロックの状態

Example:

{Gets the lock state of the fifth row in the specified worksheet}
GetWSRowHLockState(sheet,5,lockstate);



  GetWSSelection Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSSelection
(   worksheet :HANDLE;
  VAR  currentCellRow :INTEGER;
  VAR  currentCellColumn :INTEGER;
  VAR  topRangeRow :INTEGER;
  VAR  leftRangeColumn :INTEGER;
  VAR  topRangeSubrow :INTEGER;
  VAR  bottomRangeRow :INTEGER;
  VAR  rightRangeColumn :INTEGER;
  VAR  bottomRangeSubrow :INTEGER
) ;

Python:

def  vs.GetWSSelection(worksheet):
   return (currentCellRow, currentCellColumn, topRangeRow, leftRangeColumn, topRangeSubrow, bottomRangeRow, rightRangeColumn, bottomRangeSubrow)

Description:

Returns the current selection range of the referenced worksheet.

In addition to returning the selection range of a worksheet, GetWSSelection will also return the range of selected database subrows, where applicable.

説明

ハンドルで指定したワークシートの、選択されているセルの範囲を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
currentCellRow Row of currently active cell. アクティブなセルの行
currentCellColumn Column of currently active cell. アクティブなセルの列
topRangeRow Top row of selection range. 選択範囲の上の行
leftRangeColumn Leftmost column of selection range. 選択範囲の左の列
topRangeSubrow Top row of of subrow selection range. 選択範囲（補助行）の上の行
bottomRangeRow Bottom row of selection range. 選択範囲の下の行
rightRangeColumn Rightmost column of selection range. 選択範囲の右の列
bottomRangeSubrow Bottom row of subrow selection range. 選択範囲（補助行）の下の行



  GetWSSubrowActualCellString Worksheets 
VectorWorks 2008

VectorScript Declaration:

PROCEDURE   GetWSSubrowActualCellString
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
    subrow :INTEGER;
  VAR  cellString :STRING
) ;

Python:

def  vs.GetWSSubrowActualCellString(worksheet, row, column, subrow):
   return cellString

Description:

Returns the actual string in a database subrow cell.

説明

ハンドルで指定したワークシートの、データベース設定されている行の文字列を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Database row to be queried. 行
column Column to be queried. 列
subrow Index of subrow cell to be queried. 補助行
cellString Actual string of subrow cell. 文字列



  GetWSSubrowActualStringN Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   GetWSSubrowActualStringN
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
    subrow :INTEGER;
  VAR  cellString :DYNARRAY[] of CHAR
) ;

Python:

def  vs.GetWSSubrowActualStringN(worksheet, row, column, subrow):
   return cellString

Description:

Returns the actual string in a database subrow cell.

説明

ハンドルで指定したワークシートの、データベース設定されている行の文字列を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Database row to be queried. 行
column Column to be queried. 列
subrow Index of subrow cell to be queried. 補助行
cellString Actual string of subrow cell. 文字列

Example:

PROCEDURE WStest;
   VAR
       autoRecalcState : BOOLEAN;
       worksheet : HANDLE;
       inString, outString : DYNARRAY [] OF CHAR;
BEGIN
   inString := '';
   outString := '';

   worksheet := CreateWS('MyWS', 5, 5);

   RectangleN(0, 0, 1, 0, 1, 1);

   {Save the current AutoRecalc state}
   autoRecalcState := GetWSAutoRecalcState(worksheet);

   {Turn off worksheet Auto Recalculation}
   SetWSAutoRecalcState(worksheet, false);

   { creates a database sub-row for the type 'RECT' }
   inString := '=DATABASE((T=RECT))';
   SetWSCellFormulaN(worksheet, 3, 0, 3, 0, inString);

   { inserts a formula into a database row cell }
   inString := '=T';
   SetWSCellFormulaN(worksheet, 3, 1, 3, 1, inString);

   {Restore AutoRecalc state}
   SetWSAutoRecalcState(worksheet, autoRecalcState);

   {Now recalculate the worksheet}
   RecalculateWS(worksheet);

   { gets subrow actual string }
   GetWSSubrowActualStringN(worksheet, 3, 1, 1, outString);

   AlrtDialog(outString); { the subrow cell actual string }
END;
RUN(WStest);



  GetWSSubrowCellString Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSSubrowCellString
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
    subrow :INTEGER;
  VAR  cellString :STRING
) ;

Python:

def  vs.GetWSSubrowCellString(worksheet, row, column, subrow):
   return cellString

Description:

Returns the displayed string in a database subrow cell.

説明

ハンドルで指定したワークシートの、データベース設定されている行の文字列を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Database row to be queried. 行
column Column to be queried. 列
subrow Index of subrow cell to be queried. 補助行
cellString Display string of subrow cell. 文字列



  GetWSSubrowCellStrN Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   GetWSSubrowCellStrN
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
    subrow :INTEGER;
  VAR  cellString :DYNARRAY[] of CHAR
) ;

Python:

def  vs.GetWSSubrowCellStrN(worksheet, row, column, subrow):
   return cellString

Description:

Returns the displayed string in a database subrow cell.

説明

ハンドルで指定したワークシートの、データベース設定されている行の文字列を返します。GetWSSubrowCellStringNの代わりに使います。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Database row to be queried. 行
column Column to be queried. 列
subrow Index of subrow cell to be queried. 補助行
cellString Display string of subrow cell. 文字列

Example:

PROCEDURE WStest;
   VAR
       autoRecalcState : BOOLEAN;
       worksheet : HANDLE;
       inString, outString : DYNARRAY [] OF CHAR;
BEGIN
   inString := '';
   outString := '';

   worksheet := CreateWS('MyWS', 5, 5);

   RectangleN(0, 0, 1, 0, 1, 1);

   {Save the current AutoRecalc state}
   autoRecalcState := GetWSAutoRecalcState(worksheet);

   {Turn off worksheet Auto Recalculation}
   SetWSAutoRecalcState(worksheet, false);

   { creates a database sub-row for the type 'RECT' }
   inString := '=DATABASE((T=RECT))';
   SetWSCellFormulaN(worksheet, 3, 0, 3, 0, inString);

   { inserts a formula into a database row cell }
   inString := '=T';
   SetWSCellFormulaN(worksheet, 3, 1, 3, 1, inString);

   {Restore AutoRecalc state}
   SetWSAutoRecalcState(worksheet, autoRecalcState);

   {Now recalculate the worksheet}
   RecalculateWS(worksheet);

   { gets subrow display string }
   GetWSSubrowCellStringN(worksheet, 3, 1, 1, outString);

   AlrtDialog(outString); { the subrow cell display string }
END;
RUN(WStest);



  GetWSSubrowCellValue Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSSubrowCellValue
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
    subrow :INTEGER;
  VAR  cellValue :REAL
) ;

Python:

def  vs.GetWSSubrowCellValue(worksheet, row, column, subrow):
   return cellValue

Description:

Returns the displayed numeric value in a database subrow cell.

説明

ハンドルで指定したワークシートの、データベース設定されている行の数値を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Database row to be queried. 行
column Column to be queried. 列
subrow Index of subrow cell to be queried. 補助行
cellValue Display value of subrow cell. 数値



  GetWSSubrowCount Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetWSSubrowCount
(   worksheet :HANDLE;
    databaseRow :INTEGER;
  VAR  numSubrows :INTEGER
) ;

Python:

def  vs.GetWSSubrowCount(worksheet, databaseRow):
   return numSubrows

Description:

Returns a count of displayed subrows for a specified database row.

説明

ハンドルで指定したワークシートの、データベース設定されている行の補助行数を返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. データベース行
numSubrows Number of displayed subrows. 補助行数



  GetWSSubrowHeight Worksheets 
Vectorworks 2009

VectorScript Declaration:

PROCEDURE   GetWSSubrowHeight
(   worksheet :HANDLE;
    databaserow :INTEGER;
    subrow :INTEGER;
  VAR  height :INTEGER
) ;

Python:

def  vs.GetWSSubrowHeight(worksheet, databaserow, subrow):
   return height

Description:

Return the height of a database subrow in the referenced worksheet.

説明

ハンドルで指定したワークシートのデータベース行の高さを取得します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaserow The database row データベース行
subrow The database subrow to be queried 補助行
height Output parameter. Return the height (in pixels) 高さ (ピクセル)

Result:

Return the height of a database subrow in the referenced worksheet.

返り値

ハンドルで指定したワークシートのデータベース行の高さを返します。



  HasWSColumnOperator Worksheets 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   HasWSColumnOperator
(   worksheet :HANDLE;
    databaseRow :INTEGER;
    column :INTEGER;
    operatorType :INTEGER
) :BOOLEAN ;

Python:

def  vs.HasWSColumnOperator(worksheet, databaseRow, column, operatorType):
   return BOOLEAN

Description:

Determines if specified column operator is set in column.

説明

ハンドルで指定したワークシートの、指定したセルの並び替え（ソート）や合計のタイプを照会します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. 行
column Column to be queried. 列
operatorType Operator type. タイプ



  InsertWSColumns Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   InsertWSColumns
(   worksheet :HANDLE;
    beforeColumn :INTEGER;
    numColumns :INTEGER
) ;

Python:

def  vs.InsertWSColumns(worksheet, beforeColumn, numColumns):
   return None

Description:

Inserts columns into the referenced worksheet.

説明

ハンドルで指定したワークシートに、指定した列数を挿入します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
beforeColumn Insert location of new columns. 挿入位置（列）
numColumns Number of columns to insert. 挿入する列数



  InsertWSRows Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   InsertWSRows
(   worksheet :HANDLE;
    beforeRow :INTEGER;
    numRows :INTEGER
) ;

Python:

def  vs.InsertWSRows(worksheet, beforeRow, numRows):
   return None

Description:

Inserts rows into a referenced worksheet.

説明

ハンドルで指定したワークシートに、指定した行数を挿入します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
beforeRow Insert location for new worksheet rows. 挿入位置（行）
numRows Number of rows to insert. 挿入する行数



  IsValidWSCell Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsValidWSCell
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsValidWSCell(worksheet, row, column):
   return BOOLEAN

Description:

Returns TRUE if a specified cell is within the valid range of the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルが有効の場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of target cell. 行
column Column of target cell. 列

Result:

A BOOLEAN value indicating whether the cell is in the valid range of the worksheet.

返り値

有効の場合はTRUEを返します。



  IsValidWSRange Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsValidWSRange
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsValidWSRange(worksheet, topRow, leftColumn, bottomRow, rightColumn):
   return BOOLEAN

Description:

Returns whether the specified range is within the valid range of the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセル範囲が有効の場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
topRow Top row of target range. 上の行
leftColumn Leftmost column of target range. 左の列
bottomRow Bottom row of target range. 下の行
rightColumn Rightmost column of target range. 右の列

Result:

A BOOLEAN value indicating whether the range is valid.

返り値

有効の場合はTRUEを返します。



  IsValidWSSubrowCell Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsValidWSSubrowCell
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
    subrow :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsValidWSSubrowCell(worksheet, row, column, subrow):
   return BOOLEAN

Description:

Returns whether a specified database subrow cell is in the valid range of displayed subrows.

説明

ハンドルで指定したワークシートの、指定したデータベース行が有効の場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Database row to be queried. 行
column Column to be queried. 列
subrow Index of subrow. 補助行

Result:

A BOOLEAN value indicating whether the subrow cell location is valid.

返り値

有効の場合はTRUEを返します。



  IsWSCellNumber Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsWSCellNumber
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsWSCellNumber(worksheet, row, column):
   return BOOLEAN

Description:

Determines if a cell in the referenced worksheet contains a numeric value. The cell is referenced by its row-column position in the worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの内容が数値の場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried 列

Result:

A BOOLEAN value indicating whether the value is numeric.

返り値

数値の場合はTRUEを返します。



  IsWSCellString Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsWSCellString
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsWSCellString(worksheet, row, column):
   return BOOLEAN

Description:

Determines if a cell in the referenced worksheet contains a string value. The cell is referenced by its row-column position in the worksheet.

説明

ハンドルで指定したワークシートの、指定したセルの内容が文字列の場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row of cell to be queried. 行
column Column of cell to be queried. 列

Result:

A BOOLEAN value indicating whether the value is a string.

返り値

文字列の場合はTRUEを返します。



  IsWSDatabaseRow Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsWSDatabaseRow
(   worksheet :HANDLE;
    databaseRow :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsWSDatabaseRow(worksheet, databaseRow):
   return BOOLEAN

Description:

Returns whether a row in the referenced worksheet is a database row.

説明

ハンドルで指定したワークシートの、指定した行がデータベース行の場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Row to be queried. 行

Result:

A BOOLEAN value indicating the database status of the targeted row.

返り値

データベース行の場合はTRUEを返します。



  IsWSImg Worksheets 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   IsWSImg
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsWSImg(worksheet, row, column):
   return BOOLEAN

Description:

Determines if worksheet cell is set to display an image.

説明

ワークシートのセルがイメージを表示させる設定かどうかを返します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
row The cell row. セルの行
column The cell column. セルの列

Result:

A BOOLEAN value indicating whether the cell contains an image or not.

返り値

BOOLEAN セルにイメージが含まれるかどうかを示す



  IsWSSubrowCellNumber Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsWSSubrowCellNumber
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
    subrow :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsWSSubrowCellNumber(worksheet, row, column, subrow):
   return BOOLEAN

Description:

Returns whether a specified database subrow cell contains a numeric value.

説明

ハンドルで指定したワークシートの、指定したデータベース行が数値の場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Database row to be queried. 行
column Column to be queried. 列
subrow Index of subrow to be queried. 補助行

Result:

A BOOLEAN value indicating whether the cell contains a numeric value.

返り値

数値の場合はTRUEを返します。



  IsWSSubrowCellString Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsWSSubrowCellString
(   worksheet :HANDLE;
    row :INTEGER;
    column :INTEGER;
    subrow :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsWSSubrowCellString(worksheet, row, column, subrow):
   return BOOLEAN

Description:

Returns whether a specified database subrow cell contains a numeric value.

説明

ハンドルで指定したワークシートの、指定したデータベース行が文字列の場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Database row to be queried. 行
column Column to be queried. 列
subrow Index of subrow to be queried. 補助行

Result:

A BOOLEAN value indicating whether the cell contains a string value.

返り値

文字列の場合はTRUEを返します。



  IsWSVisible Worksheets 
VectorWorks9.0

VectorScript Declaration:

FUNCTION   IsWSVisible
( worksheet:HANDLE ) :BOOLEAN ;

Python:

def  vs.IsWSVisible(worksheet):
   return BOOLEAN

Description:

Returns display status of referenced worksheet.

説明

ハンドルで指定したワークシートが表示されている場合はTRUEを返します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル

Result:

Returns a BOOLEAN indicating the current visibility of the worksheet.

返り値

表示されている場合はTRUEを返します。



  LoadCell Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   LoadCell
(   ro :INTEGER;
    col :INTEGER;
    entry :STRING
) ;

Python:

def  vs.LoadCell(ro, col, entry):
   return None

Special Notes:

LoadCell is obsolete as of VectorWorks9.0

Description:

Procedure LoadCell inserts a value into a specified cell of the active worksheet.

説明

アクティブなワークシートの指定したセルに文字列を入力します。

Parameters:

ro Worksheet row index. 行
col Worksheet column index. 列
entry Worksheet entry value. 文字列

Example:

SprdSheet(0,0,3,3);
LoadCell(1,1,'= (14 + 2) * 3');
{ inserts a formula into a cell }

SprdSheet(0,0,3,3);
LoadCell(1,1,'Window Schedule');
{ inserts a literal into a cell }



  MoveWSColumnOperator Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   MoveWSColumnOperator
(   worksheet :HANDLE;
    databaseRow :INTEGER;
    fromColumn :INTEGER;
    toColumn :INTEGER;
    operatorType :INTEGER
) ;

Python:

def  vs.MoveWSColumnOperator(worksheet, databaseRow, fromColumn, toColumn, operatorType):
   return None

Description:

Moves database column operator between columns.

説明

ハンドルで指定したワークシートの、指定した行で並び替え（ソート）や合計のタイプを移動します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. 行
fromColumn From column to be queried. 移動元列
toColumn To column to be queried. 移動先列
operatorType Operator type. タイプ



  NewSprdSheet Worksheets 
VectorWorks8.0 - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   NewSprdSheet
(   name :STRING;
    locationX :REAL;
    locationY :REAL;
    rows :INTEGER;
    columns :INTEGER;
    showOnDrawing :BOOLEAN;
    openAfterCreate :BOOLEAN
) ;

Python:

def  vs.NewSprdSheet(name, location, rows, columns, showOnDrawing, openAfterCreate):
   return None

Special Notes:

NewSprdSheet is obsolete as of VectorWorks9.0

Description:

Procedure NewSprdSheet creates a new worksheet in a Vectorworks document.

説明

新しいワークシートを作成します。

Parameters:

name Name of new worksheet. ワークシートの名前
location Insertion point of worksheet. ワークシートの座標
rows Number of rows. 行数
columns Number of columns. 列数
showOnDrawing Display worksheet in document. 図形モードで作成
openAfterCreate Open worksheet after creation. 作成時にウインドウを開く

Example:

NewSprdSheet('Window Schedule',12,24,5,8,TRUE,FALSE);



  RecalculateWS Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   RecalculateWS
( worksheet:HANDLE ) ;

Python:

def  vs.RecalculateWS(worksheet):
   return None

Description:

Recalculates all formulas for the referenced worksheet.

説明

ハンドルで指定したワークシートを再計算します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル



  RemoveAllWSColumnOperators Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   RemoveAllWSColumnOperators
(   worksheet :HANDLE;
    databaseRow :INTEGER;
    operatorType :INTEGER
) ;

Python:

def  vs.RemoveAllWSColumnOperators(worksheet, databaseRow, operatorType):
   return None

Description:

Removes all database column operators from specified database row.

説明

ハンドルで指定したワークシートの、指定した行の並び替え（ソート）や合計のタイプをすべて削除します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. 行
operatorType Operator type. タイプ



  RemoveWSColumnOperator Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   RemoveWSColumnOperator
(   worksheet :HANDLE;
    databaseRow :INTEGER;
    column :INTEGER;
    operatorType :INTEGER
) ;

Python:

def  vs.RemoveWSColumnOperator(worksheet, databaseRow, column, operatorType):
   return None

Description:

Removes database column operator from specified column.

説明

ハンドルで指定したワークシートの、指定したセルの並び替え（ソート）や合計のタイプを削除します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. 行
column Column to be queried. 列
operatorType Operator type. タイプ



  SelectSS Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SelectSS
( h:HANDLE ) ;

Python:

def  vs.SelectSS(h):
   return None

Special Notes:

SelectSS is obsolete as of VectorWorks9.0

Description:

Procedure SelectSS opens the referenced worksheet and makes it active.

説明

ハンドルで指定したワークシートをアクティブにします。

Parameters:

h Handle to worksheet. ワークシートのハンドル



  SetSprdSortSum Worksheets 
VectorWorks8.0 - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetSprdSortSum
(   sheetHd :HANDLE;
    row :INTEGER;
    sortCol1 :INTEGER;
    sortCol2 :INTEGER;
    sortCol3 :INTEGER;
    sumCol :INTEGER
) ;

Python:

def  vs.SetSprdSortSum(sheetHd, row, sortCol1, sortCol2, sortCol3, sumCol):
   return None

Special Notes:

SetSprdSortSum is obsolete as of VectorWorks9.0

Description:

Procedure SetSprdSortSum specifies sorting and summation options for a database row in the referenced worksheet. For descending sorts, pass the column as a negative value. For no sort, pass 0 as the sumCol column.

説明

ハンドルで指定したワークシートの内容を並び替え（ソート）します。

Parameters:

sheetHd Handle to worksheet. ワークシートのハンドル
row Worksheet database row index. データベース設定行
sortCol1 Primary sort column index. 第1位の並び替え列
sortCol2 Secondary sort column index. 第2位の並び替え列
sortCol3 Tertiary sort column index. 第3位の並び替え列
sumCol Summation column. 合計の列



  SetSprdSortSumColumns Worksheets 
VectorWorks8.5 - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetSprdSortSumColumns
(   sheetHd :HANDLE;
    row :INTEGER;
    sortCol1 :INTEGER;
    sortCol2 :INTEGER;
    sortCol3 :INTEGER;
    sumCol1 :INTEGER;
    sumCol2 :INTEGER;
    sumCol3 :INTEGER
) ;

Python:

def  vs.SetSprdSortSumColumns(sheetHd, row, sortCol1, sortCol2, sortCol3, sumCol1, sumCol2, sumCol3):
   return None

Special Notes:

SetSprdSortSumColumns is obsolete as of VectorWorks9.0

Description:

Sets the sorting and summation options for a database row.

説明

ハンドルで指定したワークシートの並び替え（ソート）の設定します。

Parameters:

sheetHd Handle to worksheet. ワークシートのハンドル
row Database row of worksheet. データベース設定行
sortCol1 Primary sort column. 第1位の並び替え列
sortCol2 Secondary sort column. 第2位の並び替え列
sortCol3 Tertiary sort column. 第3位の並び替え列
sumCol1 Primary summation column. 第1位の合計の列
sumCol2 Secondary summation column. 第2位の合計の列
sumCol3 Tertiary summation column. 第3位の合計の列



  SetTopVisibleWS Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetTopVisibleWS
( worksheet:HANDLE ) ;

Python:

def  vs.SetTopVisibleWS(worksheet):
   return None

Description:

Brings the referenced worksheet to the front of any open worksheet windows.

説明

ハンドルで指定したワークシートを最上位に設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル



  SetWorksheetGridLinesVisibility Worksheets 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   SetWorksheetGridLinesVisibility
(   h :HANDLE;
    visible :BOOLEAN
) ;

Python:

def  vs.SetWorksheetGridLinesVisibility(h, visible):
   return None

Description:

Sets the visibility of the grid lines for the specified worksheet.

説明

指定したワークシート内のグリッドラインの表示形式を設定します。

Parameters:

h Handle to worksheet. ワークシートのハンドル
visible The grid line visibility flag. 表示／非表示



  SetWSAutoRecalcState Worksheets 
Vectorworks 2009

VectorScript Declaration:

PROCEDURE   SetWSAutoRecalcState
(   worksheet :HANDLE;
    state :BOOLEAN
) ;

Python:

def  vs.SetWSAutoRecalcState(worksheet, state):
   return None

Description:

Sets the AutoRecalc flag for the specified worksheet.

説明

ハンドルで指定したワークシートがセル編集時に自動再計算する／しないを設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
state Worksheet AutoRecalc flag. 自動再計算する／しない

Example:

{Save the current AutoRecalc state}
state := GetWSAutoRecalcState(h);

{Turn off worksheet Auto Recalculation}
SetWSAutoRecalcState(h,false);

{Execute worksheet edit operations ....}

{Restore AutoRecalc state}
SetWSAutoRecalcState(h, state);

{Recalculate the worksheet}
RecalculateWS(h);

See Also:

GetWSAutoRecalcState   RecalculateWS  



  SetWSCellAlignment Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSCellAlignment
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    cellAlignment :INTEGER
) ;

Python:

def  vs.SetWSCellAlignment(worksheet, topRow, leftColumn, bottomRow, rightColumn, cellAlignment):
   return None

Description:

Sets the horizontal alignment of a cell in the referenced worksheet.

SetWSCellAlignment allows a formula to be inserted into a rectangular range of cells. To set the alignment of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Alignment index values for worksheet cells correspond to the horizontal alignment index values for text used by VectorScript.

説明

ハンドルで指定したワークシートの、指定したセルの位置揃えを設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
topRow Top row of cell range. 上の行
leftColumn Leftmost column of cell range. 左の列
bottomRow Bottom row of cell range. 下の行
rightColumn Rightmost column of cell range. 右の列
cellAlignment The new alignment index value. 位置揃えの種類



  SetWSCellBorder Worksheets 
VectorWorks9.0 - obsolete as of VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetWSCellBorder
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    top :BOOLEAN;
    left :BOOLEAN;
    bottom :BOOLEAN;
    right :BOOLEAN;
    outline :BOOLEAN
) ;

Python:

def  vs.SetWSCellBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, top, left, bottom, right, outline):
   return None

Special Notes:

SetWSCellBorder is obsolete as of VectorWorks12.0

Description:

Sets the borders of a cell in the referenced worksheet.

SetWSCellBorder allows text borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

説明

ハンドルで指定したワークシートの、指定したセルの枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
topRow Top row of cell range. 上の行
leftColumn Leftmost column of cell range. 左の列
bottomRow Bottom row of cell range. 下の行
rightColumn Rightmost column of cell range. 右の列
top Top border ON-OFF status. 上の枠線
left Left border ON-OFF status. 左の枠線
bottom Bottom border ON-OFF status. 下の枠線
right Right border ON-OFF status. 右の枠線
outline All borders ON-OFF status. 周りの枠線



  SetWSCellBorders Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetWSCellBorders
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    top :BOOLEAN;
    left :BOOLEAN;
    bottom :BOOLEAN;
    right :BOOLEAN;
    OutlineInside :INTEGER
) ;

Python:

def  vs.SetWSCellBorders(worksheet, topRow, leftColumn, bottomRow, rightColumn, top, left, bottom, right, OutlineInside):
   return None

Description:

Sets the borders of cells in the referenced worksheet

SetWSCellBorders allows borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
A rectangular range of cells is formatted as a single block of cells. If you apply a right border to the range of cells, the border is displayed only on the right edge of the cells.

The borders will be created with default values ( solid style, black color, standard weight).

説明

ハンドルで指定したワークシートの、指定したセルの枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
topRow Top row of cell range 上の行番号
leftColumn Left column of cell range 左の列番号
bottomRow Bottom row of cell range 下の行番号
rightColumn Right column of cell range 右の列番号
top Top border ON-OFF status 上の枠線
left Left border ON-OFF status 左の枠線
bottom Bottom border ON-OFF status 下の枠線
right Right border ON-OFF status 右の枠線
OutlineInside Outline and Inside borders constant 内外枠（0～7）

Example:

{ Sets the inside horizontal and vertical borders for the specified rectangular range of cells}
SetWSCellBorders(sheet,2,4,1,5,FALSE,FALSE,FALSE,FALSE,6);

{ Sets an outline border for the specified rectangular range of cells}
SetWSCellBorders(sheet,2,4,1,5,FALSE,FALSE,FALSE,FALSE,1);
{or}
SetWSCellBorders(sheet,2,4,1,5,TRUE,TRUE,TRUE,TRUE,0);

See Also:

SetWSCellOutlineBorder   SetWSCellInsideVertBorder   SetWSCellInsideHorizBorder   SetWSCellTopBorder   SetWSCellLeftBorder   SetWSCellBottomBorder   SetWSCellRightBorder  



  SetWSCellBottomBN Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellBottomBN
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :LONGINT;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellBottomBN(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Description:

Sets a bottom border with the specified attributes in specified worksheet cells.

SetWSCellBottomBN allows borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
A rectangular range of cells is formatted as a single block of cells. If you apply a bottom border to the range of cells, the border is displayed only on the right edge of the cells.

説明

ハンドルで指定したワークシートの、指定したセルの下側の枠線を設定します。

セルの範囲を指定して設定します。1つのセルに対して設定するには、パラメータの上下で同じ値、左右で同じ値を設定します。

Note:
注：セルの範囲は1つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行番号
leftColumn Left column of range to set. 左の列番号
bottomRow Bottom row of range to set. 下の行番号
rightColumn Right column of range to set. 右の列番号
style Border line style to be set.(0 = None; 2 = Solid; for dashed, use negative value of Internal Index of dash line type 枠線の種類
（0：なし／2：実線／負のインデックス：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellBottomBorder Worksheets 
VectorWorks12.5 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellBottomBorder
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellBottomBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Special Notes:

SetWSCellBottomBorder is obsolete as of Vectorworks 2019

Description:

Deprecated - use SetWsCellBottomBN instead

説明

ハンドルで指定したワークシートの、指定したセルの下側の枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid, -1..-32 (dash style index) = Dash) 枠線の種類
（0：なし／2：実線／-1～-32：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellFill Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetWSCellFill
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    bgcolor :LONGINT;
    fgcolor :LONGINT;
    fillpattern :INTEGER
) ;

Python:

def  vs.SetWSCellFill(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, bgcolor, fgcolor, fillpattern):
   return None

Description:

Sets the fill style and color of a cell in the referenced worksheet

SetWSCellFill allows cell fill style and color text to be set for a range of cells. To set fill style and color for a single cell, specify identical values for the top/bottom and left/right range boundaries.

説明

ハンドルで指定したワークシートの、指定したセルの模様、及び色属性を設定します。

セルの範囲を指定して模様、及び色属性を設定します。1つのセルに模様、及び色属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
topRow Top row of cell range 上の行番号
leftColumn Left column of cell range 左の列番号
bottomRow Bottom row of cell range 下の行番号
rightColumn Right column of cell range 右の列番号
style Cell fill style to be set 模様
bgcolor Cell background color index value to be set 地色のパレット番号
fgcolor Cell foreground color index value to be set 色のパレット番号
fillpattern Cell pattern index value to be set 模様のパレット番号



  SetWSCellFormula Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSCellFormula
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    formula :STRING
) ;

Python:

def  vs.SetWSCellFormula(worksheet, topRow, leftColumn, bottomRow, rightColumn, formula):
   return None

Description:

Inserts a formula into a cell of the referenced worksheet.

SetWSCellFormula allows a formula to be inserted into a rectangular range of cells. To insert a formula into a single cell, specify identical values for the top/bottom and left/right range boundaries.

SetWSCellFormula triggers a worksheet recalculation if the AutoRecalc flag is set.
It is best to turn off that flag before using SetWSCellFormula repeatedly or in a loop and restore the flag after all operations are done (see GetWSAutoRecalcState and SetWSAutoRecalcState).
At the end, the worksheet should be recalculated by calling RecalculateWS.

説明

ハンドルで指定したワークシートの、指定したセルの式を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
topRow Top row of cell insertion range. 上の行
leftColumn Leftmost column of cell insertion range. 左の列
bottomRow Bottom row of cell insertion range. 下の行
rightColumn Rightmost column of cell insertion range. 右の列
formula Formula to be inserted into cell range. 式

Example:

{ inserts a formula into a single cell }
SetWSCellFormula(h,4,2,4,2,'=3*2');

{ inserts a formula into a range of cells }
SetWSCellFormula(h,1,1,2,10,'<empty>');

{ creates a database sub-row for the record 'Part Info' }
SetWSCellFormula(h,2,0,2,0,'=DATABASE(R IN [''PART INFO''])');


///////////////////////////////////////////////////////////////

{Save the current AutoRecalc state}
state := GetWSAutoRecalcState(h);

{Turn off worksheet Auto Recalculation}
SetWSAutoRecalcState(h,false);

FOR i := 1 TO numCols DO
BEGIN
SetWSCellFormula (h, 1, i, 1, i, Num2Str (0, i));
SetWSCellFormula (h, 2, i, 2, i , Num2Str (0, i));
END;

{Restore AutoRecalc state}
SetWSAutoRecalcState(h, state);

{Now recalculate the worksheet}
RecalculateWS(h);

See Also:

GetWSAutoRecalcState   SetWSAutoRecalcState  



  SetWSCellFormulaN Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   SetWSCellFormulaN
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    formula :DYNARRAY[] of CHAR
) ;

Python:

def  vs.SetWSCellFormulaN(worksheet, topRow, leftColumn, bottomRow, rightColumn, formula):
   return None

Description:

Inserts a formula into a cell of the referenced worksheet.

SetWSCellFormulaN allows a formula to be inserted into a rectangular range of cells. To insert a formula into a single cell, specify identical values for the top/bottom and left/right range boundaries.

SetWSCellFormulaN triggers a worksheet recalculation if the AutoRecalc flag is set.
It is best to turn off that flag before using SetWSCellFormulaN repeatedly or in a loop and restore the flag after all operations are done (see GetWSAutoRecalcState and SetWSAutoRecalcState).
At the end, the worksheet should be recalculated by calling RecalculateWS.

説明

ハンドルで指定したワークシートの、指定したセルの式を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
topRow Top row of cell insertion range. 上の行
leftColumn Leftmost column of cell insertion range. 左の列
bottomRow Bottom row of cell insertion range. 下の行
rightColumn Rightmost column of cell insertion range. 右の列
formula Formula to be inserted into cell range. 式

Example:

PROCEDURE WStest;
   VAR
       autoRecalcState : BOOLEAN;
       worksheet : HANDLE;
       inString : DYNARRAY [] OF CHAR;
BEGIN
   inString := '';

   worksheet := CreateWS('MyWS', 5, 5);

   RectangleN(0, 0, 1, 0, 1, 1);

   {Save the current AutoRecalc state}
   autoRecalcState := GetWSAutoRecalcState(worksheet);

   {Turn off worksheet Auto Recalculation}
   SetWSAutoRecalcState(worksheet, false);

   { inserts a formula into a single cell }
   inString := '=3*2';
   SetWSCellFormulaN(worksheet, 1, 2, 1, 2, inString);

   { inserts a formula into a range of cells }
   inString := '<empty>';
   SetWSCellFormulaN(worksheet, 1, 3, 2, 4, inString);

   { creates a database subrow for the type 'RECT' }
   inString := '=DATABASE((T=RECT))';
   SetWSCellFormulaN(worksheet, 3, 0, 3, 0, inString);

   { inserts a formula into a database row cell }
   inString := '=T';
   SetWSCellFormulaN(worksheet, 3, 1, 3, 1, inString);

   {Restore AutoRecalc state}
   SetWSAutoRecalcState(worksheet, autoRecalcState);

   {Now recalculate the worksheet}
   RecalculateWS(worksheet);
END;
RUN(WStest);

See Also:

GetWSAutoRecalcState   SetWSAutoRecalcState  



  SetWSCellInsideHorizBorder Worksheets 
VectorWorks12.5 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellInsideHorizBorder
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellInsideHorizBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Special Notes:

SetWSCellInsideHorizBorder is obsolete as of Vectorworks 2019

Description:

Deprecated - use SetWsCellInsideHzBN instead

説明

ハンドルで指定したワークシートの、指定したセルの内側水平方向の枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid, -1..-32 (dash style index) = Dash) 枠線の種類
（0：なし／2：実線／-1～-32：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellInsideHzBN Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellInsideHzBN
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :LONGINT;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellInsideHzBN(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Description:

Set inside horizontal borders with the specified attributes in specified worksheet cells.

SetWSCellInsideHzBN allows borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
A rectangular range of cells is formatted as a single block of cells. If you apply a top border to the range of cells, the border is displayed only on the right edge of the cells.

説明

ハンドルで指定したワークシートの、指定したセル間の内側水平方向の枠線を設定します。

セルの範囲を指定して設定します。1つのセルに対して設定するには、パラメータの上下で同じ値、左右で同じ値を設定します。

Note:
セルの範囲は1つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid; for dashed, use negative value of Internal Index of dash line type 枠線の種類
（0：なし／2：実線／負のインデックス：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の太さ（ミル）



  SetWSCellInsideVertBorder Worksheets 
VectorWorks12.5 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellInsideVertBorder
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellInsideVertBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Special Notes:

SetWSCellInsideVertBorder is obsolete as of Vectorworks 2019

Description:

Deprecated - use SetWsCellInsideVtBN instead

説明

ハンドルで指定したワークシートの、指定したセルの内側垂直方向の枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid, -1..-32 (dash style index) = Dash) 枠線の種類
（0：なし／2：実線／-1～-32：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellInsideVtBN Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellInsideVtBN
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :LONGINT;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellInsideVtBN(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Description:

Sets inside vertical borders with specified attributes in specified worksheet cells.

SetWSCellInsideVtBN allows borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
A rectangular range of cells is formatted as a single block of cells. If you apply a top border to the range of cells, the border is displayed only on the right edge of the cells.

説明

ハンドルで指定したワークシートの、指定したセル間の内側垂直方向の枠線を設定します。

セルの範囲を指定して設定します。1つのセルに対して設定するには、パラメータの上下で同じ値、左右で同じ値を設定します。

Note:
ルの範囲は1つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid; for dashed, use negative value of Internal Index of dash line type 枠線の種類
（0：なし／2：実線／負のインデックス：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellLeftBN Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellLeftBN
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :LONGINT;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellLeftBN(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Description:

Sets a left border with the specified attributes in specified worksheet cells.

SetWSCellLeftBN allows borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
A rectangular range of cells is formatted as a single block of cells. If you apply a left border to the range of cells, the border is displayed only on the right edge of the cells.

説明

ハンドルで指定したワークシートの、指定したセルの左側の枠線を設定します。

セルの範囲を指定して設定します。1つのセルに対して設定するには、パラメータの上下で同じ値、左右で同じ値を設定します。

Note:
セルの範囲は1つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid; for dashed, use negative value of Internal Index of dash line type 枠線の種類
（0：なし／2：実線／負のインデックス：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellLeftBorder Worksheets 
VectorWorks12.5 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellLeftBorder
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellLeftBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Special Notes:

SetWSCellLeftBorder is obsolete as of Vectorworks 2019

Description:

Deprecated - use SetWsCellLeftBN instead

説明

ハンドルで指定したワークシートの、指定したセルの左側の枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid, -1..-32 (dash style index) = Dash) 枠線の種類
（0：なし／2：実線／-1～-32：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellNumberFormat Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSCellNumberFormat
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    accuracy :INTEGER;
    leaderString :STRING;
    trailerString :STRING
) ;

Python:

def  vs.SetWSCellNumberFormat(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, accuracy, leaderString, trailerString):
   return None

Description:

Sets the numeric formatting of a cell in the referenced worksheet.

SetWSCellNumberFormat allows numeric formatting to be set for a rectangular range of cells. To set the formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Table - Worksheet Number Formats

Style Constant Meaning of Accuracy
General 0
Fixed Decimal 1 number of decimal places
DecwCommas 2 number of decimal places
Scientific 3 number of decimal places
Fractional 4 largest displayed denominator
Dimension 5
Angle 6 corresponds to angular accuracy in units dialog
Date 7
Conditional 8
Dimension Area 11
Dimension Volume 12
Text 13

説明

ハンドルで指定したワークシートの、指定したセルの数字の表示形式を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
topRow Top row of cell range. 上の行
leftColumn Leftmost column of cell range. 左の列
bottomRow Bottom row of cell range. 下の行
rightColumn Rightmost column of cell range. 右の列
style Numeric format style index. スタイル
accuracy Numeric accuracy / secondary format index. 精度
leaderString Leader string (where applicable). 前記号
trailerString Trailer string (where applicable). 後記号



  SetWSCellOutlineBN Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellOutlineBN
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :LONGINT;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellOutlineBN(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Description:

Outlines the specified worksheet cells with the specified border.

SetWSCellOutlineBN allows borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
A rectangular range of cells is formatted as a single block of cells. If you apply a top border to the range of cells, the border is displayed only on the right edge of the cells.

説明

ハンドルで指定したワークシートの、指定したセルの外側の枠線を設定します。

セルの範囲を指定して設定します。1つのセルに対して設定するには、パラメータの上下で同じ値、左右で同じ値を設定します。

Note:
セルの範囲は1つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid; for dashed, use negative value of Internal Index of dash line type 枠線の種類
（0：なし／2：実線／負のインデックス：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellOutlineBorder Worksheets 
VectorWorks12.5 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellOutlineBorder
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellOutlineBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Special Notes:

SetWSCellOutlineBorder is obsolete as of Vectorworks 2019

Description:

Deprecated - use SetWsCellOutlineBN instead

説明

ハンドルで指定したワークシートの、指定したセルの外側の枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid, -1..-32 (dash style index) = Dash) 枠線の種類
（0：なし／2：実線／-1～-32：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellRightBN Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellRightBN
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :LONGINT;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellRightBN(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Description:

Sets a right border with the specified attributes in specified worksheet cells.

SetWSCellRightBN allows borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
A rectangular range of cells is formatted as a single block of cells. If you apply a right border to the range of cells, the border is displayed only on the right edge of the cells.

説明

ハンドルで指定したワークシートの、指定したセルの右側の枠線を設定します。

セルの範囲を指定して設定します。1つのセルに対して設定するには、パラメータの上下で同じ値、左右で同じ値を設定します。

Note:
セルの範囲は1つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid; for dashed, use negative value of Internal Index of dash line type 枠線の種類
（0：なし／2：実線／負のインデックス：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellRightBorder Worksheets 
VectorWorks12.5 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellRightBorder
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellRightBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Special Notes:

SetWSCellRightBorder is obsolete as of Vectorworks 2019

Description:

Deprecated - use SetWsCellRightBN instead

説明

ハンドルで指定したワークシートの、指定したセルの右側の枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid, -1..-32 (dash style index) = Dash) 枠線の種類
（0：なし／2：実線／-1～-32：破線）
weight Border line weight to be set.(in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellsImgDPIRes Worksheets 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   SetWSCellsImgDPIRes
(   worksheet :HANDLE;
    dpiResolution :INTEGER
) ;

Python:

def  vs.SetWSCellsImgDPIRes(worksheet, dpiResolution):
   return None

Description:

Sets the DPI resolution for images in the specified worksheet.

説明

指定したワークシートのイメージのDPI解像度を設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
dpiResolution The images' DPI resolution. イメージのDPI解像度



  SetWSCellTextColor Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetWSCellTextColor
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellTextColor(worksheet, topRow, leftColumn, bottomRow, rightColumn, color):
   return None

Description:

Sets the text color of a cell in the referenced worksheet

SetWSCellTextColor allows text color to be set for a range of cells. To set the text color for a single cell, specify identical values for the top/bottom and left/right range boundaries.

説明

ハンドルで指定したワークシートの、指定したセルの文字色を設定します。

セルの範囲を指定して文字色を設定します。1つのセルに文字色を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
topRow Top row of cell range 上の行番号
leftColumn Left column of cell range 左の列番号
bottomRow Bottom row of cell range 下の行番号
rightColumn Right column of cell range 右の列番号
color Text color index value to be set 色番号



  SetWSCellTextFormat Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSCellTextFormat
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    fontIndex :INTEGER;
    size :INTEGER;
    style :INTEGER
) ;

Python:

def  vs.SetWSCellTextFormat(worksheet, topRow, leftColumn, bottomRow, rightColumn, fontIndex, size, style):
   return None

Description:

Sets text format settings for a cell in the referenced worksheet.

SetWSCellTextFormat allows text formatting to be set for a rectangular range of cells. To set the formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Table - Text Style

Style Constant
Plain 0
Bold 1
Italic 2
Underline 4
Outline 8
Shadowed 16
Superscript 32
Subscript 64

説明

ハンドルで指定したワークシートの、指定したセルの文字属性を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
topRow Top row of cell range. 上の行
leftColumn Leftmost column of cell range. 左の列
bottomRow Bottom row of cell range. 下の行
rightColumn Rightmost column of cell range. 右の列
fontIndex Font index for cell text. フォントの番号
size Font size for cell text. サイズ
style Font style for cell text. スタイル



  SetWSCellTopBN Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellTopBN
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :LONGINT;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellTopBN(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Description:

Sets a top border with the specified attributes in specified worksheet cells.

SetWSCellTopBN allows borders to be set for a rectangular range of cells. To set the border formatting of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
A rectangular range of cells is formatted as a single block of cells. If you apply a top border to the range of cells, the border is displayed only on the right edge of the cells.

説明

ハンドルで指定したワークシートの、指定したセルの上側の枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

Note:
セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid; for dashed, use negative value of Internal Index of dash line type 枠線の種類
（0：なし／2：実線／負のインデックス：破線）
weight Border line weight to be set. (in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellTopBorder Worksheets 
VectorWorks12.5 - obsolete as of Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSCellTopBorder
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    style :INTEGER;
    weight :INTEGER;
    color :LONGINT
) ;

Python:

def  vs.SetWSCellTopBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color):
   return None

Special Notes:

SetWSCellTopBorder is obsolete as of Vectorworks 2019

Description:

Deprecated - use SetWsCellTopBN instead

説明

ハンドルで指定したワークシートの、指定したセルの上側の枠線を設定します。

セルの範囲を指定して枠線の属性を設定します。1つのセルに枠線の属性を設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：セルの範囲は１つの区画としてフォーマットされます。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to set. 上の行
leftColumn Left column of range to set. 左の列
bottomRow Bottom row of range to set. 下の行
rightColumn Right column of range to set. 右の列
style Border line style to be set.(0 = None; 2 = Solid, -1..-32 (dash style index) = Dash) 枠線の種類
（0：なし／2：実線／-1～-32：破線）
weight Border line weight to be set. (in Mils) 枠線の太さ（ミル）
color Border line color to be set. (color index: 0..255) 枠線の色（0～255）



  SetWSCellVertAlignment Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetWSCellVertAlignment
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    vAlignment :INTEGER
) ;

Python:

def  vs.SetWSCellVertAlignment(worksheet, topRow, leftColumn, bottomRow, rightColumn, vAlignment):
   return None

Description:

Sets the vertical alignment of cells in the referenced worksheet.

SetWSCellVertAlignment allows a vertical alignment to be set for a range of cells. To set the vertical alignment of a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
Vertical alignment constants:
top = 1
center = 3
bottom = 5

説明

ハンドルで指定したワークシートの、指定したセルの垂直方向の位置揃えを設定します。

セルの範囲を指定して垂直方向の位置揃えを設定します。1つのセルに垂直方向の位置揃えを設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。

註：垂直方向の位置揃え
1＝上揃え
2＝センタ
3＝下揃え

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
topRow Top row of cell range 上の行番号
leftColumn Left column of cell range 左の列番号
bottomRow Bottom row of cell range 下の行番号
rightColumn Right column of cell range 右の列番号
vAlignment Vertical alignment index value to be set 垂直方向の位置揃え



  SetWSCellWrapTextFlag Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetWSCellWrapTextFlag
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    wrapTextFlag :BOOLEAN
) ;

Python:

def  vs.SetWSCellWrapTextFlag(worksheet, topRow, leftColumn, bottomRow, rightColumn, wrapTextFlag):
   return None

Description:

Sets the wrap text state of cells in the referenced worksheet.

SetWSCellWrapTextFlag allows wrap text to be set for a range of cells. To set wrap text in a single cell, specify identical values for the top/bottom and left/right range boundaries.
If the wrap text flag is "TRUE" in a cell, text will wrap at the cell border

説明

ハンドルで指定したワークシートの、指定したセルのラップテキストの状態を設定します。

セルの範囲を指定してラップテキストを設定します。1つのセルにラップテキストを設定するには、上下左右の範囲を指定するパラメータに同じ値を設定します。
セルのラップテキストの状態が「TRUE」なら、テキストはセルの境界線でラップされます。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
topRow Top row of cell range 上の行番号
leftColumn Left column of cell range 左の行番号
bottomRow Bottom row of cell range 下の行番号
rightColumn Right column of cell range 右の行番号
wrapTextFlag Wrap text flag to be set ラップテキストの状態



  SetWSColumnOperators Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSColumnOperators
(   worksheet :HANDLE;
    row :INTEGER;
    sort1 :INTEGER;
    sort2 :INTEGER;
    sort3 :INTEGER;
    sum1 :INTEGER;
    sum2 :INTEGER;
    sum3 :INTEGER
) ;

Python:

def  vs.SetWSColumnOperators(worksheet, row, sort1, sort2, sort3, sum1, sum2, sum3):
   return None

Description:

Sets sort and summarize column operators for a database row in the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定した行の並び替え（ソート）と合計を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
row Row that will be assigned new sort/summarize operators. 行
sort1 Primary sort column. ソート結果1
sort2 Secondary sort column. ソート結果2
sort3 Tertiary sort column. ソート結果3
sum1 Primary summarize column. 合計1
sum2 Secondary summarize column. 合計2
sum3 Tertiary summarize column. 合計3



  SetWSColumnSortType Worksheets 
Vectorworks 2012

VectorScript Declaration:

PROCEDURE   SetWSColumnSortType
(   worksheet :HANDLE;
    databaseRow :INTEGER;
    column :INTEGER;
    sortType :INTEGER
) ;

Python:

def  vs.SetWSColumnSortType(worksheet, databaseRow, column, sortType):
   return None

Description:

Sets database column sort type.

説明

ハンドルで指定したワークシートの、指定したデータベース行のソート順を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
databaseRow Database row to be queried. 行
column Column to be queried. 列



  SetWSColumnWidth Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSColumnWidth
(   worksheet :HANDLE;
    fromColumn :INTEGER;
    toColumn :INTEGER;
    width :INTEGER
) ;

Python:

def  vs.SetWSColumnWidth(worksheet, fromColumn, toColumn, width):
   return None

Description:

Sets the width of a column in the referenced worksheet.

SetWSColumnWidth allows width to be set for a range of columns. To set the width of a single worksheet column, specify identical values for the left/right column range boundaries.

説明

ハンドルで指定したワークシートの、指定した列の幅を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
fromColumn Leftmost column of column range. 開始列
toColumn Rightmost column of column range. 終了列
width New width of columns (in pixels). 列の幅（ピクセル）



  SetWSCurrentCell Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSCurrentCell
(   worksheet :HANDLE;
    currentCellRow :INTEGER;
    currentCellColumn :INTEGER
) ;

Python:

def  vs.SetWSCurrentCell(worksheet, currentCellRow, currentCellColumn):
   return None

Description:

Sets the active cell of the referenced worksheet.

説明

ハンドルで指定したワークシートの、指定したセルをアクティブにします。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
currentCellRow Row of active cell. 行
currentCellColumn Column of active cell. 列



  SetWSImageScaleF Worksheets 
Vectorworks 2017

VectorScript Declaration:

PROCEDURE   SetWSImageScaleF
(   handle :HANDLE;
    scaleFactor :REAL;
    redraw :BOOLEAN
) ;

Python:

def  vs.SetWSImageScaleF(handle, scaleFactor, redraw):
   return None

Description:

Sets the scale factor for the specified worksheet on drawing object.

説明

指定したワークシートのイメージの倍率を設定します。

Parameters:

handle The handle to the worksheet on drawing object. ワークシートのハンドル
scaleFactor The scale factor. イメージの倍率
redraw Indicates whether to immediately redraw the worksheet on drawing. すぐに再描画するかどうかのフラグ



  SetWSImgAngle Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgAngle
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    angle :REAL
) ;

Python:

def  vs.SetWSImgAngle(worksheet, topRow, leftColumn, bottomRow, rightColumn, angle):
   return None

Description:

Sets specified image angle in specified worksheet cells.

説明

指定したワークシートセルのイメージの回転角を設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
angle The image angle. イメージの回転角



  SetWSImgComponent Worksheets 
Vectorworks 2019

VectorScript Declaration:

PROCEDURE   SetWSImgComponent
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    component :INTEGER
) ;

Python:

def  vs.SetWSImgComponent(worksheet, topRow, leftColumn, bottomRow, rightColumn, component):
   return None

Description:

Sets the specified 2D component of a worksheet cell image.

Table - Components

Component Constant
3D 0
2D 1
2D Cut 2
Not set 4

説明

指定したワークシートのセルのイメージの2Dコンポーネントを設定します。

Table - Components

Component Constant
3D 0
2D 1
2D Cut 2
Not set 4

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
component The image component. イメージのコンポーネント

See Also:

GetWSImgComponent  



  SetWSImgMarginSize Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgMarginSize
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    marginSize :INTEGER
) ;

Python:

def  vs.SetWSImgMarginSize(worksheet, topRow, leftColumn, bottomRow, rightColumn, marginSize):
   return None

Description:

Sets specified image margin size in specified worksheet cells.

説明

指定したワークシートセルのイメージの余白サイズを設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
marginSize The image margin size. イメージの余白のサイズ



  SetWSImgRenderMode Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgRenderMode
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    renderMode :INTEGER
) ;

Python:

def  vs.SetWSImgRenderMode(worksheet, topRow, leftColumn, bottomRow, rightColumn, renderMode):
   return None

Description:

Sets specified image render mode in specified worksheet cells.

説明

指定したワークシートセルのイメージのレンダリングの種類を設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
renderMode The image render mode. イメージのレンダリングの種類



  SetWSImgScale Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgScale
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    scale :REAL
) ;

Python:

def  vs.SetWSImgScale(worksheet, topRow, leftColumn, bottomRow, rightColumn, scale):
   return None

Description:

Sets specified image scale in specified worksheet cells.

説明

指定したワークシートセルのイメージの縮尺を設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
scale The image scale. イメージの縮尺



  SetWSImgShowDBHeader Worksheets 
Vectorworks 2018

VectorScript Declaration:

PROCEDURE   SetWSImgShowDBHeader
(   hWorksheetImage :HANDLE;
    show :BOOLEAN;
    redrawImage :BOOLEAN
) ;

Python:

def  vs.SetWSImgShowDBHeader(hWorksheetImage, show, redrawImage):
   return None

Description:

Set worksheet image to either show or hide database headers. Also provides choice of whether to redraw the worksheet image.

説明

ワークシートオブジェクトのデータベースヘッダを表示または非表示に設定します。ワークシートを再描画するかどうかも設定できます。



  SetWSImgSize Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgSize
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    height :INTEGER;
    width :INTEGER
) ;

Python:

def  vs.SetWSImgSize(worksheet, topRow, leftColumn, bottomRow, rightColumn, height, width):
   return None

Description:

Sets specified image size in specified worksheet cells.

説明

指定したワークシートセルのイメージの大きさを設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
height The image height. イメージの高さ
width The image width. イメージの幅



  SetWSImgSizeType Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgSizeType
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    imageSizeType :INTEGER
) ;

Python:

def  vs.SetWSImgSizeType(worksheet, topRow, leftColumn, bottomRow, rightColumn, imageSizeType):
   return None

Description:

Sets specified image size type in specified worksheet cells.

説明

ワークシートセルのイメージの大きさの測り方を設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
imageSizeType The image size type. イメージの大きさの測り方



  SetWSImgType Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgType
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    type :INTEGER
) ;

Python:

def  vs.SetWSImgType(worksheet, topRow, leftColumn, bottomRow, rightColumn, type):
   return None

Description:

Sets the worksheet cells' image type.

説明

ワークシートセルのイメージタイプを設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
type The image type. イメージタイプ



  SetWSImgUseLayScale Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgUseLayScale
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    useLayerScale :BOOLEAN
) ;

Python:

def  vs.SetWSImgUseLayScale(worksheet, topRow, leftColumn, bottomRow, rightColumn, useLayerScale):
   return None

Description:

Sets the worksheet cells' image use layer scale state.

説明

ワークシートセルのイメージの大きさがレイヤの縮尺に基づくかかどうかを設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
useLayerScale The user layer scale state. レイヤの縮尺に基づくかどうか



  SetWSImgUseObjectImg Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgUseObjectImg
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    useObjectImage :BOOLEAN
) ;

Python:

def  vs.SetWSImgUseObjectImg(worksheet, topRow, leftColumn, bottomRow, rightColumn, useObjectImage):
   return None

Description:

Set state of worksheet cell's use object image..

説明

ワークシートセルがオブジェクトのイメージを使用するかどうかを設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
useObjectImage The use object image state. オブジェクトのイメージを使用するかどうか



  SetWSImgView Worksheets 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetWSImgView
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    view :INTEGER
) ;

Python:

def  vs.SetWSImgView(worksheet, topRow, leftColumn, bottomRow, rightColumn, view):
   return None

Description:

Sets specified image view in specified worksheet cells.

説明

指定したワークシートセルのイメージに指定したビューを設定します。

Parameters:

worksheet The worksheet handle. ワークシートのハンドル
topRow Top row of cell range. セル範囲の上の行
leftColumn Left column of cell range. セル範囲の左の列
bottomRow Bottom row of cell range. セル範囲の下の行
rightColumn Right column of cell range. セル範囲の右の列
view The image view. イメージのビュー



  SetWSPlacement Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSPlacement
(   worksheet :HANDLE;
    top :INTEGER;
    left :INTEGER;
    bottom :INTEGER;
    right :INTEGER
) ;

Python:

def  vs.SetWSPlacement(worksheet, top, left, bottom, right):
   return None

Description:

Sets the on-screen location and dimensions of the referenced worksheets' window.

説明

ハンドルで指定したワークシートのウインドウ位置を設定にします。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
top X-coordinate of top left corner of worksheet window. 左上のX座標
left Y-coordinate of top left corner of worksheet window. 左上のY座標
bottom X-coordinate of bottom right corner of worksheet window. 右下のX座標
right Y-coordinate of bottom right corner of worksheet window. 右下のY座標



  SetWSRowHeight Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetWSRowHeight
(   worksheet :HANDLE;
    fromRow :INTEGER;
    toRow :INTEGER;
    height :INTEGER;
    updatePalette :BOOLEAN;
    lockHeight :BOOLEAN
) ;

Python:

def  vs.SetWSRowHeight(worksheet, fromRow, toRow, height, updatePalette, lockHeight):
   return None

Description:

Sets the height of a row in the referenced worksheet.

SetWSRowHeight allows height to be set for a range of rows. To set the height of a single worksheet row, specify identical values for the top/bottom row range boundaries.

SetWSRowHeight also allows the lock state of a row to be set. Set 'TRUE' to lock or 'FALSE' to unlock the row height. If the height is locked, the row will not automatically resize to fit the contents of the cells when text is entered.

If the "updatePalette'" parameter is set to FALSE, the applied changes will not automatically be updated in the worksheet palette.

説明

ハンドルで指定したワークシートの、指定した行の高さを設定します。

行の範囲を指定して高さを設定します。ワークシート１行の高さを設定するには、開始行、終了行の範囲を指定するパラメータに同じ値を設定します。

行の設定をロックすることもできます。行の高さをロックする場合は「TRUE」、ロックしない場合は「FALSE」を設定します。高さがロックされている場合、文字が入力されても、セルの内容によって行が自動的に変形することはありません。

"updatePalette"パラメータをFALSEにした場合、追加変更がワークシートパレットに自動更新されません。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
fromRow Top row of row range 開始行番号
toRow Bottom row of row range 終了行番号
height Row height to be set (in pixels) 行の高さ（ピクセル）
updatePalette Worksheet palette update flag 自動更新の有無
lockHeight Row height lock state to be set 高さを固定の有無

Example:

{Sets and locks the height of all rows from row 3 to row 9 to 22 pixels and update the changes in the worksheet palette }
SetWSRowHeight(sheet,3,9,22,TRUE,TRUE);



  SetWSSelection Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SetWSSelection
(   worksheet :HANDLE;
    currentCellRow :INTEGER;
    currentCellColumn :INTEGER;
    topRangeRow :INTEGER;
    leftRangeColumn :INTEGER;
    topRangeSubrow :INTEGER;
    bottomRangeRow :INTEGER;
    rightRangeColumn :INTEGER;
    bottomRangeSubrow :INTEGER
) ;

Python:

def  vs.SetWSSelection(worksheet, currentCellRow, currentCellColumn, topRangeRow, leftRangeColumn, topRangeSubrow, bottomRangeRow, rightRangeColumn, bottomRangeSubrow):
   return None

Description:

Sets the current selection range of the referenced worksheet.

In addition to setting the selection range of a worksheet, SetWSSelection will can also set the selection range of database subrows, where applicable.

説明

ハンドルで指定したワークシートの、指定したセル範囲を選択します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
currentCellRow Row of currently active cell. アクティブなセルの行
currentCellColumn Column of currently active cell. アクティブなセルの列
topRangeRow Top row of selection range. 選択範囲の上の行
leftRangeColumn Leftmost column of selection range. 選択範囲の左の列
topRangeSubrow Top row of of subrow selection range. 選択範囲（補助行）の上の行
bottomRangeRow Bottom row of selection range. 選択範囲の下の行
rightRangeColumn Rightmost column of selection range. 選択範囲の右の列
bottomRangeSubrow Bottom row of subrow selection range. 選択範囲（補助行）の下の行



  SetWSTextAngle Worksheets 
VectorWorks12.0

VectorScript Declaration:

PROCEDURE   SetWSTextAngle
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER;
    angle :INTEGER
) ;

Python:

def  vs.SetWSTextAngle(worksheet, topRow, leftColumn, bottomRow, rightColumn, angle):
   return None

Description:

Sets the text angle of a cell the referenced worksheet.

SetWSTextAngle allows text angle to be set for a range of cells. To set the text angle for a single cell, specify identical values for the top/bottom and left/right range boundaries.

Note:
VW12 supports only horizontal text (0 degree) and vertical text (90 degrees).

説明

ハンドルで指定したワークシートの、指定したセルの文字の角度を設定します。
註：VW12は水平（0度）か垂直（90度）の文字列のみに対応しています。

Parameters:

worksheet Handle to worksheet ワークシートのハンドル
topRow Top row of cell range 上の行番号
leftColumn Left column of cell range 左の列番号
bottomRow Bottom row of cell range 下の行番号
rightColumn Right column of cell range 右の列番号
angle New text angle (0 or 90 degrees) 角度(0または90度)



  ShowWS Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   ShowWS
(   worksheet :HANDLE;
    show :BOOLEAN
) ;

Python:

def  vs.ShowWS(worksheet, show):
   return None

Description:

Sets the display status of the referenced worksheet.

説明

ハンドルで指定したワークシートの、表示／非表示を設定します。

Parameters:

worksheet Handle to worksheet. ワークシートのハンドル
show Desired display status of worksheet 表示させたい場合はTRUE



  ShowWSDialog Worksheets 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   ShowWSDialog
( dialogType:INTEGER ) ;

Python:

def  vs.ShowWSDialog(dialogType):
   return None

Description:

Displays a worksheet preference or settings dialog for the active worksheet.

Settings or attributes modified by the dialog will be applied to the current selection range of the worksheet.

Table - Worksheet Dialog Selectors

Index
Dialog
0
Column Width
1
Cell Border
2
Number
3
Preferences
4
Print Setup
5
Print
6
Function
7
Criteria
8
Format Text
9
Set Row Criteria
10
Edit Row Criteria

説明

アクティブなワークシートに対する設定ダイアログを表示します。

Parameters:

dialogType Index of dialog to be displayed. 設定ダイアログの種類



  SprdAlign Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SprdAlign
( align:INTEGER ) ;

Python:

def  vs.SprdAlign(align):
   return None

Special Notes:

SprdAlign is obsolete as of VectorWorks9.0

Description:

Procedure SprdAlign determines the alignment setting within a worksheet cell.

Table - Worksheet Cell Alignment

Alignment Constant
General 1
Left 2
Right 3
Center 4

説明

ワークシートのセルの位置揃えを設定します。

Parameters:

align Text alignment within worksheet cell. 位置揃え

Example:

SprdAlign(2);
LoadCell(3,3,'Cell 1,1');



  SprdBorder Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SprdBorder
(   top :BOOLEAN;
    left :BOOLEAN;
    bot :BOOLEAN;
    right :BOOLEAN
) ;

Python:

def  vs.SprdBorder(top, left, bot, right):
   return None

Special Notes:

SprdBorder is obsolete as of VectorWorks9.0

Description:

Procedure SprdBorder determines the border settings for cells within the active worksheet.

説明

アクティブなワークシートのセルに枠線を設定します。

Parameters:

top Top border on-off setting. 上辺の枠の有無
left Left border on-off setting. 左辺の枠の有無
bot Bottom border on-off setting. 下辺の枠の有無
right Right border on-off setting. 右辺の枠の有無

Example:

SprdBorder(TRUE,FALSE,TRUE,FALSE);
LoadCell(1,1,'This is a string');



  SprdFormat Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SprdFormat
(   numForm :INTEGER;
    acc :INTEGER;
    ldr :STRING;
    trailr :STRING
) ;

Python:

def  vs.SprdFormat(numForm, acc, ldr, trailr):
   return None

Special Notes:

SprdFormat is obsolete as of VectorWorks9.0

Description:

Procedure SprdFormat determines the number format for cells within the active worksheet.

Values for ldr and trailr may not exceed 8 characters.

Table - Worksheet Cell Formats

Cell Format Constant
General 0
Decimal 1
Decimal/comma 2
Scientific 3
Fractional 4
Dimension 5
Angle 6


説明

アクティブなワークシートのセルの数字の表示形式を設定します。

ldr、 trailrは8文字以上でなければなりません。

Parameters:

numForm Numeric format of cell. 数字の表示形式の種類
acc Numeric accuracy setting. 小数点以下の桁数
ldr String prefix for cell. 前記号
trailr String suffix for cell. 後記号

Example:

SprdFormat(2,2,'$','');
LoadCell(1,1,'=500 * 3.25');



  SprdSize Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SprdSize
(   h :HANDLE;
  VAR  row :INTEGER;
  VAR  col :INTEGER
) ;

Python:

def  vs.SprdSize(h):
   return (row, col)

Special Notes:

SprdSize is obsolete as of VectorWorks9.0

Description:

Procedure SprdSize returns the number of rows and columns in the referenced worksheet.

説明

ハンドルで指定したワークシートの行と列の数を返します。

Parameters:

h Handle to worksheet. ワークシートのハンドル
row Returns row size of worksheet. 行数
col Returns column size of worksheet. 列数



  SprdWidth Worksheets 
MiniCAD - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   SprdWidth
( width:REAL ) ;

Python:

def  vs.SprdWidth(width):
   return None

Special Notes:

SprdWidth is obsolete as of VectorWorks9.0

Description:

Procedure SprdWidth specifies the width of cells in a worksheet when loaded.

説明

ワークシートのセル幅を設定します。

Parameters:

width Width of worksheet cell (0-255 characters). セルの幅

Example:

SprdWidth(7);
LoadCell(1,1,'Cell 1,1');



  TargetSprdSheet Worksheets 
VectorWorks8.0 - obsolete as of VectorWorks9.0

VectorScript Declaration:

PROCEDURE   TargetSprdSheet
( h:HANDLE ) ;

Python:

def  vs.TargetSprdSheet(h):
   return None

Special Notes:

TargetSprdSheet is obsolete as of VectorWorks9.0

Description:

Procedure TargetSprdSheet selects the referenced worksheet as the active worksheet for the document. The worksheet is not opened onscreen.

説明

ハンドルで指定したワークシートをアクティブにします。

Parameters:

h Handle to worksheet. ワークシートのハンドル



  WorksheetMergeCells Worksheets 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   WorksheetMergeCells
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER
) :BOOLEAN ;

Python:

def  vs.WorksheetMergeCells(worksheet, topRow, leftColumn, bottomRow, rightColumn):
   return BOOLEAN

Description:

Merges the specified cells into a single cell.

説明

ハンドルで指定したワークシートの、指定した複数のセルを1つのセルに統合します。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to merge. 上の行
leftColumn Left column of range to merge. 左の列
bottomRow Bottom row of range to merge. 下の行
rightColumn Right column of range to merge. 右の列

Result:

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

返り値

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



  WorksheetSplitCells Worksheets 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   WorksheetSplitCells
(   worksheet :HANDLE;
    topRow :INTEGER;
    leftColumn :INTEGER;
    bottomRow :INTEGER;
    rightColumn :INTEGER
) :BOOLEAN ;

Python:

def  vs.WorksheetSplitCells(worksheet, topRow, leftColumn, bottomRow, rightColumn):
   return BOOLEAN

Description:

Splits the specified cells back into individual cells.

説明

ハンドルで指定したワークシートの、指定したセルを分離して個別のセルに戻します。

Parameters:

worksheet Worksheet on which function is to operate. ワークシートのハンドル
topRow Top row of range to split. 上の行
leftColumn Left column of range to split. 左の列
bottomRow Bottom row of range to split. 下の行
rightColumn Right column of range to split. 右の列

Result:

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

返り値

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



  WSScript_AddHandle Worksheets 
Vectorworks 2020

VectorScript Declaration:

PROCEDURE   WSScript_AddHandle
( h:HANDLE ) ;

Python:

def  vs.WSScript_AddHandle(h):
   return None

Description:

Add a handle for a worksheet script usage. This is most notable used for scripts that generate object database for worksheets.

説明

ワークシート関数にハンドルを追加します。

Parameters:

h The handle of an object to be added 追加するオブジェクトのハンドル



  WSScript_AddHandleId Worksheets 
Vectorworks 2021

VectorScript Declaration:

PROCEDURE   WSScript_AddHandleId
(   h :HANDLE;
    id :INTEGER
) ;

Python:

def  vs.WSScript_AddHandleId(h, id):
   return None

Description:

Add a handle with id for a worksheet script usage. This is most notable used for scripts that generate object database for worksheets.

説明

ワークシート関数にID付きのハンドルを追加します。ワークシートにオブジェクトデータベースを生成するスクリプトに使用するには最適です。

Parameters:

h The handle of an object to be added 追加するオブジェクトのハンドル
id The id of the handle ハンドルのID



  WSScript_GetEdit Worksheets 
Vectorworks 2021

VectorScript Declaration:

FUNCTION   WSScript_GetEdit
( VAR outNewValue:DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.WSScript_GetEdit():
   return (BOOLEAN, outNewValue)

Description:

This function must be used inside a worksheet script called by 'RunScriptEdit' worksheet formula. It will tell the script when a value has been change and what's the value. Use 'WSScript_GetEditObj' to get the value.

説明

この関数はRunScriptEditワークシート式で呼び出すワークシートスクリプト内で使用してください。いつ値が変更されたのかと、その値をスクリプトに渡します。値の取得にはWSScript_GetEditObjを使用します。

Parameters:

outNewValue The new value for the cell as inputted by the user. 変更された新しい値

Result:

Return true if the cell is being edited.

返り値

値が変更されたかどうか

See Also:

WSScript_GetEditObj  



  WSScript_GetEditObj Worksheets 
Vectorworks 2021

VectorScript Declaration:

FUNCTION   WSScript_GetEditObj
(   objIndex :INTEGER;
  VAR  outObj :HANDLE
) :BOOLEAN ;

Python:

def  vs.WSScript_GetEditObj(objIndex):
   return (BOOLEAN, outObj)

Description:

This function must be used inside a worksheet script called by 'RunScriptEdit' worksheet formula. It will return the object being edited when 'WSScript_GetEdit' returns that the script is in edit mode.

説明

この関数はRunScriptEditワークシート式で呼び出すワークシートスクリプト内で使用してください。

Parameters:

objIndex Index to the object to be returned as the script can be called for a set of objects. Will return FALSE if no such object. オブジェクトの番号
outObj Output the object that is being edited. 編集されたオブジェクト

Result:

Return FALSE and NIL or vs.Handle() if the index is outside the range.

返り値

オブジェクトの番号が範囲外だった場合にはFALSEを返します。

See Also:

WSScript_GetEdit  



  WSScript_GetObject Worksheets 
Vectorworks 2016

VectorScript Declaration:

FUNCTION   WSScript_GetObject
:HANDLE ;

Python:

def  vs.WSScript_GetObject():
   return HANDLE

Description:

This function must be used inside a worksheet script called by 'RunScript' worksheet formula.

説明

この関数は 'RunScript' ワークシート式で呼び出すワークシートスクリプト内で使用してください。
スクリプト実行時にワークシート検索条件で処理されているオブジェクトを返します。

Result:

Returns the object currently being processed by the worksheet criteria at the time of the script execution.

返り値

ワークシート検索条件で処理されているオブジェクトのハンドルを返します。

See Also:

WSScript_GetObject   WSScript_GetPrmInt   WSScript_GetPrmReal   WSScript_GetPrmStr   WSScript_SetResStr   WSScript_SetResReal   WSScript_SetResImage  



  WSScript_GetPrmInt Worksheets 
Vectorworks 2016

VectorScript Declaration:

FUNCTION   WSScript_GetPrmInt
( paramIndex:INTEGER ) :INTEGER ;

Python:

def  vs.WSScript_GetPrmInt(paramIndex):
   return INTEGER

Description:

This function must be used inside a worksheet script called by 'RunScript' worksheet formula.

説明

この関数は 'RunScript' ワークシート式で呼び出すワークシートスクリプト内で使用してください。
指定したパラメータの整数値を返します。

Parameters:

paramIndex Zero based index of the parameter passed to the RunScript worksheet function. パラメータ番号

Result:

Returns the integer value of the specified parameter.

返り値

指定したパラメータの整数値を返します。

See Also:

WSScript_GetObject   WSScript_GetPrmInt   WSScript_GetPrmReal   WSScript_GetPrmStr   WSScript_SetResStr   WSScript_SetResReal   WSScript_SetResImage  



  WSScript_GetPrmReal Worksheets 
Vectorworks 2016

VectorScript Declaration:

FUNCTION   WSScript_GetPrmReal
( paramIndex:INTEGER ) :REAL ;

Python:

def  vs.WSScript_GetPrmReal(paramIndex):
   return REAL

Description:

This function must be used inside a worksheet script called by 'RunScript' worksheet formula.

説明

この関数は 'RunScript' ワークシート式で呼び出すワークシートスクリプト内で使用してください。
指定したパラメータの実数値を返します。

Parameters:

paramIndex Zero based index of the parameter passed to the RunScript worksheet function. パラメータ番号

Result:

Returns the real value of the specified parameter.

返り値

指定したパラメータの実数値を返します。

See Also:

WSScript_GetObject   WSScript_GetPrmInt   WSScript_GetPrmReal   WSScript_GetPrmStr   WSScript_SetResStr   WSScript_SetResReal   WSScript_SetResImage  



  WSScript_GetPrmStr Worksheets 
Vectorworks 2016

VectorScript Declaration:

FUNCTION   WSScript_GetPrmStr
( paramIndex:INTEGER ) :STRING ;

Python:

def  vs.WSScript_GetPrmStr(paramIndex):
   return STRING

Description:

This function must be used inside a worksheet script called by 'RunScript' worksheet formula.

説明

この関数は 'RunScript' ワークシート式で呼び出すワークシートスクリプト内で使用してください。
指定したパラメータのストリング値を返します。

Parameters:

paramIndex Zero based index of the parameter passed to the RunScript worksheet function. パラメータ番号

Result:

Returns the string value of the specified parameter.

返り値

指定したパラメータのストリング値を返します。

See Also:

WSScript_GetObject   WSScript_GetPrmInt   WSScript_GetPrmReal   WSScript_GetPrmStr   WSScript_SetResStr   WSScript_SetResReal   WSScript_SetResImage  



  WSScript_SetResImage Worksheets 
Vectorworks 2016

VectorScript Declaration:

PROCEDURE   WSScript_SetResImage
( h:HANDLE ) ;

Python:

def  vs.WSScript_SetResImage(h):
   return None

Description:

This function must be used inside a worksheet script called by 'RunScript' worksheet formula.

Set the result of the worksheet script to the object to be used as image in the cell.

説明

この関数は 'RunScript' ワークシート式で呼び出すワークシートスクリプト内で使用してください。
セル内のイメージとして使用されるオブジェクトのワークシートスクリプト結果を設定します。

Parameters:

h The handle of the object that will be used for image in the cell. セル内のイメージとして使用されるオブジェクトのハンドル

See Also:

WSScript_GetObject   WSScript_GetPrmInt   WSScript_GetPrmReal   WSScript_GetPrmStr   WSScript_SetResStr   WSScript_SetResReal   WSScript_SetResImage  



  WSScript_SetResInt Worksheets 
Vectorworks 2016

VectorScript Declaration:

PROCEDURE   WSScript_SetResInt
( resultCellValue:INTEGER ) ;

Python:

def  vs.WSScript_SetResInt(resultCellValue):
   return None

Description:

This function must be used inside a worksheet script called by 'RunScript' worksheet formula.

Set the result of the worksheet script to the integer value specified.

説明

この関数は 'RunScript' ワークシート式で呼び出すワークシートスクリプト内で使用してください。
指定した整数値のワークシートスクリプトの結果を設定します。

Parameters:

resultCellValue The value for the result of the worksheet script called by the RunScript worksheet function. ワークシートスクリプトの結果を設定する整数値

See Also:

WSScript_GetObject   WSScript_GetPrmInt   WSScript_GetPrmReal   WSScript_GetPrmStr   WSScript_SetResStr   WSScript_SetResReal   WSScript_SetResImage  



  WSScript_SetResReal Worksheets 
Vectorworks 2016

VectorScript Declaration:

PROCEDURE   WSScript_SetResReal
( resultCellValue:REAL ) ;

Python:

def  vs.WSScript_SetResReal(resultCellValue):
   return None

Description:

This function must be used inside a worksheet script called by 'RunScript' worksheet formula.

Set the result of the worksheet script to the real value specified.

説明

この関数は 'RunScript' ワークシート式で呼び出すワークシートスクリプト内で使用してください。
指定した実数値のワークシートスクリプトの結果を設定します。

Parameters:

resultCellValue The value for the result of the worksheet script called by the RunScript worksheet function. ワークシートスクリプトの結果を設定する実数値

See Also:

WSScript_GetObject   WSScript_GetPrmInt   WSScript_GetPrmReal   WSScript_GetPrmStr   WSScript_SetResStr   WSScript_SetResReal   WSScript_SetResImage  



  WSScript_SetResStr Worksheets 
Vectorworks 2016

VectorScript Declaration:

PROCEDURE   WSScript_SetResStr
( resultCellValue:DYNARRAY[] of CHAR ) ;

Python:

def  vs.WSScript_SetResStr(resultCellValue):
   return None

Description:

This function must be used inside a worksheet script called by 'RunScript' worksheet formula.

Set the result of the worksheet script to the string value specified.

説明

この関数は 'RunScript' ワークシート式で呼び出すワークシートスクリプト内で使用してください。
指定したストリング値のワークシートスクリプトの結果を設定します。

Parameters:

resultCellValue The value for the result of the worksheet script called by the RunScript worksheet function. ワークシートスクリプトの結果を設定するストリング値

See Also:

WSScript_GetObject   WSScript_GetPrmInt   WSScript_GetPrmReal   WSScript_GetPrmStr   WSScript_SetResStr   WSScript_SetResReal   WSScript_SetResImage