Excel2004AppleScriptRef.pdf

Excel 2004 AppleScript Reference

Information in this document, including URL and other Internet Web site references, is subject to change

without notice. Unless otherwise noted, the example companies, organizations, products, domain names,

e-mail addresses, logos, people, places, and events depicted herein are fictitious, and no association with any

real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or

should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without

limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a

retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording,

or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.

Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights

covering subject matter in this document. Except as expressly provided in any written license agreement from

Microsoft, the furnishing of this document does not give you any license to these patents, trademarks,

copyrights, or other intellectual property.

Microsoft, MS-DOS, Windows, Windows NT, Windows Server, Entourage, Hotmail, and PowerPoint are either

registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

The names of actual companies and products mentioned herein may be the trademarks of their respective

owners.

Using the Excel Dictionary

About the Excel AppleScript Dictionary ...................................................................................................................13

Activating a workbook ................................................................................................................................................14

Creating a new workbook...........................................................................................................................................14

Opening a workbook ...................................................................................................................................................14

Referring to sheets by name........................................................................................................................................ 14

Referring to sheets by index number.........................................................................................................................15

How to reference cells and ranges .............................................................................................................................15

Selecting and activating cells ......................................................................................................................................18

Working with the active cell .......................................................................................................................................19

Microsoft Office Suite Classes

assistant .........................................................................................................................................................................21

balloon checkbox..........................................................................................................................................................24

balloon ...........................................................................................................................................................................25

balloon label..................................................................................................................................................................29

command bar ................................................................................................................................................................ 29

command bar button....................................................................................................................................................33

command bar combobox.............................................................................................................................................34

command bar control...................................................................................................................................................36

command bar popup....................................................................................................................................................39

custom document property.........................................................................................................................................39

document property ......................................................................................................................................................39

web page font................................................................................................................................................................41

Microsoft Office Suite Commands

add item to combobox .................................................................................................................................................43

clear combobox .............................................................................................................................................................43

execute ...........................................................................................................................................................................44

get combobox item .......................................................................................................................................................45

get count of combobox items ......................................................................................................................................45

remove an item from combobox.................................................................................................................................46

reset ................................................................................................................................................................................46

show balloon.................................................................................................................................................................47

Using the Excel Dictionary

Microsoft Excel Suite Classes

add in .............................................................................................................................................................................50

application..................................................................................................................................................................... 51

autofilter ........................................................................................................................................................................64

border.............................................................................................................................................................................64

button.............................................................................................................................................................................66

calculated field..............................................................................................................................................................70

calculated item..............................................................................................................................................................70

chart sheet......................................................................................................................................................................71

checkbox ........................................................................................................................................................................72

child item.......................................................................................................................................................................74

column field ..................................................................................................................................................................75

custom view .................................................................................................................................................................. 75

data field........................................................................................................................................................................76

default web options......................................................................................................................................................76

dialog .............................................................................................................................................................................80

document.......................................................................................................................................................................80

dropdown......................................................................................................................................................................80

Excel comment..............................................................................................................................................................83

filter................................................................................................................................................................................ 83

format condition ...........................................................................................................................................................84

graphic ........................................................................................................................................................................... 86

groupbox ....................................................................................................................................................................... 88

hidden field ...................................................................................................................................................................90

hidden item ...................................................................................................................................................................91

horizontal page break ..................................................................................................................................................91

hyperlink .......................................................................................................................................................................92

international macro sheet............................................................................................................................................94

label ................................................................................................................................................................................ 94

list column.....................................................................................................................................................................96

list object........................................................................................................................................................................97

list row ...........................................................................................................................................................................99

listbox............................................................................................................................................................................. 99

macro sheet .................................................................................................................................................................102

named item..................................................................................................................................................................102

ODBC error .................................................................................................................................................................104

option button ..............................................................................................................................................................105

outline ..........................................................................................................................................................................107

page field..................................................................................................................................................................... 108

page setup ...................................................................................................................................................................109

pane.............................................................................................................................................................................. 115

parent item .................................................................................................................................................................. 115

phonetic ....................................................................................................................................................................... 116

pivot cache...................................................................................................................................................................117

pivot field ....................................................................................................................................................................119

pivot formula .............................................................................................................................................................. 124

pivot item ....................................................................................................................................................................125

pivot table....................................................................................................................................................................127

query table...................................................................................................................................................................132

recent file .....................................................................................................................................................................139

row field.......................................................................................................................................................................140

scenario........................................................................................................................................................................140

scrollbar .......................................................................................................................................................................141

sheet .............................................................................................................................................................................143

spinner .........................................................................................................................................................................147

Using the Excel Dictionary

textbox..........................................................................................................................................................................149

validation.....................................................................................................................................................................153

vertical page break ..................................................................................................................................................... 156

web options.................................................................................................................................................................157

window........................................................................................................................................................................160

workbook.....................................................................................................................................................................165

worksheet .................................................................................................................................................................... 171

Microsoft Excel Suite Commands

accept all changes.......................................................................................................................................................175

activate next ................................................................................................................................................................175

activate object.............................................................................................................................................................. 176

activate previous ........................................................................................................................................................176

add chart autoformat ................................................................................................................................................. 176

add custom list............................................................................................................................................................177

add data validation ....................................................................................................................................................177

add fields to pivot table............................................................................................................................................. 178

add item to list............................................................................................................................................................ 179

add to favorites...........................................................................................................................................................179

auto show ....................................................................................................................................................................180

auto sort.......................................................................................................................................................................180

break link.....................................................................................................................................................................181

bring to front...............................................................................................................................................................181

calculate ....................................................................................................................................................................... 181

calculate full ................................................................................................................................................................ 182

cancel refresh .............................................................................................................................................................. 182

centimeters to points..................................................................................................................................................182

change data type of list column................................................................................................................................ 183

change file access........................................................................................................................................................ 184

change link ..................................................................................................................................................................184

change scenario...........................................................................................................................................................185

check spelling.............................................................................................................................................................. 185

check spelling for........................................................................................................................................................186

circle invalid................................................................................................................................................................186

clear arrows.................................................................................................................................................................187

clear circles ..................................................................................................................................................................187

clear contents ..............................................................................................................................................................187

convert formula .......................................................................................................................................................... 188

convert to range..........................................................................................................................................................188

copy object................................................................................................................................................................... 189

copy picture.................................................................................................................................................................189

copy worksheet...........................................................................................................................................................189

create new document.................................................................................................................................................189

create summary for scenarios ...................................................................................................................................190

cut.................................................................................................................................................................................190

delete chart autoformat .............................................................................................................................................191

delete custom list........................................................................................................................................................191

delete number format ................................................................................................................................................191

double click .................................................................................................................................................................192

edit................................................................................................................................................................................192

Excel comment text ....................................................................................................................................................193

Excel repeat ................................................................................................................................................................. 193

exclusive access...........................................................................................................................................................194

execute excel 4 macro................................................................................................................................................. 194

Using the Excel Dictionary

follow ........................................................................................................................................................................... 195

follow hyperlink .........................................................................................................................................................195

get border ....................................................................................................................................................................196

get clipboard formats.................................................................................................................................................197

get custom list contents .............................................................................................................................................197

get custom list num ....................................................................................................................................................197

get dialog .....................................................................................................................................................................198

get file converters .......................................................................................................................................................200

get FileMaker criteria................................................................................................................................................. 200

get international..........................................................................................................................................................200

get list item..................................................................................................................................................................201

get open filename .......................................................................................................................................................201

get pivot table data..................................................................................................................................................... 201

get previous selections...............................................................................................................................................201

get registered functions .............................................................................................................................................201

get save as filename ................................................................................................................................................... 202

get subtotals ................................................................................................................................................................203

get values.....................................................................................................................................................................204

get visible fields ..........................................................................................................................................................204

get webpage font ........................................................................................................................................................ 204

goto............................................................................................................................................................................... 205

help...............................................................................................................................................................................205

highlight changes options .........................................................................................................................................206

inches to points........................................................................................................................................................... 206

input box......................................................................................................................................................................207

intersect........................................................................................................................................................................208

item selected................................................................................................................................................................208

large scroll ...................................................................................................................................................................209

link info........................................................................................................................................................................209

link sources..................................................................................................................................................................210

list formulas ................................................................................................................................................................ 210

merge scenarios .......................................................................................................................................................... 210

merge workbook......................................................................................................................................................... 211

modify..........................................................................................................................................................................211

modify condition ........................................................................................................................................................213

new window on workbook.......................................................................................................................................213

next Excel comment ................................................................................................................................................... 214

on key........................................................................................................................................................................... 214

on repeat......................................................................................................................................................................216

open FileMaker file ....................................................................................................................................................217

open links .................................................................................................................................................................... 217

open text file................................................................................................................................................................ 218

open workbook........................................................................................................................................................... 220

paste special on worksheet........................................................................................................................................221

paste worksheet..........................................................................................................................................................222

pivot select...................................................................................................................................................................223

previous Excel comment ........................................................................................................................................... 224

print out.......................................................................................................................................................................224

print preview ..............................................................................................................................................................225

protect sharing............................................................................................................................................................225

protect workbook .......................................................................................................................................................226

protect worksheet....................................................................................................................................................... 226

purge change history now......................................................................................................................................... 227

refresh .......................................................................................................................................................................... 227

refresh all.....................................................................................................................................................................228

refresh query table...................................................................................................................................................... 228

refresh table................................................................................................................................................................. 229

Using the Excel Dictionary

register xll....................................................................................................................................................................229

reject all changes......................................................................................................................................................... 230

remove all items .........................................................................................................................................................230

remove item ................................................................................................................................................................230

remove user................................................................................................................................................................. 231

reset all page breaks ...................................................................................................................................................231

reset colors...................................................................................................................................................................231

run auto macros..........................................................................................................................................................232

run VB Macro.............................................................................................................................................................. 232

save as..........................................................................................................................................................................233

save workbook as .......................................................................................................................................................234

save workspace........................................................................................................................................................... 236

scroll workbook tabs ..................................................................................................................................................236

send to back.................................................................................................................................................................237

set background picture .............................................................................................................................................. 237

set default chart .......................................................................................................................................................... 237

set FileMaker criteria..................................................................................................................................................238

set list item...................................................................................................................................................................239

set subtotals................................................................................................................................................................. 239

show.............................................................................................................................................................................240

show all data ...............................................................................................................................................................242

show custom view...................................................................................................................................................... 242

show data form........................................................................................................................................................... 242

show levels..................................................................................................................................................................243

show pages.................................................................................................................................................................. 243

small scroll...................................................................................................................................................................244

undo .............................................................................................................................................................................244

union ............................................................................................................................................................................ 245

unprotect ..................................................................................................................................................................... 245

unprotect sharing .......................................................................................................................................................246

update .......................................................................................................................................................................... 246

update from file .......................................................................................................................................................... 246

update link ..................................................................................................................................................................247

use default folder suffix.............................................................................................................................................247

wait............................................................................................................................................................................... 247

web page preview ...................................................................................................................................................... 247

Drawing Suite Classes

arc .................................................................................................................................................................................249

callout...........................................................................................................................................................................253

callout format..............................................................................................................................................................254

connector format ........................................................................................................................................................257

fill format..................................................................................................................................................................... 259

line................................................................................................................................................................................ 264

line format ...................................................................................................................................................................266

oval...............................................................................................................................................................................270

picture..........................................................................................................................................................................274

picture format .............................................................................................................................................................274

rectangle ......................................................................................................................................................................276

shadow format............................................................................................................................................................ 279

shape ............................................................................................................................................................................ 280

shape connector .......................................................................................................................................................... 285

shape line.....................................................................................................................................................................286

shape textbox ..............................................................................................................................................................286

Using the Excel Dictionary

text frame.....................................................................................................................................................................287

threeD format..............................................................................................................................................................290

word art ....................................................................................................................................................................... 293

word art format ..........................................................................................................................................................295

Drawing Suite Commands

apply ............................................................................................................................................................................299

automatic length......................................................................................................................................................... 300

begin connect ..............................................................................................................................................................300

begin disconnect......................................................................................................................................................... 301

bring to front (drawing)............................................................................................................................................. 301

check spelling (drawing) ...........................................................................................................................................302

copy object (drawing) ................................................................................................................................................ 302

copy picture (drawing) ..............................................................................................................................................303

custom drop ................................................................................................................................................................303

custom length..............................................................................................................................................................304

cut (drawing) ..............................................................................................................................................................304

end connect .................................................................................................................................................................305

end disconnect............................................................................................................................................................ 306

flip ................................................................................................................................................................................ 306

one color gradient....................................................................................................................................................... 306

patterned .....................................................................................................................................................................307

pick up ......................................................................................................................................................................... 308

preset drop ..................................................................................................................................................................308

preset gradient............................................................................................................................................................309

preset textured ............................................................................................................................................................310

reroute connections ....................................................................................................................................................310

reset rotation ...............................................................................................................................................................311

scale height..................................................................................................................................................................312

scale width...................................................................................................................................................................313

send to back (drawing) ..............................................................................................................................................313

set extrusion direction................................................................................................................................................314

set shapes default properties ....................................................................................................................................315

set threed format ........................................................................................................................................................ 315

solid..............................................................................................................................................................................316

toggle vertical text ......................................................................................................................................................316

two color gradient ...................................................................................................................................................... 317

user picture..................................................................................................................................................................318

user textured ............................................................................................................................................................... 318

z order.......................................................................................................................................................................... 318

Text Suite Classes

character ......................................................................................................................................................................319

font ...............................................................................................................................................................................320

style ..............................................................................................................................................................................322

Using the Excel Dictionary

Text Suite Commands

get border (text) ..........................................................................................................................................................326

insert into.....................................................................................................................................................................326

Table Suite Classes

cell ................................................................................................................................................................................327

column .........................................................................................................................................................................327

range ............................................................................................................................................................................328

row ...............................................................................................................................................................................337

Table Suite Commands

activate object (table).................................................................................................................................................. 339

add comment .............................................................................................................................................................. 339

advanced filter ............................................................................................................................................................ 340

apply names ................................................................................................................................................................340

apply outline styles ....................................................................................................................................................341

autocomplete............................................................................................................................................................... 341

autofill..........................................................................................................................................................................342

autofilter range ...........................................................................................................................................................342

autofit........................................................................................................................................................................... 343

autoformat................................................................................................................................................................... 344

auto outline .................................................................................................................................................................345

border around............................................................................................................................................................. 345

calculate (table)...........................................................................................................................................................346

check spelling (table).................................................................................................................................................. 347

clear contents (table) ..................................................................................................................................................347

clear Excel comments................................................................................................................................................. 347

clear outline.................................................................................................................................................................348

clear range ...................................................................................................................................................................348

clear range formats.....................................................................................................................................................348

column differences.....................................................................................................................................................348

consolidate...................................................................................................................................................................349

copy picture (table) ....................................................................................................................................................350

copy range ................................................................................................................................................................... 350

create names................................................................................................................................................................351

cut range...................................................................................................................................................................... 351

data series....................................................................................................................................................................352

data table .....................................................................................................................................................................352

delete range.................................................................................................................................................................353

fill down.......................................................................................................................................................................353

fill left...........................................................................................................................................................................354

fill right ........................................................................................................................................................................354

fill up............................................................................................................................................................................ 354

find ............................................................................................................................................................................... 355

find next.......................................................................................................................................................................356

find previous...............................................................................................................................................................357

function wizard ..........................................................................................................................................................358

get address ..................................................................................................................................................................358

Using the Excel Dictionary

get address local ......................................................................................................................................................... 359

get border (table) ........................................................................................................................................................359

get end .........................................................................................................................................................................360

get offset ......................................................................................................................................................................360

get resize......................................................................................................................................................................361

get XML value............................................................................................................................................................. 361

goal seek ......................................................................................................................................................................361

group............................................................................................................................................................................ 362

insert indent ................................................................................................................................................................363

insert into range..........................................................................................................................................................363

justify ...........................................................................................................................................................................364

list names.....................................................................................................................................................................364

merge ...........................................................................................................................................................................364

navigate arrow............................................................................................................................................................ 365

parse.............................................................................................................................................................................365

paste special ................................................................................................................................................................366

print out (table)...........................................................................................................................................................367

print preview (table) .................................................................................................................................................. 367

remove subtotal .......................................................................................................................................................... 368

replace..........................................................................................................................................................................368

row differences ...........................................................................................................................................................369

run VB macro (table).................................................................................................................................................. 369

set XML value .............................................................................................................................................................370

show (table)................................................................................................................................................................. 370

show dependents........................................................................................................................................................ 370

show errors.................................................................................................................................................................. 371

show precedents.........................................................................................................................................................371

sort................................................................................................................................................................................ 371

sort special...................................................................................................................................................................373

special cells.................................................................................................................................................................. 374

subtotal ........................................................................................................................................................................375

text to columns............................................................................................................................................................ 375

ungroup .......................................................................................................................................................................377

unmerge.......................................................................................................................................................................378

Proofing Suite Classes

autocorrect................................................................................................................................................................... 379

Proofing Suite Commands

add replacement.........................................................................................................................................................380

delete replacement .....................................................................................................................................................380

get replacement list .................................................................................................................................................... 380

Chart Suite Classes

area group ...................................................................................................................................................................382

axis................................................................................................................................................................................ 382

axis title........................................................................................................................................................................ 388

bar group ..................................................................................................................................................................... 390

Using the Excel Dictionary

chart..............................................................................................................................................................................390

chart area .....................................................................................................................................................................396

chart fill format...........................................................................................................................................................397

chart group.................................................................................................................................................................. 401

chart object ..................................................................................................................................................................404

chart title...................................................................................................................................................................... 406

column group..............................................................................................................................................................409

corners..........................................................................................................................................................................409

data label ..................................................................................................................................................................... 409

data table .....................................................................................................................................................................412

display unit label........................................................................................................................................................413

doughnut group .........................................................................................................................................................415

down bars.................................................................................................................................................................... 416

drop lines.....................................................................................................................................................................416

error bars .....................................................................................................................................................................417

floor ..............................................................................................................................................................................417

gridlines....................................................................................................................................................................... 418

hilo lines.......................................................................................................................................................................419

interior .........................................................................................................................................................................419

leader lines ..................................................................................................................................................................421

legend...........................................................................................................................................................................421

legend entry ................................................................................................................................................................422

legend key ................................................................................................................................................................... 423

line group .................................................................................................................................................................... 426

pie group .....................................................................................................................................................................427

plot area ....................................................................................................................................................................... 427

radar group .................................................................................................................................................................429

series.............................................................................................................................................................................429

series lines ...................................................................................................................................................................435

series point ..................................................................................................................................................................436

tick labels.....................................................................................................................................................................438

trendline ......................................................................................................................................................................440

up bars .........................................................................................................................................................................441

walls .............................................................................................................................................................................442

xy group....................................................................................................................................................................... 443

Chart Suite Commands

activate object (chart) ................................................................................................................................................. 444

apply custom chart type ............................................................................................................................................ 445

apply data labels......................................................................................................................................................... 445

bring to front (chart)...................................................................................................................................................445

chart location............................................................................................................................................................... 446

chart one color gradient.............................................................................................................................................446

chart patterned............................................................................................................................................................447

chart solid....................................................................................................................................................................448

chart two color gradient ............................................................................................................................................448

chart user picture........................................................................................................................................................449

chart user textured .....................................................................................................................................................449

chart wizard ................................................................................................................................................................ 449

check spelling (chart) ................................................................................................................................................. 450

clear ..............................................................................................................................................................................450

clear contents (chart)..................................................................................................................................................450

clear formats................................................................................................................................................................ 451

copy chart as picture..................................................................................................................................................451

Using the Excel Dictionary

copy object (chart) ......................................................................................................................................................451

copy picture (chart) ....................................................................................................................................................452

cut (chart)..................................................................................................................................................................... 452

deselect ........................................................................................................................................................................ 452

error bar....................................................................................................................................................................... 453

get axis ......................................................................................................................................................................... 453

get chart element ........................................................................................................................................................453

get has axis ..................................................................................................................................................................455

paste ............................................................................................................................................................................. 455

paste chart ...................................................................................................................................................................456

paste series ..................................................................................................................................................................456

preset chart gradient.................................................................................................................................................. 457

preset chart textured ..................................................................................................................................................458

print out (chart) .......................................................................................................................................................... 458

print preview (chart)..................................................................................................................................................458

protect chart ................................................................................................................................................................ 459

refresh (chart).............................................................................................................................................................. 459

save as (chart).............................................................................................................................................................. 460

send to back (chart) ....................................................................................................................................................461

set background picture (chart).................................................................................................................................. 461

set has axis................................................................................................................................................................... 461

set source data.............................................................................................................................................................462

unprotect (chart)......................................................................................................................................................... 462