ActSSheet Worksheets 

Declaration:

FUNCTION   ActSSheet
:HANDLE ;

Special Notes:

ActSSheet is obsolete as of VectorWorks9.0

Description:

Function ActSSheet returns the handle to the currently active worksheet.



  AutoFitWSRowHeights Worksheets 

Declaration:

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

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 

Declaration:

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

Special Notes:

CellHasNum is obsolete as of VectorWorks9.0

Description:

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

Parameters:

h Handle to worksheet.
row Worksheet row index.
col Worksheet column index.



  CellHasStr Worksheets 

Declaration:

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

Special Notes:

CellHasStr is obsolete as of VectorWorks9.0

Description:

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

Parameters:

h Handle to worksheet.
row Worksheet row index.
col Worksheet column index.



  CellString Worksheets 

Declaration:

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

Special Notes:

CellString is obsolete as of VectorWorks9.0

Description:

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

Parameters:

row Worksheet row index.
column Worksheet column index.



  CellValue Worksheets 

Declaration:

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

Special Notes:

CellValue is obsolete as of VectorWorks9.0

Description:

Function CellValue returns the numeric value of a specifed 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 

Declaration:

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

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 

Declaration:

PROCEDURE   CloseSS
( h:HANDLE ) ;

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 

Declaration:

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

Description:

Creates a new worksheet in a Vectorworks document.

Parameters:

name The name of the worksheet.
rows The number of rows in the worksheet.
columns The number of columns in the worksheet.

Result:

Returns a HANDLE to the new worksheet.



  CreateWSImage Worksheets 

Declaration:

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

Description:

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

Parameters:

worksheet Handle to worksheet.
location X-Y coordinate location of image object.



  DeleteWSColumns Worksheets 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

Special Notes:

GetCAlign is obsolete as of VectorWorks9.0

Description:

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

Table - Worksheet Cell Alignment

Alignment Constant
General 1
Left 2
Right 3
Center 4

Parameters:

h Handle to worksheet.
row Worksheet row index.
col Worksheet column index.

Example:

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



  GetCellNum Worksheets 

Declaration:

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

Special Notes:

GetCellNum is obsolete as of VectorWorks9.0

Description:

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

Parameters:

h Handle to worksheet.
row Worksheet row index.
col Worksheet column index.



  GetCellStr Worksheets 

Declaration:

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

Special Notes:

GetCellStr is obsolete as of VectorWorks9.0

Description:

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

Parameters:

h Handle to worksheet.
row Worksheet row index.
col Worksheet column index.



  GetCWidth Worksheets 

Declaration:

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

Special Notes:

GetCWidth is obsolete as of VectorWorks9.0

Description:

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

Parameters:

h Handle to worksheet.
row Worksheet row index.
col Worksheet column index.



  GetSprdSortSum Worksheets 

Declaration:

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

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 

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

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 

Declaration:

FUNCTION   GetTopVisibleWS
:HANDLE ;

Description:

Returns a handle to topmost visible worksheet.

Result:

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



  GetWSAutoRecalcState Worksheets 

Declaration:

FUNCTION   GetWSAutoRecalcState
( worksheet:HANDLE ) :BOOLEAN ;

Description:

Gets the AutoRecalc state for the specified worksheet.

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

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

Description:

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

Parameters:

worksheet Handle to worksheet
row Row of cell to be queried
column Column of cell to be queried
style Cell fill style constant
bgcolor Cell background color index
fgcolor Cell foreground color index
fillpattern Cell pattern index



  GetWSCellFormula Worksheets 

Declaration:

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

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.



  GetWSCellNumberFormat Worksheets 

Declaration:

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

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 

Declaration:

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

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.



  GetWSCellTextAngle Worksheets 

Declaration:

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

Description:

Returns the text angle of a cell in the referenced worksheet

Parameters:

worksheet Handle to worksheet
row Row of cell to be queried
column Column of cell to be queried
angle Text angle



  GetWSCellTextColor Worksheets 

Declaration:

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

Description:

Returns the text color of a cell in the referenced worksheet

Parameters:

worksheet Handle to worksheet
row Row of cell to be queried
column Column of cell to be queried
color Text color index value



  GetWSCellTextFormat Worksheets 

Declaration:

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

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

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

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.



  GetWSColumnWidth Worksheets 

Declaration:

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

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 

Declaration:

FUNCTION   GetWSFromImage
( worksheetImage:HANDLE ) :HANDLE ;

Description:

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

Parameters:

worksheetImage Handle to worksheet image object.



  GetWSImage Worksheets 

Declaration:

FUNCTION   GetWSImage
( worksheet:HANDLE ) :HANDLE ;

Description:

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

Parameters:

worksheet Handle to worksheet.

Result:

Returns a HANDLE of the worksheet image object.



  GetWSMergedCellRange Worksheets 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

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

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 

Declaration:

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

Description:

Returns the actual string in a database subrow cell.



  GetWSSubrowCellString Worksheets 

Declaration:

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

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.



  GetWSSubrowCellValue Worksheets 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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.



  InsertWSColumns Worksheets 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

Description:

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

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 

Declaration:

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

Description:

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

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 

Declaration:

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

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.



  IsWSSubrowCellNumber Worksheets 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

FUNCTION   IsWSVisible
( worksheet:HANDLE ) :BOOLEAN ;

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 

Declaration:

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

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 }



  NewSprdSheet Worksheets 

Declaration:

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

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 

Declaration:

PROCEDURE   RecalculateWS
( worksheet:HANDLE ) ;

Description:

Recalculates all formulas for the referenced worksheet.

Parameters:

worksheet Handle to worksheet.



  SelectSS Worksheets 

Declaration:

PROCEDURE   SelectSS
( h:HANDLE ) ;

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

PROCEDURE   SetTopVisibleWS
( worksheet:HANDLE ) ;

Description:

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

Parameters:

worksheet Handle to worksheet.



  SetWSAutoRecalcState Worksheets 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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  



  SetWSCellInsideHorizBorder Worksheets 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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

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 

Declaration:

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

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 

Declaration:

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

Description:

Sets the vertical alignment of cells in the referenced worksheet.

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

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

Parameters:

worksheet Handle to worksheet
topRow Top row of cell range
leftColumn Left column of cell range
bottomRow Bottom row of cell range
rightColumn Right column of cell range
vAlignment Vertical alignment index value to be set



  SetWSCellWrapTextFlag Worksheets 

Declaration:

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

Description:

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

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

Parameters:

worksheet Handle to worksheet
topRow Top row of cell range
leftColumn Left column of cell range
bottomRow Bottom row of cell range
rightColumn Right column of cell range
wrapTextFlag Wrap text flag to be set



  SetWSColumnOperators Worksheets 

Declaration:

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

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.



  SetWSColumnWidth Worksheets 

Declaration:

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

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 

Declaration:

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

Description:

Sets the active cell of the referenced worksheet.

Parameters:

worksheet Handle to worksheet.
currentCellRow Row of active cell.
currentCellColumn Column of active cell.



  SetWSPlacement Worksheets 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

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 

Declaration:

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

Description:

Sets the display status of the referenced worksheet.

Parameters:

worksheet Handle to worksheet.
show Desired display status of worksheet



  ShowWSDialog Worksheets 

Declaration:

PROCEDURE   ShowWSDialog
( dialogType:INTEGER ) ;

Description:

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

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

Table - Worksheet Dialog Selectors

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

Parameters:

dialogType Index of dialog to be displayed.



  SprdAlign Worksheets 

Declaration:

PROCEDURE   SprdAlign
( align:INTEGER ) ;

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 

Declaration:

PROCEDURE   SprdBorder
(   top :BOOLEAN;
    left :BOOLEAN;
    bot :BOOLEAN;
    right :BOOLEAN
) ;

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 

Declaration:

PROCEDURE   SprdFormat
(   numForm :INTEGER;
    acc :INTEGER;
    ldr :STRING;
    trailr :STRING
) ;

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 

Declaration:

PROCEDURE   SprdSize
(   h :HANDLE;
  VAR  row :INTEGER;
  VAR  col :INTEGER
) ;

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 

Declaration:

PROCEDURE   SprdWidth
( width:REAL ) ;

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 

Declaration:

PROCEDURE   TargetSprdSheet
( h:HANDLE ) ;

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 

Declaration:

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

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 

Declaration:

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

Description:

Splits the specified cells back into individual cells.

Parameters:

worksheet Worksheet on which function is to operate.
topRow Top row of range to split.
leftColumn Left column of range to split.
bottomRow Bottom row of range to split.
rightColumn Right column of range to split.

Result:

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