ActSSheet Worksheets 

Declaration:

FUNCTION   ActSSheet
:HANDLE ;

Description:

Function ActSSheet returns the handle to the currently active worksheet.



  CellHasNum Worksheets 

Declaration:

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

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 ;

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.

Example:





  CellString Worksheets 

Declaration:

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

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 ;

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.



  CloseSS Worksheets 

Declaration:

PROCEDURE   CloseSS
( h:HANDLE ) ;

Description:

Procedure CloseSS closes the referenced worksheet.

Parameters:

h Handle to worksheet.

Example:

CloseSS(HandleToWS);



  GetCAlign Worksheets 

Declaration:

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

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 ;

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.

Example:





  GetCellStr Worksheets 

Declaration:

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

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 ;

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

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.



  LoadCell Worksheets 

Declaration:

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

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

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



  SelectSS Worksheets 

Declaration:

PROCEDURE   SelectSS
( h:HANDLE ) ;

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

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.



  SprdAlign Worksheets 

Declaration:

PROCEDURE   SprdAlign
( align:INTEGER ) ;

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

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

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



  SprdSheet Worksheets 

Declaration:

PROCEDURE   SprdSheet
(   pX :REAL;
    pY :REAL;
    row :INTEGER;
    col :INTEGER
) ;

Special Notes:

SprdSheet is obsolete as of VectorWorks 8.0

Description:

Obsolete procedure.

Parameters:

p Insertion point coordinates of worksheet.
row Number of rows in worksheet.
col Number of columns in worksheet.

See Also:

NewSprdSheet  



  SprdSize Worksheets 

Declaration:

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

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

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

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.