Skip to content

GetSprdSortSumColumns.md

Latest commit

 

History

History
60 lines (49 loc) · 1.88 KB

GetSprdSortSumColumns.md

File metadata and controls

60 lines (49 loc) · 1.88 KB
Raw

GetSprdSortSumColumns

Description

Returns the sorting and summation options for a database row.

PROCEDURE GetSprdSortSumColumns(
				sheetHd      : HANDLE;
				row          : INTEGER;
				VAR sortCol1 : INTEGER;
				VAR sortCol2 : INTEGER;
				VAR sortCol3 : INTEGER;
				VAR sumCol1  : INTEGER;
				VAR sumCol2  : INTEGER;
				VAR sumCol3  : INTEGER);
def vs.GetSprdSortSumColumns(sheetHd, row):
    return (sortCol1, sortCol2, sortCol3, sumCol1, sumCol2, sumCol3)

Parameters

Name Type Description
sheetHd HANDLE Handle to worksheet.
row INTEGER Database row to be queried.
sortCol1 INTEGER Primary sort column.
sortCol2 INTEGER Secondary sort column.
sortCol3 INTEGER Tertiary sort column.
sumCol1 INTEGER Primary summation column.
sumCol2 INTEGER Secondary summation column.
sumCol3 INTEGER Tertiary summation column.

Remarks

Gets sorting for a database row. The sortCol1, sortCol2, and sortCol3 values specify the primary, secondary and tertiary sorts for the database row. For descending sorts, a positive column is returned; for ascending sorts, a negative column is returned For no sort, 0 is returned. Sum works the same way. OBSOLETE for Version 9: see new GetWSColumnOperators. [VML 01/09/01]

Examples

GetSprdSortSumColumns(sheetHd, 1, 2, 3, 10, 5, 1, 2);
import vs

# Returns the sorting and summation options for a database row.
sheetHd = vs.FSActLayer()  # handle to the first selected object on the active layer
row = 10

sortCol1, sortCol2, sortCol3, sumCol1, sumCol2, sumCol3 = vs.GetSprdSortSumColumns(sheetHd, row)
vs.Message('GetSprdSortSumColumns returned: ' + str((sortCol1, sortCol2, sortCol3, sumCol1, sumCol2, sumCol3)))

Version

GetSprdSortSumColumns is obsolete as of VectorWorks9.0

Availability: from VectorWorks8.5

Category