next up previous contents index
Next: D.2 Utility classes Up: D. Tcl API Previous: D. Tcl API   Contents   Index

Subsections

D.1 Constants

D.1.1 File types

The following file formats are supported when saving a Workbook. SpreadScript automatically determines the appropriate type when reading a file. Microsoft Excel 95/97/2000/XP formats are supported when reading a file. SpreadScript currently supports writing Microsoft Excel 95 format.

$SS_NEXS_XS3 = SS_NEXS_XS3

NExS XS3 format

$SS_EXCEL_95 = SS_EXCEL_95

Microsoft Excel 95 format

D.1.2 Cell types

The following are returned when requesting a cell's type.

$SS_EMPTY_CELL = SS_EMPTY_CELL

Cell has no contents

$SS_OVERFLOW_CELL = SS_OVERFLOW_CELL

Cell has no contents but an adjacent cell spills over into it

$SS_NUMERIC_CELL = SS_NUMERIC_CELL

Cell contains a number

$SS_TEXT_CELL = SS_TEXT_CELL

Cell contains a text string

$SS_FORMULA_CELL = SS_FORMULA_CELL

Cell contains a formula

$SS_CHART_CELL = SS_CHART_CELL

Cell contains a chart

D.1.3 Font names

The following are the supported fonts.

$SS_FONT_FAMILY_DEFAULT = SS_FONT_FAMILY_DEFAULT

Default font

$SS_FONT_FAMILY_COURIER = SS_FONT_FAMILY_COURIER

Courier

$SS_FONT_FAMILY_TIMESROMAN = SS_FONT_FAMILY_TIMESROMAN

Times Roman

$SS_FONT_FAMILY_HELVETICA = SS_FONT_FAMILY_HELVETICA

Helvetica/Arial

$SS_FONT_FAMILY_SOUVENIR = SS_FONT_FAMILY_SOUVENIR

Souvenir

$SS_FONT_FAMILY_LUBALIN = SS_FONT_FAMILY_LUBALIN

Lubalin

D.1.4 Font sizes

The following are the supported font sizes.

$SS_FONT_SIZE_DEFAULT = SS_FONT_SIZE_DEFAULT

Default font size

$SS_FONT_SIZE_8PT = SS_FONT_SIZE_8PT

8 point

$SS_FONT_SIZE_10PT = SS_FONT_SIZE_10PT

10 point

$SS_FONT_SIZE_12PT = SS_FONT_SIZE_12PT

12 point

$SS_FONT_SIZE_14PT = SS_FONT_SIZE_14PT

14 point

$SS_FONT_SIZE_18PT = SS_FONT_SIZE_18PT

18 point

$SS_FONT_SIZE_24PT = SS_FONT_SIZE_24PT

24 point

$SS_FONT_SIZE_36PT = SS_FONT_SIZE_36PT

36 point

D.1.5 Font styles

The following are the supported font styles. Underlining is separate.

$SS_FONT_STYLE_DEFAULT = SS_FONT_STYLE_DEFAULT

Default font style

$SS_FONT_STYLE_NORMAL = SS_FONT_STYLE_NORMAL

Normal (plain)

$SS_FONT_STYLE_BOLD = SS_FONT_STYLE_BOLD

Bold

$SS_FONT_STYLE_ITALIC = SS_FONT_STYLE_ITALIC

Italic

$SS_FONT_STYLE_BOLDITALIC = SS_FONT_STYLE_BOLDITALIC

Bold and Italic

D.1.6 Horizontal justification

The following are the supported horizontal justifications.

$SS_HJUST_DEFAULT = SS_HJUST_DEFAULT

Default horizontal justification

$SS_HJUST_LEFT = SS_HJUST_LEFT

Left justified

$SS_HJUST_RIGHT = SS_HJUST_RIGHT

Right justified

$SS_HJUST_CENTER = SS_HJUST_CENTER

Centered

$SS_HJUST_AUTO = SS_HJUST_AUTO

Auto justification

D.1.7 Word wrapping

The following are the supported word wrappings.

$SS_WRAP_DEFAULT = SS_WRAP_DEFAULT

Default word wrapping

$SS_WRAP_OFF = SS_WRAP_OFF

Word wrapping off

$SS_WRAP_ON = SS_WRAP_ON

Word wrapping on

D.1.8 Underlining

The following are the supported underlinings. Font styles are separate.

$SS_UNDERLINE_DEFAULT = SS_UNDERLINE_DEFAULT

Default underlining

$SS_UNDERLINE_OFF = SS_UNDERLINE_OFF

Underlining off

$SS_UNDERLINE_ON = SS_UNDERLINE_ON

Underlining on

D.1.9 Border styles

The following are the supported border styles. The styles match the Microsoft Excel 95 (subset of Excel 97) style list.

$SS_BORDER_NONE = SS_BORDER_NONE

No border

$SS_BORDER_THIN = SS_BORDER_THIN

Thin line border

$SS_BORDER_MEDIUM = SS_BORDER_MEDIUM

Medium line border

$SS_BORDER_DASHED = SS_BORDER_DASHED

Dashed line border

$SS_BORDER_DOTTED = SS_BORDER_DOTTED

Dotted line border

$SS_BORDER_THICK = SS_BORDER_THICK

Thick line border

$SS_BORDER_DOUBLE = SS_BORDER_DOUBLE

Double line border

$SS_BORDER_HAIR = SS_BORDER_HAIR

Hair line border

D.1.10 Cell formats

The following are the supported cell format styles. (See Tables 3.2 and 3.3 for descriptions.)

$SS_FMT_DEFAULT = SS_FMT_DEFAULT

Default format

$SS_FMT_FLOAT = SS_FMT_FLOAT

Floating point format

$SS_FMT_FIXED = SS_FMT_FIXED

Fixed point format

$SS_FMT_GEN = SS_FMT_GEN

General format

$SS_FMT_DOLLARS = SS_FMT_DOLLARS

Dollar format

$SS_FMT_COMMA = SS_FMT_COMMA

Comma format

$SS_FMT_HEX = SS_FMT_HEX

Hexadecimal format

$SS_FMT_LOGIC = SS_FMT_LOGIC

Logical format

$SS_FMT_DAY_MONTH_YEAR = SS_FMT_DAY_MONTH_YEAR

Date format: DD-MMM-YY

$SS_FMT_DAY_MONTH = SS_FMT_DAY_MONTH

Date format: DD-MMM

$SS_FMT_MONTH_YEAR = SS_FMT_MONTH_YEAR

Date format: MMM-YY

$SS_FMT_DATE = SS_FMT_DATE

Date format: MM/DD/YY

$SS_FMT_HIDDEN = SS_FMT_HIDDEN

Hidden

$SS_FMT_TIME = SS_FMT_TIME

Time format: HH:MM:SS

$SS_FMT_PERCENT = SS_FMT_PERCENT

Percent format

$SS_FMT_TEXT = SS_FMT_TEXT

Text format

$SS_FMT_INTL_DATE = SS_FMT_INTL_DATE

International date: DD.MM.YYYY

$SS_FMT_ISO8061_DATE = SS_FMT_ISO8061_DATE

ISO-8061 date: YYYY-MM-DD

$SS_FMT_DATE_ALT = SS_FMT_DATE_ALT

Alternate date: DD/MM/YY

D.1.11 Copy options

The following are the supported copy options used to specify what style properties of a cell are to be copied.

$SS_COPY_NONE = SS_COPY_NONE

Don't copy style properties

$SS_COPY_FORMAT = SS_COPY_FORMAT

Copy format property

$SS_COPY_FONT = SS_COPY_FONT

Copy font properties

$SS_COPY_COLOR = SS_COPY_COLOR

Copy color properties

$SS_COPY_JUST = SS_COPY_JUST

Copy justification property

$SS_COPY_ALL = SS_COPY_ALL

Copy all

D.1.12 Goal seek result codes

The following are the possible result code from a goal seek. For more information, see Worksheet.performGoalSeek().

$SS_GS_SUCCESS = SS_GS_SUCCESS

Goal seek completed successfully

$SS_GS_FP_ERR = SS_GS_FP_ERR

Floating point error

$SS_GS_BAD_TARGET = SS_GS_BAD_TARGET

Target cell is not numerical

$SS_GS_BRKT_LIMIT = SS_GS_BRKT_LIMIT

Bracket not found within iteration limit

$SS_GS_ITER_LIMIT = SS_GS_ITER_LIMIT

Solution bracketed, but a solution was not found within the iteration limit

$SS_GS_TARGET_NOT_FORMULA = SS_GS_TARGET_NOT_FORMULA

Target cell does not contain a formula

$SS_GS_VAR_NOT_NUMBER = SS_GS_VAR_NOT_NUMBER

Variable cell does not contain a number

D.1.13 Sort direction

The following are the possible sorting directions.

$SS_SORT_DESCENDING = SS_SORT_DESCENDING

Sort items in descending order

$SS_SORT_ASCENDING = SS_SORT_ASCENDING

Sort items in ascending order

D.1.14 Month and day order

The following are used to specify the month and day order when importing CSV or TSV data. For more information, see Range.importCSV() or Range.importTSV().

$SS_MONTH_THEN_DAY = SS_MONTH_THEN_DAY

US-style month/day/year

$SS_DAY_THEN_MONTH = SS_DAY_THEN_MONTH

European-style day/month/year


next up previous contents index
Next: D.2 Utility classes Up: D. Tcl API Previous: D. Tcl API   Contents   Index
SpreadScript User's Guide, Version 1.2
Grey Trout Software
02 March 2003