| ActSSheet | Worksheets MiniCAD - obsolete as of VectorWorks9.0 |
VectorScript Declaration:
FUNCTION ActSSheet
:HANDLE ; Python:
return HANDLE
def vs.ActSSheet(): 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:
return None
def vs.AddWSColumnOperator(worksheet, databaseRow, column, operatorType): 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:
return BOOLEAN
def vs.AreWorksheetGridLinesVisible(h): 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:
return None
def vs.AutoFitWSRowHeights(worksheet, fromRow, toRow): 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.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:
return BOOLEAN
def vs.CellHasNum(h, row, col): 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.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:
return BOOLEAN
def vs.CellHasStr(h, row, col): 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.
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:
return STRING
def vs.CellString(row, column): Special Notes:
CellString is obsolete as of VectorWorks9.0
Description:
Function CellString returns the string of a specified cell in the active worksheetParameters:
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:
return REAL
def vs.CellValue(row, column): 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:
return None
def vs.ClearWSCell(worksheet, topRow, leftColumn, bottomRow, rightColumn): 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:
return None
def vs.CloseSS(h): 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:
return HANDLE
def vs.CreateWS(name, rows, columns): 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:
return HANDLE
def vs.CreateWSImage(worksheet, location): 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:
return None
def vs.DeleteWSColumns(worksheet, startColumn, numColumns): 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:
return None
def vs.DeleteWSRows(worksheet, startRow, numRows): 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:
return None
def vs.EnableDrawingWorksheetPalette(enable, worksheet): 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. 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:
return INTEGER
def vs.GetCAlign(h, row, col): 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:
return REAL
def vs.GetCellNum(h, row, col): 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:
return STRING
def vs.GetCellStr(h, row, col): 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:
return INTEGER
def vs.GetCWidth(h, row, col): 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:
return (sortCol1, sortCol2, sortCol3, sumCol)
def vs.GetSprdSortSum(sheetHd, row): 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. sortCol2 Secondary sort column index. sortCol3 Tertiary sort column index. 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:
return (sortCol1, sortCol2, sortCol3, sumCol1, sumCol2, sumCol3)
def vs.GetSprdSortSumColumns(sheetHd, row): 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. sortCol2 Secondary sort column. sortCol3 Tertiary sort column. sumCol1 Primary summation column. sumCol2 Secondary summation column. sumCol3 Tertiary summation column.
| GetTopVisibleWS | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetTopVisibleWS
:HANDLE ; Python:
return HANDLE
def vs.GetTopVisibleWS(): 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:
return BOOLEAN
def vs.GetWSAutoRecalcState(worksheet): 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.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:
return cellAlignment
def vs.GetWSCellAlignment(worksheet, row, column): 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:
return (top, left, bottom, right)
def vs.GetWSCellBorder(worksheet, row, column): 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:
return (style, bgcolor, fgcolor, fillpattern)
def vs.GetWSCellFill(worksheet, row, column): Description:
Returns the fill style and color of a cell in the referenced worksheetParameters:
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:
return formula
def vs.GetWSCellFormula(worksheet, row, column): 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:
return formula
def vs.GetWSCellFormulaN(worksheet, row, column): 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:
return (style, accuracy, leaderString, trailerString)
def vs.GetWSCellNumberFormat(worksheet, row, column): 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).
| GetWSCellString | Worksheets VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE GetWSCellString
( worksheet :HANDLE; row :INTEGER; column :INTEGER; VAR cellString :STRING ) ; Python:
return cellString
def vs.GetWSCellString(worksheet, row, column): 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:
return cellString
def vs.GetWSCellStringN(worksheet, row, column): 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:
return angle
def vs.GetWSCellTextAngle(worksheet, row, column): Description:
Returns the text angle of a cell in the referenced worksheetParameters:
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:
return color
def vs.GetWSCellTextColor(worksheet, row, column): Description:
Returns the text color of a cell in the referenced worksheetParameters:
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:
return (fontIndex, size, style)
def vs.GetWSCellTextFormat(worksheet, row, column): 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:
return cellValue
def vs.GetWSCellValue(worksheet, row, column): 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:
return vAlignment
def vs.GetWSCellVertAlignment(worksheet, row, column): 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:
return wrapTextFlag
def vs.GetWSCellWrapTextFlag(worksheet, row, column): 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:
return (sort1, sort2, sort3, sum1, sum2, sum3)
def vs.GetWSColumnOperators(worksheet, row): 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. sort2 Secondary sort column. sort3 Tertiary sort column. sum1 Primary summarize column. sum2 Secondary summarize column. sum3 Tertiary summarize column.
| GetWSColumnSortPrecedence | Worksheets Vectorworks 2012 |
VectorScript Declaration:
FUNCTION GetWSColumnSortPrecedence
( worksheet :HANDLE; databaseRow :INTEGER; column :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetWSColumnSortPrecedence(worksheet, databaseRow, column): 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:
return INTEGER
def vs.GetWSColumnSortType(worksheet, databaseRow, column): 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:
return width
def vs.GetWSColumnWidth(worksheet, column): 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:
return HANDLE
def vs.GetWSFromImage(worksheetImage): 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:
return HANDLE
def vs.GetWSImage(worksheet): 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.
| GetWSImgAngle | Worksheets Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE GetWSImgAngle
( worksheet :HANDLE; row :INTEGER; column :INTEGER; VAR NewParam :REAL ) ; Python:
return NewParam
def vs.GetWSImgAngle(worksheet, row, column): Description:
Gets the specified worksheet cell's image angle.Parameters:
row The cell row. column The cell column. NewParam The image angle.
| GetWSImgMarginSize | Worksheets Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE GetWSImgMarginSize
( worksheet :HANDLE; row :INTEGER; column :INTEGER; VAR marginSize :INTEGER ) ; Python:
return marginSize
def vs.GetWSImgMarginSize(worksheet, row, column): 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:
return renderMode
def vs.GetWSImgRenderMode(worksheet, row, column): Description:
Gets the specified worksheet cell's image render modeParameters:
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:
return scale
def vs.GetWSImgScale(worksheet, row, column): 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.
| GetWSImgSize | Worksheets Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE GetWSImgSize
( worksheet :HANDLE; row :INTEGER; column :INTEGER; VAR height :INTEGER; VAR width :INTEGER ) ; Python:
return (height, width)
def vs.GetWSImgSize(worksheet, row, column): 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:
return INTEGER
def vs.GetWSImgSizeType(worksheet, row, column): 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.
| GetWSImgType | Worksheets Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE GetWSImgType
( worksheet :HANDLE; row :INTEGER; column :INTEGER; VAR type :INTEGER ) ; Python:
return type
def vs.GetWSImgType(worksheet, row, column): 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:
return BOOLEAN
def vs.GetWSImgUseLayScale(worksheet, row, column): 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.
| GetWSImgUseObjectImg | Worksheets Vectorworks 2014 |
VectorScript Declaration:
FUNCTION GetWSImgUseObjectImg
( worksheet :HANDLE; row :INTEGER; column :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.GetWSImgUseObjectImg(worksheet, row, column): 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.
| GetWSImgView | Worksheets Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE GetWSImgView
( worksheet :HANDLE; row :INTEGER; column :INTEGER; VAR view :INTEGER ) ; Python:
return view
def vs.GetWSImgView(worksheet, row, column): Description:
Gets the specified worksheet cell's image view.Parameters:
worksheet The 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:
return (BOOLEAN, topRow, leftColumn, bottomRow, rightColumn)
def vs.GetWSMergedCellRange(worksheet, row, column): Description:
Gets the range of cells covered by the specified cell. Returns true if the specified cell is a merged cell.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.
| GetWSPlacement | Worksheets VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE GetWSPlacement
( worksheet :HANDLE; VAR top :INTEGER; VAR left :INTEGER; VAR bottom :INTEGER; VAR right :INTEGER ) ; Python:
return (top, left, bottom, right)
def vs.GetWSPlacement(worksheet): 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. left Y-coordinate of top left corner of worksheet window. bottom X-coordinate of bottom right corner of worksheet window. right Y-coordinate of bottom right corner of worksheet window.
| GetWSRowColumnCount | Worksheets VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE GetWSRowColumnCount
( worksheet :HANDLE; VAR numRows :INTEGER; VAR numColumns :INTEGER ) ; Python:
return (numRows, numColumns)
def vs.GetWSRowColumnCount(worksheet): 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:
return height
def vs.GetWSRowHeight(worksheet, row): 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:
return lockState
def vs.GetWSRowHLockState(worksheet, row): 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:
return (currentCellRow, currentCellColumn, topRangeRow, leftRangeColumn, topRangeSubrow, bottomRangeRow, rightRangeColumn, bottomRangeSubrow)
def vs.GetWSSelection(worksheet): 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:
return cellString
def vs.GetWSSubrowActualCellString(worksheet, row, column, subrow): 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:
return cellString
def vs.GetWSSubrowActualStringN(worksheet, row, column, subrow): 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:
return cellString
def vs.GetWSSubrowCellString(worksheet, row, column, subrow): 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:
return cellString
def vs.GetWSSubrowCellStrN(worksheet, row, column, subrow): 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. 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:
return cellValue
def vs.GetWSSubrowCellValue(worksheet, row, column, subrow): 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:
return numSubrows
def vs.GetWSSubrowCount(worksheet, databaseRow): 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:
return height
def vs.GetWSSubrowHeight(worksheet, databaserow, subrow): 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:
return BOOLEAN
def vs.HasWSColumnOperator(worksheet, databaseRow, column, operatorType): 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:
return None
def vs.InsertWSColumns(worksheet, beforeColumn, numColumns): 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:
return None
def vs.InsertWSRows(worksheet, beforeRow, numRows): 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:
return BOOLEAN
def vs.IsValidWSCell(worksheet, row, column): Description:
Returns if a specified cell is within the valid range of the referenced worksheet.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.
| IsValidWSRange | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION IsValidWSRange
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsValidWSRange(worksheet, topRow, leftColumn, bottomRow, rightColumn): Description:
Returns whether the specified range is within the valid range of the referenced worksheet.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.
| IsValidWSSubrowCell | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION IsValidWSSubrowCell
( worksheet :HANDLE; row :INTEGER; column :INTEGER; subrow :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsValidWSSubrowCell(worksheet, row, column, subrow): Description:
Returns whether a specified database subrow cell is in the valid range of displayed subrows.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.
| IsWSCellNumber | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION IsWSCellNumber
( worksheet :HANDLE; row :INTEGER; column :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsWSCellNumber(worksheet, row, column): 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.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.
| IsWSCellString | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION IsWSCellString
( worksheet :HANDLE; row :INTEGER; column :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsWSCellString(worksheet, row, column): 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.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.
| IsWSDatabaseRow | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION IsWSDatabaseRow
( worksheet :HANDLE; databaseRow :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsWSDatabaseRow(worksheet, databaseRow): Description:
Returns whether a row in the referenced worksheet is a database row.Parameters:
worksheet Handle to worksheet. databaseRow Row to be queried. Result:
A BOOLEAN value indicating the database status of the targeted row.
| IsWSImg | Worksheets Vectorworks 2014 |
VectorScript Declaration:
FUNCTION IsWSImg
( worksheet :HANDLE; row :INTEGER; column :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsWSImg(worksheet, row, column): 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.
| IsWSSubrowCellNumber | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION IsWSSubrowCellNumber
( worksheet :HANDLE; row :INTEGER; column :INTEGER; subrow :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsWSSubrowCellNumber(worksheet, row, column, subrow): Description:
Returns whether a specified database subrow cell contains a numeric value.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.
| IsWSSubrowCellString | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION IsWSSubrowCellString
( worksheet :HANDLE; row :INTEGER; column :INTEGER; subrow :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsWSSubrowCellString(worksheet, row, column, subrow): Description:
Returns whether a specified database subrow cell contains a numeric value.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.
| IsWSVisible | Worksheets VectorWorks9.0 |
VectorScript Declaration:
FUNCTION IsWSVisible
( worksheet:HANDLE ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsWSVisible(worksheet): Description:
Returns display status of referenced worksheet.Parameters:
worksheet Handle to worksheet. Result:
Returns a BOOLEAN indicating the current visibility of the worksheet.
| LoadCell | Worksheets MiniCAD - obsolete as of VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE LoadCell
( ro :INTEGER; col :INTEGER; entry :STRING ) ; Python:
return None
def vs.LoadCell(ro, col, entry): 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:
return None
def vs.MoveWSColumnOperator(worksheet, databaseRow, fromColumn, toColumn, operatorType): 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:
return None
def vs.NewSprdSheet(name, location, rows, columns, showOnDrawing, openAfterCreate): 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:
return None
def vs.RecalculateWS(worksheet): 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:
return None
def vs.RemoveAllWSColumnOperators(worksheet, databaseRow, operatorType): 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:
return None
def vs.RemoveWSColumnOperator(worksheet, databaseRow, column, operatorType): 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:
return None
def vs.SelectSS(h): 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:
return None
def vs.SetSprdSortSum(sheetHd, row, sortCol1, sortCol2, sortCol3, sumCol): 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. sortCol2 Secondary sort column index. sortCol3 Tertiary sort column index. 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:
return None
def vs.SetSprdSortSumColumns(sheetHd, row, sortCol1, sortCol2, sortCol3, sumCol1, sumCol2, sumCol3): 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. sortCol2 Secondary sort column. sortCol3 Tertiary sort column. sumCol1 Primary summation column. sumCol2 Secondary summation column. sumCol3 Tertiary summation column.
| SetTopVisibleWS | Worksheets VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetTopVisibleWS
( worksheet:HANDLE ) ; Python:
return None
def vs.SetTopVisibleWS(worksheet): 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:
return None
def vs.SetWorksheetGridLinesVisibility(h, visible): 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:
return None
def vs.SetWSAutoRecalcState(worksheet, state): 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:
return None
def vs.SetWSCellAlignment(worksheet, topRow, leftColumn, bottomRow, rightColumn, cellAlignment): 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:
return None
def vs.SetWSCellBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, top, left, bottom, right, outline): 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.
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:
return None
def vs.SetWSCellBorders(worksheet, topRow, leftColumn, bottomRow, rightColumn, top, left, bottom, right, OutlineInside): 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).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 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
| SetWSCellBottomBorder | Worksheets VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetWSCellBottomBorder
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; style :INTEGER; weight :INTEGER; color :LONGINT ) ; Python:
return None
def vs.SetWSCellBottomBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color): Description:
Sets a bottom border with the specified attributes in specified worksheet cells.
SetWSCellBottomBorder 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.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) weight Border line weight to be set.(in Mils) color Border line color to be set. (color index: 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:
return None
def vs.SetWSCellFill(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, bgcolor, fgcolor, fillpattern): 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.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:
return None
def vs.SetWSCellFormula(worksheet, topRow, leftColumn, bottomRow, rightColumn, formula): 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:
return None
def vs.SetWSCellFormulaN(worksheet, topRow, leftColumn, bottomRow, rightColumn, formula): 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 |
VectorScript Declaration:
PROCEDURE SetWSCellInsideHorizBorder
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; style :INTEGER; weight :INTEGER; color :LONGINT ) ; Python:
return None
def vs.SetWSCellInsideHorizBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color): Description:
Set inside horizontal borders with the specified attributes in specified worksheet cells.
SetWSCellInsideHorizBorder 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.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) weight Border line weight to be set.(in Mils) color Border line color to be set. (color index: 0..255)
| SetWSCellInsideVertBorder | Worksheets VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetWSCellInsideVertBorder
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; style :INTEGER; weight :INTEGER; color :LONGINT ) ; Python:
return None
def vs.SetWSCellInsideVertBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color): Description:
Sets inside vertical borders with specified attributes in specified worksheet cells.
SetWSCellInsideVertBorder 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.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) weight Border line weight to be set.(in Mils) color Border line color to be set. (color index: 0..255)
| SetWSCellLeftBorder | Worksheets VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetWSCellLeftBorder
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; style :INTEGER; weight :INTEGER; color :LONGINT ) ; Python:
return None
def vs.SetWSCellLeftBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color): Description:
Sets a left border with the specified attributes in specified worksheet cells.
SetWSCellLeftBorder 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.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) weight Border line weight to be set.(in Mils) color Border line color to be set. (color index: 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:
return None
def vs.SetWSCellNumberFormat(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, accuracy, leaderString, trailerString): 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).
| SetWSCellOutlineBorder | Worksheets VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetWSCellOutlineBorder
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; style :INTEGER; weight :INTEGER; color :LONGINT ) ; Python:
return None
def vs.SetWSCellOutlineBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color): Description:
Outlines the specified worksheet cells with the specified border.
SetWSCellOutlineBorder 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.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) weight Border line weight to be set.(in Mils) color Border line color to be set. (color index: 0..255)
| SetWSCellRightBorder | Worksheets VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetWSCellRightBorder
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; style :INTEGER; weight :INTEGER; color :LONGINT ) ; Python:
return None
def vs.SetWSCellRightBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color): Description:
Sets a right border with the specified attributes in specified worksheet cells.
SetWSCellRightBorder 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.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) weight Border line weight to be set.(in Mils) color Border line color to be set. (color index: 0..255)
| SetWSCellTextColor | Worksheets VectorWorks12.0 |
VectorScript Declaration:
PROCEDURE SetWSCellTextColor
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; color :LONGINT ) ; Python:
return None
def vs.SetWSCellTextColor(worksheet, topRow, leftColumn, bottomRow, rightColumn, color): 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.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:
return None
def vs.SetWSCellTextFormat(worksheet, topRow, leftColumn, bottomRow, rightColumn, fontIndex, size, style): 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.
| SetWSCellTopBorder | Worksheets VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetWSCellTopBorder
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; style :INTEGER; weight :INTEGER; color :LONGINT ) ; Python:
return None
def vs.SetWSCellTopBorder(worksheet, topRow, leftColumn, bottomRow, rightColumn, style, weight, color): Description:
Sets a top border with the specified attributes in specified worksheet cells.
SetWSCellTopBorder 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.
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) weight Border line weight to be set. (in Mils) color Border line color to be set. (color index: 0..255)
| SetWSCellVertAlignment | Worksheets VectorWorks12.0 |
VectorScript Declaration:
PROCEDURE SetWSCellVertAlignment
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; vAlignment :INTEGER ) ; Python:
return None
def vs.SetWSCellVertAlignment(worksheet, topRow, leftColumn, bottomRow, rightColumn, vAlignment): 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 = 5Parameters:
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:
return None
def vs.SetWSCellWrapTextFlag(worksheet, topRow, leftColumn, bottomRow, rightColumn, wrapTextFlag): 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 borderParameters:
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:
return None
def vs.SetWSColumnOperators(worksheet, row, sort1, sort2, sort3, sum1, sum2, sum3): 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. sort2 Secondary sort column. sort3 Tertiary sort column. sum1 Primary summarize column. sum2 Secondary summarize column. sum3 Tertiary summarize column.
| SetWSColumnSortType | Worksheets Vectorworks 2012 |
VectorScript Declaration:
PROCEDURE SetWSColumnSortType
( worksheet :HANDLE; databaseRow :INTEGER; column :INTEGER; sortType :INTEGER ) ; Python:
return None
def vs.SetWSColumnSortType(worksheet, databaseRow, column, sortType): 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:
return None
def vs.SetWSColumnWidth(worksheet, fromColumn, toColumn, width): 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:
return None
def vs.SetWSCurrentCell(worksheet, currentCellRow, currentCellColumn): Description:
Sets the active cell of the referenced worksheet.Parameters:
worksheet Handle to worksheet. currentCellRow Row of active cell. currentCellColumn Column of active cell.
| SetWSImgAngle | Worksheets Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE SetWSImgAngle
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; angle :REAL ) ; Python:
return None
def vs.SetWSImgAngle(worksheet, topRow, leftColumn, bottomRow, rightColumn, angle): 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.
| SetWSImgMarginSize | Worksheets Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE SetWSImgMarginSize
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; marginSize :INTEGER ) ; Python:
return None
def vs.SetWSImgMarginSize(worksheet, topRow, leftColumn, bottomRow, rightColumn, marginSize): 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:
return None
def vs.SetWSImgRenderMode(worksheet, topRow, leftColumn, bottomRow, rightColumn, renderMode): 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:
return None
def vs.SetWSImgScale(worksheet, topRow, leftColumn, bottomRow, rightColumn, scale): 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.
| SetWSImgSize | Worksheets Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE SetWSImgSize
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER; height :INTEGER; width :INTEGER ) ; Python:
return None
def vs.SetWSImgSize(worksheet, topRow, leftColumn, bottomRow, rightColumn, height, width): 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:
return None
def vs.SetWSImgSizeType(worksheet, topRow, leftColumn, bottomRow, rightColumn, imageSizeType): 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:
return None
def vs.SetWSImgType(worksheet, topRow, leftColumn, bottomRow, rightColumn, type): 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:
return None
def vs.SetWSImgUseLayScale(worksheet, topRow, leftColumn, bottomRow, rightColumn, useLayerScale): 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:
return None
def vs.SetWSImgUseObjectImg(worksheet, topRow, leftColumn, bottomRow, rightColumn, useObjectImage): 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:
return None
def vs.SetWSImgView(worksheet, topRow, leftColumn, bottomRow, rightColumn, view): 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:
return None
def vs.SetWSPlacement(worksheet, top, left, bottom, right): 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. left Y-coordinate of top left corner of worksheet window. bottom X-coordinate of bottom right corner of worksheet window. right Y-coordinate of bottom right corner of worksheet window.
| SetWSRowHeight | Worksheets VectorWorks12.0 |
VectorScript Declaration:
PROCEDURE SetWSRowHeight
( worksheet :HANDLE; fromRow :INTEGER; toRow :INTEGER; height :INTEGER; updatePalette :BOOLEAN; lockHeight :BOOLEAN ) ; Python:
return None
def vs.SetWSRowHeight(worksheet, fromRow, toRow, height, updatePalette, lockHeight): 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.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:
return None
def vs.SetWSSelection(worksheet, currentCellRow, currentCellColumn, topRangeRow, leftRangeColumn, topRangeSubrow, bottomRangeRow, rightRangeColumn, bottomRangeSubrow): 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:
return None
def vs.SetWSTextAngle(worksheet, topRow, leftColumn, bottomRow, rightColumn, angle): 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).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)
| ShowWS | Worksheets VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE ShowWS
( worksheet :HANDLE; show :BOOLEAN ) ; Python:
return None
def vs.ShowWS(worksheet, show): Description:
Sets the display status of the referenced worksheet.Parameters:
worksheet Handle to worksheet. show Desired display status of worksheet
| ShowWSDialog | Worksheets VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE ShowWSDialog
( dialogType:INTEGER ) ; Python:
return None
def vs.ShowWSDialog(dialogType): 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 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:
return None
def vs.SprdAlign(align): 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:
return None
def vs.SprdBorder(top, left, bot, right): 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:
return None
def vs.SprdFormat(numForm, acc, ldr, trailr): 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
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:
return (row, col)
def vs.SprdSize(h): 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:
return None
def vs.SprdWidth(width): 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:
return None
def vs.TargetSprdSheet(h): 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:
return BOOLEAN
def vs.WorksheetMergeCells(worksheet, topRow, leftColumn, bottomRow, rightColumn): Description:
Merges the specified cells into a single cell.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.
| WorksheetSplitCells | Worksheets VectorWorks12.5 |
VectorScript Declaration:
FUNCTION WorksheetSplitCells
( worksheet :HANDLE; topRow :INTEGER; leftColumn :INTEGER; bottomRow :INTEGER; rightColumn :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.WorksheetSplitCells(worksheet, topRow, leftColumn, bottomRow, rightColumn): 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.