 |
| activecell |
Description: Get or set the current active cell
Syntax: {cell„'} 'obj' Œwi 'activecell' {cell}
cell: a range with a single cell
Example:
'ee' Œwi 'activecell' 'M54'
'ee' Œwi 'activecell' |
|
| backcolor |
Description: Get or Set the background color for the selected range cells
Syntax: 'obj' Œwi 'backcolor'color
color: (256ƒred green blue) [red,green,blue between 0 and 255]
or: (red green blue) |
|
| book |
Description: Activates the specified workbook
Syntax: {result„'} 'obj' Œwi 'book' {book}
rc„'obj' Œwi 'workbook'workbook
book: an existing workbook number or name
result: return code (0=success; 1=failure) when settingthe property
name of active worksheet when getting the property
Example:
'ee' Œwi 'book'
Book1
'ee' Œwi 'book' 'dvd.xls'
'ee' Œwi 'book'
Dvd.xls
Note: setting this property resets the .wkbk and .wksht TExcel5 internal objects |
|
| bookname |
Description: Get the name of the currently active workbook
Syntax: bookname„'obj' Œwi 'book'
bookname: name of currently active workbook
Example:
'ee' Œwi 'bookname'
Book1 |
|
| booknames |
Description: Return the names of the workbooks (read-only property)
Syntax: booknames„'obj' Œwi 'booknames'
Example:
'ee' Œwi 'booknames' |
|
| border |
Description: Set or Reset the border of the current selected range (Write-Only property)
Syntax: 'obj' Œwi 'border'type thickness
type: line type (1 to 5)
thickness: line thickness (1 to 4) |
|
| bordercolor |
Description: Get or Set the cell border color
Syntax: 'obj' Œwi 'bordercolor'color
color: a 3-element vector representing RGB values |
|
| class |
Description: Return current object class
Syntax: class„'obj' Œwi 'class' |
|
| columnwidth |
Description: Get or Set the column width for columns in the specified range
Syntax: {colwidths„'} 'obj' Œwi 'columnwidth' {colwidths}
colwidths: an integer scalar or vector of column width(s) in points
Note: does not work with multiple ranges, except if <colwidths> is a scalar
Example:
'ee' Œwi '*Set' ('range'2'E1') ('columnwidth'12)
'ee' Œwi '*Set' ('range'2'A1:E1') ('columnwidth'12) © same as: ('columnwidth'12 12 12 12 12)
'ee' Œwi '*Set' ('range'2'A1:E1') ('columnwidth'12 3) © same as: ('columnwidth'12 3 12 3 12)
'ee' Œwi '*Set' ('range'2'A1:E1;G1:J1') ('columnwidth'3) © same as: ('columnwidth'3 3 3 3 3 3 3 3 3)
'ee' Œwi '*Set' ('range'2'A1:E1;G1:J1') ('columnwidth'3 4 5 6 7 20 21 22 23) © does not work ok |
|
| columnwidthpix |
Description: Get or Set the column width for columns in the specified range, in pixels
Syntax: {colwidths„'} 'obj' Œwi 'columnwidthpix' {colwidths}
colwidths: an integer scalar or vector of column width(s) in pixels
Note: does not work with multiple ranges, except if <colwidths> is a scalar
Example:
'ee' Œwi '*Set' ('range'2'E1') ('columnwidthpix'12)
'ee' Œwi '*Set' ('range'2'A1:E1') ('columnwidthpix'12) © same as: ('columnwidthpix'12 12 12 12 12)
'ee' Œwi '*Set' ('range'2'A1:E1') ('columnwidthpix'12 3) © same as: ('columnwidthpix'12 3 12 3 12)
'ee' Œwi '*Set' ('range'2'A1:E1;G1:J1') ('columnwidthpix'3) © same as: ('columnwidthpix'3 3 3 3 3 3 3 3 3)
'ee' Œwi '*Set' ('range'2'A1:E1;G1:J1') ('columnwidthpix'3 4 5 6 7 20 21 22 23) © does not work ok |
|
| fontbold |
Description: Get or Set the fontbold property for the selected range
Syntax: {boolean„'} 'obj' Œwi 'fontbold' {boolean}
boolean: 1=make the font bold 0=don't
Example:
'ee' Œwi 'fontbold'255 0 204 |
|
| fontcolor |
Description: Get or Set the Font color for the selected range cells
Syntax: {color„'} 'obj' Œwi 'fontcolor' {color}
color: (256ƒred green blue) [red,green,blue between 0 and 255]
or (red green blue)"
Example:
'ee' Œwi 'fontcolor'255 0 204 |
|
| fontitalic |
Description: Get or Set the fontitalic property for the selected range
Syntax: {boolean„'} 'obj' Œwi 'fontitalic' {boolean}
boolean: 1=make the font italics 0=don't
Example:
'ee' Œwi 'fontitalic'1 |
|
| fontname |
Description: Get or Set the font for the selected range
Syntax: {name„'} 'obj' Œwi 'fontname' {name}
name: a character string (the font name)
Example:
'ee' Œwi 'fontname' 'Arial' |
|
| fontsize |
Description: Get or Set the font size for the selected range
Syntax: {size„'} 'obj' Œwi 'fontsize' {size}
size: an integer (the font size)
Example:
'ee' Œwi 'fontsize'14 |
|
| fontunderline |
Description: Get or Set the FontUnderline property for the selected range
Syntax: {value„'} 'obj' Œwi 'fontunderline'value
value: ¯4142=xlUnderlineStyleNone
2=xlUnderlineStyleSingle
¯4119=xlUnderlineStyleDouble
4=xlUnderlineStyleSingleAccounting
5=xlUnderlineStyleDoubleAccounting
Example:
'ee' Œwi 'fontunderline'2 |
|
| format |
Description: Set the number format for all number in the current selected range
Syntax: {formatstring„'} 'obj' Œwi 'format' {formatstring}
formatstring: a valid Excel number format string (see Custom in Format/Cells dialog)
Note: number formats are sensible to the International settings of your computer
Example:
'ee' Œwi 'Format' '$#,###.00' |
|
| formula |
Description: Applies the specified formula to the selected range
Syntax: 'obj' Œwi 'formula'sheet range formula
sheet: a sheet number or name or 0 or '' to specify active worksheet
range: a range of cells in A1:F8 notation or '' to specify the current range
formula: a valid Excel formula or formulae array
Examples:
'ee' Œwi 'formula'2 'C4' '=C2+C3'
'ee' Œwi 'formula'2 'C4'
=C2+C3
'ee' Œwi 'formula'2 'C4:E5' '=C2+C3'
'ee' Œwi 'formula'2 'C4:E5'
=C2+C3 =D2+D3 =E2+E3
=C3+C4 =D3+D4 =E3+E4
Note that you can also pass an array of formulae as in the next example:
'ee' Œwi 'formula'2 'C4:E5' (2 3½'=C2+C3' '=C2+D2' '=D2+E2')
'ee' Œwi 'formula'2 'C4:E5'
=C2+C3 =D2+E2 =F2+G2
=C3+C4 =D3+E3 =F3+G3
This way you can set different formulae for each cell in just one APL
instruction, but be careful about the cell translations made by Excel! |
|
| gridlines |
Description: Get or Set grid lines for the specified range
Syntax: 'obj' Œwi 'gridlines'gridlines{gridlinecolor}
gridlines: a boolean scalar
gridlinecolor: a color (specified as 256ƒR G B)
Example:
'ee' Œwi 'gridlines'0 © remove grid lines for printing
'ee' Œwi 'gridlines'1 |
|
| halign |
Description: Get or Set horizontal alignment for the selected range
Syntax: 'obj' Œwi 'halign'halign
halign: 'right' 'left' 'justify' 'center' 'general' 'fill' or 'centeracross'
Example:
'ee' Œwi '*Set' ('range'1'A4:D8') ('halign' 'right') |
|
| help |
Example:
0 0½'ff' Œwi '*Create' 'TForm5' ('*caption' 'TOWCSpread5 Demo') ('*size'300 400)
0 0½'ff' Œwi '*.owc.Create' 'TOWCSpread5' ('wherelc'0 0'>>' '>>') ('attach'1 2 3 4)
0 0½'ff' Œwi '.owc.Add'1(1 1) (10 10½'APL'1 2 3 'is' 3.14158 'the' 'best' 'language'10)
0 0½'ff' Œwi '.owc.range'1'B3:D8'
0 0½'ff' Œwi '.owc.backcolor' (256 152 256)
0 0½'ff' Œwi '.owc.border'1 3
0 0½'ff' Œwi '.owc.bordercolor'255
'ff' Œwi '.owc.Get'
'ff' Œwi '.owc.GetNum'
0 0½'ff' Œwi '.owc.range'1'B3:D8'
0 0½'ff' Œwi '.owc.value' (2 2½100 200 300 400)
0 0½'ff' Œwi '.owc.range'1'C6:D7'
0 0½'ff' Œwi '.owc.value' (2 2½'APL.Net' 'is' 'coming' 'soon!')
0 0½'ff' Œwi '.owc.backcolor' (255 112 112)
0 0½'ff' Œwi '.owc.border'1 4
'ff' Œwi '.owc.GetNum'1'B3:D8'
0 0½'ff' Œwi '.owc.fontbold'1
0 0½'ff' Œwi '.owc.fontitalic'1
0 0½'ff' Œwi '.owc.fontname' 'Verdana'
0 0½'ff' Œwi '.owc.fontsize'18
0 0½'ff' Œwi '.owc.AutoFit'1
0 0½'ff' Œwi 'DemoShow'
0 0½'ff' Œwi '*size'350 580
Œwself„'ff.owc' |
|
| language |
Description: Return the Excel language LCIDs (Read-only) for Install, GUI and Help
Syntax: countryID„'obj' Œwi 'language'
countryID: [1]=the install language
[2]=the user interface language
[3]=the Help language
(1033=USA, 1036=France, 1053=Sweden, ...)
Example:
'ee' Œwi 'language'
1033 1033 1033 © ELE10aug05 33…1033 1033 1033
Note: the complete list of International LCID can be found at:
http://krafft.com/scripts/deluxe-calendar/lcid_chart.htm |
|
| lastcell |
Description: Return the last used cell coordinates in RC format in the specified sheet (read-only)
Syntax: lastrowcol„'obj' Œwi 'lastcell' {sheet}
sheet: a sheet number or name
If <sheet> is not specified, returns last column in Active Sheet
Example:
'ee' Œwi 'lastcell'3 © return (row,col) of last cell in sheet 3
5 4 |
|
| lastcol |
Description: Return the last used column number in the specified sheet (read-only)
Syntax: lastcol„'obj' Œwi 'lastcol' {sheet}
sheet: a sheet number or name
Note: If <sheet> is not specified, returns last column in Active Sheet
Example:
'ee' Œwi 'lastcol'1 © returns last column in sheet 1
4 |
|
| lastrow |
Description: Return the Last used row number in the sheet (read-only)
Syntax: lastrow„'obj' Œwi 'lastrow' {sheet}
sheet: a sheet number or name
If <sheet> is not specified, returns last row in Active Sheet
Example:
'ee' Œwi 'lastrow'2 © return last row in sheet 2 |
|
| listseparator |
Description: Returns the List Separator to be used in specifying for example multiple ranges
Syntax: listseparator„'obj' Œwi 'listseparator'
listseparator: the character which serves as a list separator for Excel (; or ,)
Example:
'ee' Œwi 'listseparator' |
|
| loaddelim |
Description: If reading a text file, use this to specify the delimiter
Syntax: 'obj' Œwi 'loaddelim' {delim}
delim: desired delimiter (allowed values: Œtcht ',' ' ' ';')
Example:
'obj' Œwi 'loaddelim' ',' |
|
| name |
Description: Get or Set a name for the current range object
Syntax: {name„'} 'obj' Œwi 'Name' {name}
name: a character string (the range name)
Example:
'ee' Œwi 'name' 'Product1' |
|
| names |
Description: Returns the names of all named cells in the active workbook
Syntax: names„'obj' Œwi 'names'
names: a vector of character vectors (the cell names) |
|
| ontop |
Description: Get or Set the ontop property specifying if Excel must stay on top of all other windows or not
Syntax: {boolean„'} 'obj' Œwi 'ontop' {boolean}
boolean: 1=Excel is made topmost; 0=it is not
Example:
'ee' Œwi 'ontop'1 |
|
| range |
Description: Get or Create a range of cells in the current sheet
Syntax: {sheetrange„'} 'obj' Œwi 'range' {sheet range}
sheet: a sheet number or sheet name or 0 or Ð for active sheet
range: a range of cells specified as for example: 'A3:B12'
or a range of cells specified as (startrow startcol nbrows nbcols)
sheetrange: a 2-element vector: (sheet number) (range)
Example:
'ee' Œwi 'range'2'A3:B12'
'ee' Œwi 'range'1 3 1 2 12
'ee' Œwi 'range'1(3 1 2 12) |
|
| rangename |
Description: Get or Set a name for a given range in a given sheet
Syntax: {name„'} 'obj' Œwi 'rangename'sheet range{name}
sheet: a sheet number or name or '' for the current sheet
range: a range of cells specified as for example: 'A3:B12'
or a range of cells specified as (startrow startcol nbrows nbcols)
name: a character string (the range name)
Example:
'ee' Œwi 'rangename'1'A3:B6' 'test' © set a name for range Q3:B6 in sheet 1 |
|
| rowheight |
Description: Get or Set the row height for the specified range rows
Syntax: {rowheights„'} 'obj' Œwi 'rowheight' {rowheights}
rowheights: an integer scalar or vector of row height(s) in points
Example:
'ee' Œwi '*Set' ('range'2'E1') ('rowheight'12)
'ee' Œwi '*Set' ('range'2'A1:A5') ('rowheight'12) © same as: ('rowheight'12 12 12 12 12)
'ee' Œwi '*Set' ('range'2'A1:A5') ('rowheight'12 3) © same as: ('rowheight'12 3 12 3 12) |
|
| rowheightpix |
Description: Get or Set the row height for the specified range rows in pixels
Syntax: {rowheights„'} 'obj' Œwi 'rowheightpix' {rowheights}
rowheights: an integer scalar or vector of row height(s) in pixels
Example:
'ee' Œwi '*Set' ('range'2'E1') ('rowheightpix'12)
'ee' Œwi '*Set' ('range'2'A1:A5') ('rowheightpix'12) © same as: ('rowheightpix'12 12 12 12 12)
'ee' Œwi '*Set' ('range'2'A1:A5') ('rowheightpix'12 3) © same as: ('rowheightpix'12 3 12 3 12) |
|
| screenupdating |
Description: Get or set the ability to redraw the Excel sheet
Syntax: {boolean„'} 'obj' Œwi 'screenupdating' {boolean}
boolean: 1=Excel sheet is updated at each change 0=it is not
Note: use 'screenupdating'0 before a set of changes to the Excel
sheet to significantly speed up the process. Don't forget
to reset screenupdating to 1 at then end or no changes
will occur to the sheet
Example:
'ee' Œwi 'screenupdating'0 |
|
| sheet |
Description: Activate the specified worksheet in the current workbook
Syntax: {result„'} 'obj' Œwi 'sheet'sheet
sheet: worksheet number or name to activate in current workbook
result: return code (0=success; 1=failure) when setting the property
number of active worksheet when getting the property
Note: setting this property resets the .wksht and .pgsetup TExcel5 internal objects
Example:
'ee' Œwi 'sheet'2
or:
'ee' Œwi 'sheet' 'Sheet2' |
|
| sheetname |
Description: Get or Set the active worksheet name
Syntax: {sheetname„'} 'obj' Œwi 'sheetname' {sheetname}
sheetname: a character string (the future active worksheet name}
Example:
'ee' Œwi 'sheetname'
Sheet1
'ee' Œwi 'sheetname' 'Feuille1' |
|
| sheetnames |
Description: Get all current Excel sheet names (read-only)
Syntax: res„'obj' Œwi 'sheetnames'
sheetnames: a nested vector of character vectors
Example:
'ee' Œwi 'sheetnames' |
|
| sscolumns |
Description: Returns all Excel column names as a nested vector
Syntax: colnames„'obj' Œwi 'sscolumns'
colnames: a nested vector of the 256 Excel column names
Example:
'ee' Œwi 'sscolumns' |
|
| valign |
Description: Get or Set vertical alignment for the selected range
Syntax: {valign„'} 'obj' Œwi 'valign' {valign}
valign: 'top' 'center' 'bottom' 'general' 'fill' or 'centeracross'
Example:
'ee' Œwi '*Set' ('range'1'A4:D4') ('valign' 'centeracross') |
|
| value |
Description: Get or Set the value for the currently active range
Syntax: {values„'} 'obj' Œwi 'Value' {values}
values: a scalar, vector or matrix of APL values
Example:
'ee' Œwi 'value' © return values from the current range
'ee' Œwi 'value' (4 5½¼100) © set values in the current range |
|
| version |
Description: Get the current Excel version number (including Build) (read-only property)
Syntax: version„'obj' Œwi 'version'
version: the current Excel version number
Example:
'ee' Œwi 'version' |
|
| visibletoolbar |
Description: Show or Hide a given Excel toolbar
Syntax: {boolean}„'obj' Œwi 'visibletoolbar'boolean
boolean: 1=show Excel Toolbar 0=hide it
Example:
'ee' Œwi 'visibletoolbar'0 © hides OWC Spreadsheet toolbar |
TOWCSpread5 
