 |
| 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)
Note: Use 'obj' Œwi 'border'0 © to remove border |
| bordercolor |
Description: Get or Set the cell border color
Syntax: 'obj' Œwi 'bordercolor'color
color: a 3-element vector representing RGB values |
| bottommargin |
Description: Get or Set the print bottom margin
Syntax: 'obj' Œwi 'bottommargin'bottommargin
bottommargin: an integer scalar (the bottommargin in centimeters)
Note: To specify a margin in inches use:
'ee' Œwi 'bottommargin' ('ee' Œwi 'InchesToCentimeters'3)
where 3 represents inches |
| centerfooter |
Description: Get or Set the print centered footer text
Syntax: 'obj' Œwi 'centerfooter'centerfooter
centerfooter: a character string
See possible codes in <leftfooter> property documentation
Example:
'ff' Œwi 'centerfooter' '&08 &""Verdana"" &N &J &H Page &P/&T' |
| centerheader |
Description: Get or Set the print centered header text
Syntax: 'obj' Œwi 'centerheader'centerheader
centerheader: a character string
See possible codes in <leftfooter> property documentation
Example:
'ff' Œwi 'centerheader' '&08 &""Verdana"" &N &J &H Page &P/&T' |
|
| chartarea |
Description: Sets or gets the location where the chart should be displayed
Syntax: {bool„'} 'obj' Œwi 'chartarea'top left height width
top, left, height, width: distances expressed in pixels
Example:
'ee' Œwi 'charthaslegend'1 |
|
| charthaslegend |
Description: Sets or gets the fact the Chart has a Legend or not
Syntax: {bool„'} 'obj' Œwi 'chartlegend' {bool}
bool: a boolean value indicating if the chart should have a legend or not
Example:
'ee' Œwi 'charthaslegend'1 |
|
| chartlabels |
Description: Sets or gets the type of labels to display on the Chart (write only)
Syntax: {type„'} 'obj' Œwi 'chartlabels' {type}
type: a value (character or numeric), one of
None or ¯4142
Value or 2
Percent or 3
Label or 4
LabelAndPercent or 5
BubbleSizes or 6
Example:
'ee' Œwi 'chartlabels'3 |
|
| chartrounded |
Description: Sets or gets the Chart rounded corners property
Syntax: {bool„'} 'obj' Œwi 'chartrounded' {shadow}
shadow: a boolean value indicating if the chart should use rounded corners or not
Example:
'ee' Œwi 'chartrounded'1 |
|
| chartshadow |
Description: Sets or gets the Chart shadow property
Syntax: {bool„'} 'obj' Œwi 'chartsource' {shadow}
shadow: a boolean value indicating if a shadow should be used with the graph
Example:
'ee' Œwi 'chartshadow'1 |
|
| chartsource |
Description: Sets or gets the Chart data source
Syntax: {source„'} 'obj' Œwi 'chartsource' {source}
source: a range of cells where the first column contains the labels
and subsequent columns the various data
Example:
'ee' Œwi 'chartsource' 'A3:B6' |
|
| charttitle |
Description: Sets or gets the Chart title
Syntax: {title„'} 'obj' Œwi 'charttitle' {title}
title: a character string representing the chart title
Note: once the <charttitle> property has been set you may use
the following additional propertie to enhance the title:
'ee' Œwi '*:chart.title.xShadow'1
'ee' Œwi '*:chart.title.xBorder'1
'ee' Œwi '*:chart.title.xInterior.xColor' (256ƒ255 192 192)
'ee' Œwi '*:chart.title.xOrientation'45
'ee' Œwi '*:chart.title.xOrientation'90
'ee' Œwi '*:chart.title.xOrientation'0
'ee' Œwi '*:chart.title.xTop'0
'ee' Œwi '*:chart.title.xLeft'0
'ee' Œwi '*:chart.title.xFont.xBold' 0
'ee' Œwi '*:chart.title.xFont.xBold' 1
Example:
'ee' Œwi 'charttitle' 'APL Sales' |
|
| charttype |
Description: Gets or Sets the Chart type
Syntax: {type„'} 'obj' Œwi 'charttype' {type}
type: a chart type, any one of the following types
(use either the name as in 'ColumnStacked' or the corresponding value as in 52)
ColumnClustered: 51
ColumnStacked: 52
ColumnStacked100: 53
3DColumnClustered: 54
3DColumnStacked: 55
3DColumnStacked100: 56
BarClustered: 57
BarStacked: 58
BarStacked100: 59
3DBarClustered: 60
3DBarStacked: 61
3DBarStacked100: 62
LineStacked: 63
LineStacked100: 64
LineMarkers: 65
LineMarkersStacked: 66
LineMarkersStacked100: 67
PieOfPie: 68
PieExploded: 69
3DPieExploded: 70
BarOfPie: 71
XYScatterSmooth: 72
XYScatterSmoothNoMarkers: 73
XYScatterLines: 74
XYScatterLinesNoMarkers: 75
AreaStacked: 76
AreaStacked100: 77
3DAreaStacked: 78
3DAreaStacked100: 79
DoughnutExploded: 80
RadarMarkers: 81
RadarFilled: 82
Surface: 83
SurfaceWireframe: 84
SurfaceTopView: 85
SurfaceTopViewWireframe: 86
Bubble: 15
Bubble3DEffect: 87
StockHLC: 88
StockOHLC: 89
StockVHLC: 90
StockVOHLC: 91
CylinderColClustered: 92
CylinderColStacked: 93
CylinderColStacked100: 94
CylinderBarClustered: 95
CylinderBarStacked: 96
CylinderBarStacked100: 97
CylinderCol: 98
ConeColClustered: 99
ConeColStacked: 100
ConeColStacked100: 101
ConeBarClustered: 102
ConeBarStacked: 103
ConeBarStacked100: 104
ConeCol: 105
PyramidColClustered: 106
PyramidColStacked: 107
PyramidColStacked100: 108
PyramidBarClustered: 109
PyramidBarStacked: 110
PyramidBarStacked100: 111
PyramidCol: 112
3DColumn: ¯4100
Line: 4
3DLine: ¯4101
3DPie: ¯4102
Pie: 5
XYScatter: ¯4169
3DArea: ¯4098
Area: 1
Doughnut: ¯4120
Radar: ¯4151
Example:
'ee' Œwi 'charttype' 'CylinderCol' |
| 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 |
| comment |
Description: Get or Set a comment for a given cell in a given sheet
Syntax: 'obj' Œwi 'comment'sheet range {comment {height width {backcolor1 backcolor2 gradienttype variant}}}
sheet: an existing sheet number or sheet name or 0 for ActiveSheet
range: an cell reference (example: 'D14' or (14 4))
or a range in 'A2:C8' format
or a range in (toprow leftcol bottomrow rightcol) format
comment: a comment (a character vector with embedded Œtcnls)
height width: comment height and width in pixels
or 0 0 to autosize the comment
backcolor1: 1st background color (3 element numeric vector)
backcolor2: 2nd background color (3 element numeric vector)
gradienttype: type of gradient:
1=msoGradientHorizontal
2=msoGradientVertical
3=msoGradientDiagonalUp
4=msoGradientDiagonalDown
5=msoGradientFromCorner
6=msoGradientFromTitle
7=msoGradientFromCenter
¯2=msoGradientMixed
variant: an integer (1 thru 4)
Note: if comment is empty, comment is removed from the specified cells
Examples:
'ee' Œwi 'comment'2(3 4) ('This is a comment for cell',Œtcnl,'"D3" in sheet 2')
'ee' Œwi 'comment'2'D3' ('This is a comment for cell',Œtcnl,'"D3" in sheet 2')
'ee' Œwi 'comment' 'Sales' 'D3' ('This is a comment for cell',Œtcnl,'"D3" in sheet named Sales')1
*:Œwres„'' ª …0}
*:…Œlc+1} |
| commentcolor |
Description: Allow to get or set the background color of the current Comment object
Syntax: 'obj' Œwi 'commentcolor' {backcolor1 backcolor2 gradienttype variant}
backcolor1: 1st background color (3 element numeric vector)
backcolor2: 2nd background color (3 element numeric vector)
gradienttype: type of gradient:
1=msoGradientHorizontal
2=msoGradientVertical
3=msoGradientDiagonalUp
4=msoGradientDiagonalDown
5=msoGradientFromCorner
6=msoGradientFromTitle
7=msoGradientFromCenter
¯2=msoGradientMixed
variant: an integer (1 thru 4)
Note: Use Ð for backgcolor2 if you do not want any gradient color fill
Returns Œtcesc if no comment object defined
Example:
'ee' Œwi 'commentcolor' (255 255 0) (0 0 255)3 1 © define a horizontal gradient background from blue to red |
| commentsize |
Description: Allow to get or set the size of the current Comment object
Syntax: 'obj' Œwi 'commentsize' {height width}
height: new height
width: new width
Note: Use Ð for height and/or width if you do not want to change them
Use 0 to AutoSize comment
Returns Œtcesc if no comment object defined
Example:
'ee' Œwi 'commentsize'Ð 300 © changes the comment width to 300 pixels |
| defaultfilepath |
Description: Get or Set the default path that Microsoft Excel uses when it opens files
Syntax: 'obj' Œwi 'defaultfilepath' {defaultfilepath}
defaultfilepath: a character string (a complete DOS path name) |
| deleteatclose |
Description: Allows to automatically delete the Excel object when it is closed
Syntax: {boolean„'} 'obj' Œwi 'deleteatclose' {boolean}
boolean: 1=(default)delete Excel object when closed 0=don't
Example:
'ee' Œwi 'deleteatclose'1 |
| fittopagestall |
Description: Get or Set the number of vertical pages to fit the printout to
Syntax: 'obj' Œwi 'fittopagestall'fittopagestall
fittopagestall: an integer scalar (a number of pages)
or 0 to unselect the Fit to: radio button © LES1dec03 added
Example:
'ee' Œwi 'fittopagestall'1 |
| fittopageswide |
Description: Get or Set the number of horizontal pages to fit the printout to
Syntax: {fittopageswide„'} 'obj' Œwi 'fittopageswide'fittopageswide
fittopageswide: an integer scalar (a number of pages)
or 0 to unselect the Fit to: radio button © LES1dec03 added
Example:
'ee' Œwi 'fittopageswide'2 |
| 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 |
| footermargin |
Description: Get or Set the print footer margin in centimeters
Syntax: {footermargin„'} 'obj' Œwi 'footermargin' {footermargin}
footermargin: an integer scalar (the footermargin in centimeters)
Note: To specify a margin in inches use:
'ee' Œwi 'footermargin' ('ee' Œwi 'InchesToCentimeters'3)
where 3 represents inches
Example:
'ee' Œwi 'footermargin'1.5 © sets the footer margin to 1.5 centimeters |
|
| footerpicture |
Description: Allows to install an image in the page Footer
Syntax: 'obj' Œwi 'footerpicture'alignment filename
alignment: any of 'Left' 'Cetner' or 'Right'
filename: any graphic file name (.gif, .jpg, etc.)
Example:
'ee' Œwi 'footerpicture' 'Left' 'C:\Inetpub\wwwroot\lc\Images\new.gif' |
| 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' © ELE11dec05 F…f |
| 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') |
| headermargin |
Description: Get or Set the print header margin in centimeters
Syntax: 'obj' Œwi 'headermargin'headermargin
headermargin: an integer scalar (the headermargin in centimeters)
Note: To specify a margin in inches use:
'ee' Œwi 'footermargin' ('ee' Œwi 'InchesToCentimeters'3)
where 3 represents inches
Example:
'ee' Œwi 'headermargin'2.5 © sets the header margin to 1.5 centimeters |
|
| headerpicture |
Description: Allows to install an image in the page Header
Syntax: 'obj' Œwi 'headerpicture'alignment filename
alignment: any of 'Left' 'Cetner' or 'Right'
filename: any graphic file name (.gif, .jpg, etc.)
Example of other sub-properties of the LeftHeaderPicture property:
.FileName = "C:\Sample.jpg"
.Height = 275.25
.Width = 463.5
.Brightness = 0.36
.ColorType = msoPictureGrayscale
.Contrast = 0.39
.CropBottom = -14.4
.CropLeft = -28.8
.CropRight = -14.4
.CropTop = 21.6
Example:
'ee' Œwi 'headerpicture' 'Left' 'C:\Inetpub\wwwroot\lc\Images\new.gif' |
| help |
Example:
–(0¬½'ee' Œwi '*self')/"'ee' Œwi 'Close'"
0 0½'ee' Œwi '*Create' 'TExcel5' ('*visible'1) ('ontop'1)
'ee' Œwi 'AddBook'1
'ee' Œwi 'Add'1(2 2) (9 6½¼54)
'ee' Œwi 'AutoFit'
'ee' Œwi 'AddSheet' '' ('ee' Œwi 'sheetname')1 © adds one sheet after Sheet1
'ee' Œwi 'Add'2(1 1) (3 4½'APL+Win'1200.12 37669 37669 'APL+Dos'0 37670 37670 'APL+Unix'123.48 37670 37670) (3 4½8 3 7 6)
'ee' Œwi 'AutoFit'2
'ee' Œwi 'AddSheet' (†¯1†'ee' Œwi 'sheetnames') ''2
'ee' Œwi 'AddSheet' '' (2œ'ee' Œwi 'sheetnames')1
'ee' Œwi 'AddSheet'
'ee' Œwi 'DeleteSheet' (†¯1†'ee' Œwi 'sheetnames') © delete Sheet6
'ee' Œwi 'DeleteSheet' (4œ'ee' Œwi 'sheetnames') © delete Sheet3
'ee' Œwi 'DeleteSheet' (2œ'ee' Œwi 'sheetnames') © delete Sheet4
'ee' Œwi 'sheet'2 © select Sheet5
'ee' Œwi 'DeleteSheet'
'ee' Œwi 'SaveAs' 'c:\temp\book2.xls'
'ee' Œwi 'IsWorkbookOpen' 'c:\temp\book2.xls'
'ee' Œwi 'IsWorkbookOpen' 'c:\temp\book9.xls'
'ee' Œwi 'HideMenus'
'ee' Œwi 'HideToolBars'
'ee' Œwi 'HideFormulaBar'
'ee' Œwi 'HideStatusBar'
'ee' Œwi 'HideScrollBars'
'ee' Œwi 'ShowScrollBars'
'ee' Œwi 'ShowStatusBar'
'ee' Œwi 'ShowFormulaBar'
'ee' Œwi 'ShowToolBars'
'ee' Œwi 'ShowMenus'
'ee' Œwi 'Display'1 0 0 0 1
'ee' Œwi 'Display'
'ee' Œwi 'Display'1 1 1 1 1
'ee' Œwi 'sheet'1
'ee' Œwi 'range'2'A1:A3'
'ee' Œwi 'rowheight'13 20
'ee' Œwi 'ApplyMatrixProperty' 'backcolor'2(1 1) (3 4½4/(255 153 153) (153 153 255))
'ee' Œwi '*Set' ('range'1'A1:J1') ('columnwidth'2 4 6 8 10 8 6 4 2)
'ee' Œwi '*Set' ('range'1'C4:E7') ('border'1 3) ('bordercolor'255)
'ee' Œwi '*Set' ('range'1'G6:G8') ('border'1 4) ('bordercolor'255 0 0)
'ee' Œwi '*Set' ('range'1'F2:G3') ('border'5 3)
'ee' Œwi '*Set' ('range'1'D5:D6') ('border'2 3)
'ee' Œwi '*Set' ('range'1'C4:E7') ('backcolor'192 192 0)
'ee' Œwi '*Set' ('range'1'G6:G8') ('backcolor'0 192 192)
'ee' Œwi '*Set' ('range'1'F2:G3') ('backcolor' (256ƒ192 0 192))
'ee' Œwi '*Set' ('range'1'D5:D6') ('backcolor'0 0 192)
'ee' Œwi '*Set' ('range'1 4 3 4 3) ('fontsize'14) ('fontbold'1)
'ee' Œwi '*Set' ('range'1('F2:G3',('ee' Œwi '*xInternational(=xlListSeparator) '),'G6:G8')) ('fontsize'16) ('fontitalic'1) ('fontcolor'192 0 0) © ELE20nov03 ;…(5œ...)
'ee' Œwi '*Set' ('range'1'D5:D6') ('fontname' 'Impact') ('fontsize'36)
'ee' Œwi 'sheet'2
'ee' Œwi 'range'0'A1:D1'
'ee' Œwi 'columnwidth'20 10 20 20
'ee' Œwi 'Insert'0'A1:D1'
'ee' Œwi 'Add'0(1 1) (1 1½›'Title centered above column A,B,C & D')
'ee' Œwi '*Set' ('range'2'A2:A4') ('halign' 'right')
'ee' Œwi '*Set' ('range'2'B2:B4') ('halign' 'center')
'ee' Œwi '*Set' ('range'2'C2:C4') ('halign' 'left')
'ee' Œwi '*Set' ('range'2'D2:D4') ('halign' 'fill')
'ee' Œwi '*Set' ('range'2'A1:D1') ('halign' 'centeracross')
'ee' Œwi '*Set' ('range'2'A1:D4') ('halign' 'general')
'ee' Œwi 'range'2'A3'
'ee' Œwi 'rowheight'
'ee' Œwi '*Set' ('rowheight'36) ('valign' 'top')
'ee' Œwi '*Set' ('range'2'B3') ('valign' 'center')
'ee' Œwi '*Set' ('range'2'C3') ('valign' 'bottom')
'ee' Œwi '*Set' ('range'2'D3') ('valign' 'fill')
'ee' Œwi '*Set' ('range'2'A1:D4') ('valign' 'general')
'ee' Œwi 'range'2'B2:B4'
'ee' Œwi 'Add'2(2 2) (3 1½1200 ¯3.14158 123.666666)
© Note: The instruction below does not work in Excel 97
© You must also provide colors in your Excel regional version; you can determine the regional version you are using with: © ELE19nov03 added
© 'ee' Œwi '*xInternational(=xlCountryCode) '
© For example, if the above instruction returns 33 (=France), you should use the next instruction should be:
© 'ee' Œwi '*Set' ('range'2'B2:B4') ('format' '[Bleu][>1000]# ###,00" USD ";[Rouge](# ###,00" USD");[Noir]# ###,00" USD "')
'ee' Œwi '*Set' ('range'2'B2:B4') ('format' '[Blue][>1000]# ###,00" USD ";[Red](# ###,00" USD");[Black]# ###,00" USD "')
'ee' Œwi '*Set' ('range'2'C2:C4') ('format' 'jjj jj mmm aaaa')
'ee' Œwi 'CheckPrinter'
© Printing---------------------------------
© in centimeters:
'ee' Œwi '*Set' ('headermargin'.2) ('topmargin'1) ('footermargin'.2) ('bottommargin'1) ('leftmargin'1.5) ('rightmargin'1.5)
© or alternatively in inches:
aaa„'ee' Œwi 'InchesToCentimeters'.1 .6 .1 .6 1 1
'ee' Œwi '*Set' ('headermargin' (1œaaa)) ('topmargin' (2œaaa)) ('footermargin' (3œaaa)) ('bottommargin' (4œaaa)) ('leftmargin' (5œaaa)) ('rightmargin' (6œaaa))
'ee' Œwi 'leftheader' ( 'Left header',Œtcnl,'Second left header line')
'ee' Œwi 'centerheader' ('Center header',Œtcnl,'2nd center header line',Œtcnl,'3rd center header line')
'ee' Œwi 'rightheader' 'Right Header'
'ee' Œwi 'rightfooter' '&14 &"Verdana" &B &F &B &I &D &T &I &B Page &P/&N'
© Note: see <leftfooter> property for explanations about the various codes
© Note: the header/footer codes are COUNTRY specific
'ee' Œwi 'printtitlerows'1 © prints line 1 at top of each page
'ee' Œwi 'printtitlecolumns' 'A' © prints column A at left of each page
'ee' Œwi 'printgridlines'0 © do not print grid lines
© 'ee' Œwi 'Print'2 © print the second sheet
'ee' Œwi 'sheet'1 © move to sheet 1
'ee' Œwi 'printarea' 'B2:G10' © define the cells to be printed: B2:G10
'ee' Œwi 'hpagebreaks'4 8 10 © set up page breaks before lines 3, 8 and 10
© Note that the 2 following properties cannot be used if hpagebreaks has been used
© 'ee' Œwi 'fittopageswide'1 © ensure that the printout will horizontally fit within one page
© 'ee' Œwi 'fittopagestall'1 © ensure that the printout will vertically fit within one page
'ee' Œwi 'PrintPreview' © do a print preview of the document to print
© Formulas---------------------------------
'ee' Œwi 'formula'1'B11' '=sum(B2:B10) ' © set a formula in B11
'ee' Œwi 'formula'1'B11:G11' '=sum(B2:B10) ' © sets the same formula in C11 D11 E11 F11 G11
© Comments---------------------------------
'ee' Œwi 'comment'1(5 4) ('One of the biggest cell',Œtcnl,'in this sheet')
'ee' Œwi 'commentcolor' (0 255 255) (0 0 255)3 1
© 'ee' Œwi 'commentsize'40 120 © to change the comment window size
© Defined names----------------------------
'ee' Œwi 'range'2'A2'
'ee' Œwi 'name' 'aplwin'
'ee' Œwi 'rangename'2'A4' 'aplunix'
'ee' Œwi 'rangename'1'B2:G10' 'table'
'ee' Œwi 'DeleteNames' 'apldos' 'aplwin'
'ee' Œwi 'rangename' 2'A1' 'aplwin'
'ee' Œwi 'rangename' 2'A2' 'apldos'
'ee' Œwi 'rangename' 2'A3' 'aplunix'
'ee' Œwi 'RefersTo' 'aplwin'
'ee' Œwi 'DeleteNames' 'apldos' 'aplunix'
'ee' Œwi 'names'
'ee' Œwi 'DeleteAllNames'
'ee' Œwi 'names'
© Utilities--------------------------------
'ee' Œwi 'listseparator'
'ee' Œwi 'sscolumns'
'ee' Œwi 'Used' |
| hpagebreaks |
Description: Get or Set the line numbers at which a print page break is installed
Syntax: {lines„'} 'obj' Œwi 'hpagebreaks'lines
lines: line numbers at which a page break is installed
Notes:
1. this property cannot be used when you use the FitToPage properties
More precisely: you can set the <fittopageswide> property but then need © LES9mar04 added
to set the <fittopagestall> property to: ('#' Œwi 'VT'0 11) © LES9mar04 added
2. the number of page breaks per sheet is limited to 1026
Example:
'ee' Œwi 'hpagebreaks'3 8 12 14 16 20 |
| hwnd |
Description: Read-only property returning the Excel sheet handle
Syntax: hwnd„'obj' Œwi 'hwnd'
Example:
'ee' Œwi 'hwnd' |
| interactive |
Description: Set the Interactive mode to 1/0 to enable/disable user interaction
Syntax: {interactive„'} 'obj' Œwi 'Interactive'enable
enable: 1=enable user interaction 0=disable user interaction
Example:
'ee' Œwi '*xInteractive'0 |
| 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 |
| leftfooter |
Description: Get or Set the print left footer
Syntax: {leftfooter„'} 'obj' Œwi 'leftfooter'leftfooter
leftfooter: a character string
***NOTE: the codes below are country dependent
***Two examples are provided here: USA and France.
***Look for your own country Format Codes in Excel VBA documentation
-----------------------------------------------------------------------
Format Codes for USA (& English speaking countries)
-----------------------------------------------------------------------
&L Left aligns the characters that follow.
&C Centers the characters that follow.
&R Right aligns the characters that follow.
&E Turns double-underline printing on or off.
&X Turns superscript printing on or off.
&Y Turns subscript printing on or off.
&B Turns bold printing on or off.
&I Turns italic printing on or off.
&U Turns underline printing on or off.
&S Turns strikethrough printing on or off.
&D Prints the current date.
&T Prints the current time.
&F Prints the name of the document.
&A Prints the name of the workbook tab.
&P Prints the page number.
&P+number Prints the page number plus the specified number.
&P-number Prints the page number minus the specified number.
&& Prints a single ampersand.
& "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks.
&nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points.
&N Prints the total number of pages in the document.
&G Adds graphics to Header or Footer © ELE10aug05 added
-----------------------------------------------------------------------
Format Codes for France
-----------------------------------------------------------------------
&E Left aligns the characters that follow.
&C Centers the characters that follow.
&D Right aligns the characters that follow.
&L Turns double-underline printing on or off.
&X Turns superscript printing on or off.
&Y Turns subscript printing on or off.
&G Turns bold printing on or off.
&I Turns italic printing on or off.
&S Turns underline printing on or off.
&B Turns strikethrough printing on or off.
&J Prints the current date.
&H Prints the current time.
&N Prints the name of the document.
&A Prints the name of the workbook tab.
&P Prints the page number.
&P+nombre Prints the page number plus the specified number.
&P-nombre Prints the page number minus the specified number.
&& Prints a single ampersand.
& "nom_police" Prints the characters that follow in the specified font. Be sure to include the double quotation marks.
&nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points.
&T Prints the total number of pages in the document.
&F Adds graphics to Header or Footer © ELE10aug05 added
-----------------------------------------------------------------------
Example:
'ff' Œwi 'leftfooter' '&08 &""Verdana"" &F &D &T Page &P/&N' © in USA
'ff' Œwi 'leftfooter' '&08 &""Verdana"" &N &J &H Page &P/&T' © in France (same as above in USA) |
| leftheader |
Description: Get or Set the print left header
Syntax: 'obj' Œwi 'leftheader'leftheader
leftheader: a character string
See possible codes in <leftfooter> property documentation
Example:
'ff' Œwi 'leftheader' '&08 &""Verdana"" &N &J &H Page &P/&T' |
| leftmargin |
Description: Get or Set the print left margin
Syntax: {leftmargin„'} 'obj' Œwi 'leftmargin'leftmargin
leftmargin: an integer scalar (the left margin in centimeters)
Note: To specify a margin in inches use:
'ee' Œwi 'leftmargin' ('ee' Œwi 'InchesToCentimeters'3)
where 3 represents inches
Example:
'ee' Œwi 'leftmargin'2.5 © sets the left margin to 2.5 centimeters |
| 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 |
| orientation |
Description: Get or Set the printer page orientation
Syntax: 'obj' Œwi 'orientation'orientation
orientation: the printer page orientation: 'portrait' or 'landscape'
Example:
'ee' Œwi 'orientation' 'landscape' |
| papersize |
Description: Gets or sets the print paper size
Syntax: {papersize„'} 'obj' Œwi 'papersize'papersize
papersize: 'A3' 'A4' 'A5' 'Letter' or 'Legal'
Note: yields an error if specified paper size not available for current printer
Example:
'ee' Œwi 'papersize' 'A4' |
| printarea |
Description: Get or set the Print Area
Syntax: {printarea„'} 'obj' Œwi 'printarea'printarea
printarea: a range of cells representing the Print Area
Example:
ee' Œwi 'printarea' '$A$1:$J$100' |
| printer |
Description: Get or set the active printer'
Syntax: {printername„'} 'obj' Œwi 'printer'printername
printername: a printer name as returned by the Application.ActivePrinter property
Note: call: 'obj' Œwi 'Dialog'9 to see available declared printers
Example:
ee' Œwi 'printer'
HP LaserJet 4050 Series PCL6 on LPT1: |
| printgridlines |
Description: Informs object to print grid lines or not
Syntax: {boolean„'} 'obj' Œwi 'printgridlines'boolean
boolean: 1=print grid lines 0=don't
Example:
'ee' Œwi 'printgridlines'0 |
| printtitlecolumns |
Description: Gets or sets the columns that contain the cells to be repeated on the left side of each page
Syntax: {columnrange„'} 'obj' Œwi 'printtitlecolumns'columnrange
columnrange: a column range (example: 'A' or 'A:C')
Example:
'ee' Œwi 'printtitlecolumns' A:J' © columns to be repeated at top of each page |
| printtitlerows |
Description: Gets or sets the rows that contain the cells to be repeated at the top of each page
Syntax: 'obj' Œwi 'printtitlerows'row1{row2}
or 'obj' Œwi 'printtitlerows'rowrange
rowrange: a row range (example: '3' or '3:5')
row1: a given row number
row2: a given row number
Examples:
'ee' Œwi 'printtitlerows'1 3
'ee' Œwi 'printtitlerows' '1:3' |
| 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 |
| rightfooter |
Description: Get or Set the print right footer
Syntax: 'obj' Œwi 'rightfooter'rightfooter
rightfooter: a character string
See possible codes in <leftfooter> property documentation
Example:
'ff' Œwi 'rightfooter' '&08 &""Verdana"" &N &J &H Page &P/&T' |
| rightheader |
Description: Get or Set the print right header
Syntax: 'obj' Œwi 'rightheader'rightheader
rightheader: a character string
See possible codes in <leftfooter> property documentation
Example:
'ff' Œwi 'rightheader' '&08 &""Verdana"" &N &J &H Page &P/&T' |
| rightmargin |
Description: Get or Set the print top margin
Syntax: 'obj' Œwi 'rightmargin'rightmargin
rightmargin: an integer scalar (the right margin in centimeters)
Note: To specify a margin in inches use:
'ee' Œwi 'leftmargin' ('ee' Œwi 'InchesToCentimeters'3)
where 3 represents inches
Example:
'ee' Œwi 'leftmargin'3 © sets left margin to 3 centimeters |
| 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)
'ee' Œwi '*Set' ('range'2'A1:A5;A7:A10') ('rowheight'3) © same as: ('rowheight'3 3 3 3 3 3 3 3 3)
'ee' Œwi '*Set' ('range'2'A1:A5;A7:A10') ('rowheight'3 4 5 6 7 20 21 22 23) © does not work ok |
|
| 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)
'ee' Œwi '*Set' ('range'2'A1:A5;A7:A10') ('rowheightpix'3) © same as: ('rowheightpix'3 3 3 3 3 3 3 3 3)
'ee' Œwi '*Set' ('range'2'A1:A5;A7:A10') ('rowheightpix'3 4 5 6 7 20 21 22 23) © does not work ok |
| 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' |
| status |
Description: Set the Excel Statusbar message
Syntax: 'obj' Œwi 'status'message
message: character string message or '' to reset it
Example:
'ee' Œwi 'status' 'This message gets displayed on the Excel Status Bar'
'ee' Œwi 'status' '' © this erases the Status Bar message |
| topmargin |
Description: Get or Set the print top margin
Syntax: 'obj' Œwi 'topmargin'topmargin
topmargin: an integer scalar (the topmargin in centimeters)
Note: To specify a margin in inches use:
'ee' Œwi 'leftmargin' ('ee' Œwi 'InchesToCentimeters'3)
where 3 represents inches
Example:
'ee' Œwi 'topmargin'2 © sets the top margin to 2 centimeters |
| 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' |
| < |
TExcel5 
