TweetFollow Us on Twitter

Introduction to Scripting Microsoft Word

Volume Number: 23 (2007)
Issue Number: 01
Column Tag: Applescript Essentials

Introduction to Scripting Microsoft Word

by Benjamin S. Waldie

Lately, there has been a lot of talk in the Macintosh community about Microsoft, and the forthcoming Office 12. One of Microsoft's big announcements is that they will be doing away with support for creating and running Visual Basic macros in the next version of Office. This leaves many people wondering how they will go about automating their Office applications. AppleScript to the rescue. I'm pleased to say that Entourage, Excel, PowerPoint, and Word are all AppleScriptable.

Office has supported AppleScript for some time now, and with the release of Office 11 in 2004, Microsoft actually completely re-implemented much of their AppleScript support, and also added AppleScript support for PowerPoint. Due to these changes, much of the AppleScript terminology in Word and Excel changed from previous versions. If you are currently using Office AppleScripts with a pre-2004 version of Office, then please be aware that you will probably need to make some modifications to your scripts when you decide to upgrade your Office suite. Of course, this should go without saying when upgrading any scriptable application. Any time any application is updated, AppleScript terminology changes may be introduced. This is why it is always a good idea to test your existing scripts with any new application version before implementing it into your live workflow.

This month, we're going to take a look at scripting Microsoft Word. We'll walk through some basic techniques for interacting with Word documents, and the content within those documents. Please note that all code in this month's column was written for and tested with Office 11 (2004). Therefore, if you're using a different version of Office, please be aware that the terminology you need to use may differ from that which I have used.

Working with Documents

Making a Document

Making a new Word document is relatively straightforward. To make a new Word document, simply use the make command, as demonstrated here.

tell application "Microsoft Word"
   make new document
end tell
--> document "Document1" of application "Microsoft Word"

Notice that the result of the make command is a reference to the newly created document. This reference may be placed into a variable, if desired, for future reference in your script.

Closing a Document

Closing a Word document is also pretty straightforward. To close a Word document, use the close command. Optionally, you may specify a constant value (yes, no, or ask) for the close command's saving parameter, to indicate whether the document being closed should be saved. The following example code will close a document without saving it.

tell application "Microsoft Word"
   close document 1 saving no
end tell

Opening a Document

To open a Word document, use the open command, followed by a reference to the document file you wish to open. The following example code will prompt the user to select a Word document file. It will then open that file.

set theDocFile to choose file with prompt "Please select a Word document file:"
tell application "Microsoft Word"
   open theDocFile
end tell

Please note that, in the example above, no result is returned by the open command. Since you will typically want your script to perform additional tasks on the newly opened document, you will need a way of referencing the document. There are a number of ways that this can be done. Assuming you know the name of the document, one way to do this is to retrieve a reference to the document using its name. For example:

set theDocFile to choose file with prompt "Please select a Word document file:"
set theDocName to name of (info for theDocFile)
tell application "Microsoft Word"
   open theDocFile
   set theDocument to document theDocName
end tell
--> document "My Document.doc" of application "Microsoft Word"

If you're sure that the target document will be in the front, then another way you can reference it is by referencing the active document application property. For example:

set theDocFile to choose file with prompt "Please select a Word document file:"
tell application "Microsoft Word"
   open theDocFile
   set theDocument to active document
end tell
--> active document of application "Microsoft Word"

Take note that the result of the code above is a reference to the active document. This may work fine in most cases. However, be aware that, since it is not referencing a specific document, if another document is brought to the front, then the incorrect document may be targeted.

It's also important to note is that, in Word, documents have an index number. However, this number does not indicate the front to back position of the document, as it often does in many other applications. Instead, it indicates the document's position, in the order that the documents were opened. In other words, if a document in the back was the last document to be opened, then the front document will not be document 1. For this reason, when you want to target the front document in Word, it's always good practice to reference the active document.

We have discussed a couple of ways to retrieve a reference to a newly opened document. There are others, some of which are more robust, and I would encourage you to see if you can come up with some ways of doing this on your own.

Saving a Document

Saving a previously saved document into its original location is as simple as using the save command, as demonstrated here.

tell application "Microsoft Word"
   save active document
end tell

However, suppose you want to save a document into a specific location, or in a different format? This is done using Word's save as command. This command has several optional parameters, which will allow you to specify the output location, format, and more. To save a document into a specific location, make use of the file name parameter, as follows:

set theOutputPath to (path to desktop folder as string) & "My Saved Doc.doc"
tell application "Microsoft Word"
   save as active document file name theOutputPath
end tell

To specify a format for the saved document, use the file format parameter. For example, the following code will save a document in RTF format:

set theOutputPath to (path to desktop folder as string) & "My Saved Doc.rtf"
tell application "Microsoft Word"
   save as active document file name theOutputPath file format format rtf
end tell

There are numerous other formats in which you can save a Word document, including Word template, HTML, web archive, and more. A complete list of supported formats can be found in Word's AppleScript dictionary, under the save as command.

Working with Document Text

Working with Text Ranges

In a Word document, text is typically referenced using text ranges. A text range is a class of object that refers to a specific area of text, such as a single character, word, or paragraph, or all of the text within the document. Each text range has a starting and ending position. For example, a text range might represent character 1 through character 5 of the document. The position 0 represents the absolute beginning of a document, just before the first character, so if you wanted to reference the first 5 characters of a document, the text range would actually begin at position 0, and end at position 5.

To reference text within a Word document, you must first create a text range. This is done by using the create range command. This command simply creates a reference for you, to the specified text content. Here's an example:

tell application "Microsoft Word"
   tell active document
      set theRange to create range start 0 end 5
   end tell
end tell
--> text range id «data iWrg0000000000000005» ¬
of active document of application "Microsoft Word"

The result of the code above is a reference to a range of text within my document, in this case, characters 1 through 5. I can now access attributes of this text by referencing the range. For example, the following code will get the text content within the range:

tell application "Microsoft Word"
   tell active document
      set theRange to create range start 0 end 5
      content of theRange
   end tell
end tell
--> "APPLE"

Getting the Entire Content of a Document

In Word, the document class possesses a text object property. This property references a text range representing the entire content of the document. For example:

tell application "Microsoft Word"
   tell active document
      content of text object
   end tell
end tell
--> "APPLESCRIPT ESSENTIALS
      Introduction to Scripting Microsoft Word
      Copyright 2007 by Ben Waldie...

Adding Text to a Document

To replace text in a Word document, create a text range representing the text to be replaced. Then set the content property of that range to the desired text. For example:

tell application "Microsoft Word"
   tell active document
      set theRange to create range start 0 end 5
      set content of theRange to "TEST"
   end tell
end tell

Another way that text can be added to a document is by inserting it. This is done by using the insert command. This command has a required parameter, text, which indicates the text to be inserted. It also has an optional parameter, at, which can be used to indicate the location before which the text should be inserted. For example, the following code will insert the text TEST at the beginning of the active document.

tell application "Microsoft Word"
   tell active document
      set theRange to create range start 0 end 0
      insert text "TEST" at theRange
   end tell
end tell

This same task could also have been accomplished by setting the content property of a range representing the beginning of the document to the specified text. For example:

tell application "Microsoft Word"
   tell active document
      set theRange to create range start 0 end 0
      set content of theRange to "TEST"
   end tell
end tell

Working with Other Content

It's also possible to add other types of elements besides text into Word documents via scripting. For example, you might want to insert a hyperlink, or an image.

Adding a Hyperlink to a Document

To add a hyperlink to a document, use the make command to create a hyperlink object. In doing so, you may specify property values for the hyperlink, including the text to be displayed the link URL, and the text range representing the location where the hyperlink should be created. For example, the following code will create a hyperlink to my company's website at the beginning of the active document.

tell application "Microsoft Word"
   tell active document
      set theRange to create range start 0 end 0
      make new hyperlink object at end with properties ¬
{text to display:"Automated Workflows, LLC", hyperlink ¬
address:"http://www.automatedworkflows.com", ¬
text object:theRange} end tell end tell --> hyperlink object "http://www.automatedworkflows.com" ¬
of active document of application "Microsoft Word"

Adding a Picture to a Document

Adding an inline picture to a document is similar to adding a hyperlink. Again, use the make command, but this time create an inline picture, rather than a hyperlink object. When using this command, you may specify property values for the picture, including the file name property, which should include the path of the picture file to be inserted (as a string). For example, the following code will create a new inline picture at the beginning of the active document.

set thePicturePath to choose file with prompt "Please select a picture to insert:"
tell application "Microsoft Word"
   tell active document
      set theRange to create range start 0 end 0
      make new inline picture at theRange with properties ¬ 
{file name:thePicturePath as string} end tell end tell --> inline picture 1 of text range id ¬
«data iWrg0000000000000000» of document "Document1" ¬
of application "Microsoft Word"

In Closing

Now that we have discussed some basic interaction with Word, where do you go from here? We have really only scratched the surface, and there's a lot more that can be done. Take some time to explore modifying attributes of text, such as the font, point size, and color. Explore modifying document properties, adjusting header and footer content, inserting a table of contents, and much more. Take some time to explore Word's AppleScript dictionary. You will find that it contains quite a lot of terminology, so it may actually take some time to become familiar and comfortable with it.

For additional help getting started with Word, be sure to review the Microsoft Word 2004 AppleScript Reference documentation. This documentation can be obtained in the Resources > Development Center > AppleScript Resources for Office 2004 section of Microsoft's Mactopia website at http://www.microsoft.com/mac/. You may also want to explore MacScripter.net's ScriptBuilders, at http://scriptbuilders.net/, where you will find some AppleScripts for Microsoft Word, some of which may even be editable!

Until next time, keep scripting!


Ben Waldie is the author of the best selling books "AppleScripting the Finder" and the "Mac OS X Technology Guide to Automator", available from http://www.spiderworks.com, as well as an AppleScript Training CD, available from http://www.vtc.com. Ben is also president of Automated Workflows, LLC, a company specializing in AppleScript and workflow automation consulting. For years, Ben has developed professional AppleScript-based solutions for businesses including Adobe, Apple, NASA, PC World, and TV Guide. For more information about Ben, please visit http://www.automatedworkflows.com, or email Ben at ben@automatedworkflows.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Fantastical 2.5.13 - Create calendar eve...
Fantastical is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event... Read more
A Better Finder Rename 11.05 - File, pho...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
SpamSieve 2.9.38 - Robust spam filter fo...
SpamSieve is a robust spam filter for major email clients that uses powerful Bayesian spam filtering. SpamSieve understands what your spam looks like in order to block it all, but also learns what... Read more
TeamViewer 15.0.8397 - Establish remote...
TeamViewer gives you remote control of any computer or Mac over the Internet within seconds or can be used for online meetings. Find out why more than 200 million users trust TeamViewer! Free for non... Read more
SteerMouse 5.4.3 - Powerful third-party...
SteerMouse is an advanced driver for USB and Bluetooth mice. SteerMouse can assign various functions to buttons that Apple's software does not allow, including double-clicks, modifier clicks,... Read more
Toast Titanium 18.2.1 - The ultimate med...
Roxio Toast Titanium, the leading DVD burner for Mac, makes burning even better, adding Roxio Secure Burn to protect your files on disc and USB in Mac- or Windows-compatible formats. Get more style... Read more
HoudahSpot 5.0.11 - Advanced file-search...
HoudahSpot is a versatile desktop search tool. Use HoudahSpot to locate hard-to-find files and keep frequently used files within reach. HoudahSpot will immediately feel familiar. It works just the... Read more
ClipGrab 3.8.6 - Download videos from Yo...
ClipGrab is a free downloader and converter for YouTube, Vimeo, Facebook and many other online video sites. It converts downloaded videos to MPEG4, MP3 or other formats in just one easy step Version... Read more
ExpanDrive 7.4.0 - Access cloud storage...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
Adobe Dreamweaver CC 2020 20.0 - Build w...
Dreamweaver CC 2020 is available as part of Adobe Creative Cloud for as little as $20.99/month (or $9.99/month if you're a previous Dreamweaver customer). Adobe Dreamweaver CC 2020 allows you to... Read more

Latest Forum Discussions

See All

New heroes and balance updates set to ar...
It feels like Hearthstone: Battlegrounds only launched yesterday, and already the auto batter addition to Blizzard's megahit card game is set to receive new heroes and balance updates. [Read more] | Read more »
Pre-register for Hello Kitty AR: Kawaii...
Hello Kitty — the cute cat that launched a multi-billion-pound franchise — has been brought to life… sort of. Sanrio has teamed up with the Bublar Group to create a new mobile game that uses AR tech to turn the real world into Hello Kitty’s... | Read more »
Gorgeous and tranquil puzzler Spring Fal...
One-man indie studio SPARSE//GameDev has now launched its tranquil puzzler, Spring Falls. It's described as "a peaceful puzzle game about water, erosion, and watching things grow". [Read more] | Read more »
Black Desert Mobile gets an official rel...
Pearl Abyss has just announced that its highly-anticipated MMO, Black Desert Mobile, will launch globally for iOS and Android on December 11th. [Read more] | Read more »
Another Eden receives new a episode, cha...
Another Eden, WFS' popular RPG, has received another update that brings new story content to the game alongside a few new heroes to discover. [Read more] | Read more »
Overdox guide - Tips and tricks for begi...
Overdox is a clever battle royale that changes things up by adding MOBA mechanics and melee combat to the mix. This new hybrid game can be quite a bit to take in at first, so we’ve put together a list of tips to help you get a leg up on the... | Read more »
Roterra Extreme - Great Escape is a pers...
Roterra Extreme – Great Escape has been described by developers Dig-It Games as a mini-sequel to their acclaimed title Roterra: Flip the Fairytale. It continues that game's tradition of messing with which way is up, tasking you with solving... | Read more »
Hearthstone: Battlegrounds open beta lau...
Remember earlier this year when auto battlers were the latest hotness? We had Auto Chess, DOTA Underlords, Chess Rush, and more all gunning for our attention. They all had their own reasons to play, but, at least from where I'm standing, most... | Read more »
The House of Da Vinci 2 gets a new gamep...
The House of Da Vinci launched all the way back in 2017. Now, developer Blue Brain Games is gearing up to deliver a second dose of The Room-inspired puzzling. Some fresh details have now emerged, alongside the game's first official trailer. [Read... | Read more »
Shoot 'em up action awaits in Battl...
BattleBrew Productions has just introduced another entry into its award winning, barrelpunk inspired, BattleSky Brigade series. Whilst its previous title BattleSky Brigade TapTap provided fans with idle town building gameplay, this time the... | Read more »

Price Scanner via MacPrices.net

Apple continues to offer 2017 13″ Dual-Core n...
Apple has Certified Refurbished 2017 13″ 2.3GHz Dual-Core non-Touch Bar MacBook Pros still available starting at $1019. An standard Apple one-year warranty is included with each model, outer cases... Read more
Save up to $120 on the new 16″ MacBook Pro at...
Apple’s resellers are starting to receive stock of new 16″ MacBook Pros, and the first set of sales & deals are now available: (1) Amazon 16″ MacBook Pros start on sale for $100-$116 off Apple’s... Read more
Apple Watch Series 3 models on sale at Amazon...
Amazon has Apple Watch Series 3 GPS models on sale for $30 off MSRP, starting at only $169. There prices are the lowest we’ve ever seen for these models from any Apple reseller. Choose Amazon as the... Read more
The ‘Mac Potpourri’ Mailbag: Edition #1- Info...
COMMENTARY: 11.20.19- Welcome to the inaugural edition of the “Mac Potpourri” Mailbag where we take a look at correspondence received from readers of this column from all over the world who write in... Read more
13″ 2.4GHz MacBook Pros available for up to $...
Apple has a full line of Certified Refurbished 2019 13″ 2.4GHz 4-Core Touch Bar MacBook Pros available starting at $1529 and up to $300 off MSRP. Apple’s one-year warranty is included, shipping is... Read more
New at T-Mobile: Switch to T-Mobile, and get...
T-Mobile is offering a free 64GB iPhone 8 for new customers who switch to T-Mobile and open a new line of service. Eligible trade-in required, and discount applied over a 24 month period. The fine... Read more
Xfinity Mobile’s Black Friday Apple savings:...
Take $250 off the purchase of any iPhone at Xfinity Mobile with a new line activation, and transfer of phone number to Xfinity Mobile, through December 8, 2019. This includes Apple’s new iPhone 11... Read more
2019 13″ 1.4GHz MacBook Pros available starti...
Apple has a full line of Certified Refurbished 2019 13″ 1.4GHz 4-Core Touch Bar MacBook Pros available starting at $1099 and up to $230 off MSRP. Apple’s one-year warranty is included, shipping is... Read more
Save up to $350 on a 21″ or 27″ iMac with the...
Apple has Certified Refurbished 2019 21″ & 27″ iMacs available starting at $929 and up to $350 off the cost of new models. Apple’s one-year warranty is standard, shipping is free, and each iMac... Read more
Early Holiday 2019 Sale: B&H again offers...
B&H Photo has 10.2″ iPads on sale again for $30 off Apple’s MSRP, starting at $299, as part of their early Holiday 2019 sale. Overnight shipping is free to many addresses in the US: – 10.2″ 32GB... Read more

Jobs Board

Best Buy *Apple* Computing Master - Best Bu...
**745516BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Store NUmber or Department:** 001101-Manhattan-Store **Job Read more
Best Buy *Apple* Computing Master - Best Bu...
**746655BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Store NUmber or Department:** 002518-Atlantic Center-Store **Job Description:** Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**747089BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Store NUmber or Department:** 000377-Prescott AZ-Store **Job Description:** At Read more
*Apple* Health Benefit Specialist - Call Cen...
Description ** Apple Health Benefit Specialist - Call Center (MAS 3/MACSC)** **Olympia, WA Multiple Positions** *The ideal candidate for this position will have Read more
Hair Stylist - *Apple* Blossom Mall - JCPen...
Hair Stylist - Apple Blossom Mall Location:Winchester, VA, United States- Apple Blossom Mall 1850 Apple Blossom Dr Job ID:1065040Salon Professionals Job Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.