{"id":52273,"date":"2009-10-12T00:01:00","date_gmt":"2009-10-12T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2009\/10\/12\/hey-scripting-guy-how-do-i-count-the-number-of-words-in-a-group-of-office-word-documents\/"},"modified":"2009-10-12T00:01:00","modified_gmt":"2009-10-12T00:01:00","slug":"hey-scripting-guy-how-do-i-count-the-number-of-words-in-a-group-of-office-word-documents","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/hey-scripting-guy-how-do-i-count-the-number-of-words-in-a-group-of-office-word-documents\/","title":{"rendered":"Hey, Scripting Guy! How Do I Count the Number of Words in a Group of Office Word Documents?"},"content":{"rendered":"

\"Bookmark<\/a> <\/p>\n

\"Hey,<\/p>\n

Hey, Scripting Guy! I have a folder that contains a number of Microsoft Word documents that are all related to a specific project. I need to know the number of words in all of those Word documents. This is because the project is billable based upon the number of words. In the past, I used Explorer to open each file to get the word count of each Microsoft Word document. I then added them up with calculator. This was a time-consuming and tedious process. But when you are dealing with money, you do not mind taking a little extra effort. The problem is this new project is a very large project with hundreds of document files. To make matters worse, the project folder also has Microsoft Excel files, Microsoft Project files, bitmap images, and assorted Notepad text files. It is a mess, and I do not want to waste several hours on this if I can help it. Can you help me please?<\/p>\n

<<\/p>\n

p class=”MsoNormal” style=”margin: 0in 0in 8pt;”>– WS<\/p>\n

\"Hey,<\/p>\n

Hello WS,<\/p>\n

Microsoft Scripting Guy Ed Wilson here. You know, contrary to popular belief, Scripting Guys are not paid by the word. A long time ago when I wrote for a newspaper, I was paid by the word. I have also been paid by the word for magazine articles, so your question is not something that is completely off the wall. In addition to being paid by the word, when I write a proposal for a new book project, I must supply an estimated word count for the new book. This is used to determine estimated page count, which the book publisher can use as a guide for setting the cost of new book. When writing the book, if my chapters are tending to be either too long or too short, my developmental editor will start to get excited.<\/p>\n

Currently, I am not too excited. I am sipping a cup of English breakfast tea with a cinnamon stick in it and a bit of lemon grass. I am listening to “Travelin’ Blues” by Dave Brubeck<\/span><\/a> on my Zune.<\/p>\n

Truth in Blogging notice to comply with recent USA FTC requirements<\/a>: I purchased my Zune using my own money. It was not a gift, a bribe, or a prize for blogging about the device. I also purchased the Scripting Wife’s Zune as well. I bought both of these devices because they are cool!<\/p>\n

The grass outside is damp from the evening’s rain, and patches of fog lounge on the lawn like deer near a stream in the deep woods. While listening to “Linus and Lucy,” also by Dave Brubeck, I wrote the CountWordsInWord.ps1 script seen here.<\/p>\n

CountWordsInWord.ps1<\/strong><\/p>\n

Function Set-Variables
{
 <\/span>$folderpath = “c:fso*”
 <\/span>$fileTypes = “*.docx”,”*doc”
 <\/span>$confirmConversion = $false
 <\/span>$readOnly = $true
 <\/span>$addToRecent = $false
 <\/span>$passwordDocument = “password”
 <\/span>$wordCountFile = “C:fsowordCount.csv”
 <\/span>$numberOfWords = 0
 <\/span>Set-OutPutFile
} #end Set-Variables<\/p>\n

Function Set-OutputFile
{
 <\/span>if(Test-Path -path $wordCountFile)
   <\/span>{ Remove-Item -path $wordCountFile }
 <\/span>“name,wordCount” >> $wordCountFile
 <\/span>Get-WordDocuments
} #end Set-OutputFile<\/p>\n

Function Get-WordDocuments
{
  <\/span>“Counting Words in Word Docs in $folderPath”
 <\/span>$word = New-Object -ComObject word.application
 <\/span>$word.visible = $false
 <\/span>Get-ChildItem -path $folderpath -include $fileTypes |
 <\/span>foreach-object `
  <\/span>{
   <\/span>$path =  <\/span>($_.fullname).substring(0,($_.FullName).lastindexOf(“.”))
   <\/span>$doc = $word.documents.open($_.fullname, $confirmConversion, $readOnly,
   <\/span>$addToRecent,   <\/span>$passwordDocument)
   <\/span>“  <\/span>$($_.name), $($doc.words.count)”  <\/span>>> $wordCountFile
   <\/span>$doc.close()
  <\/span>} #end Foreach-Object
 <\/span>$word.Quit()
 <\/span>Get-WordCount
} #end Get-WordDocuments<\/p>\n

Function Get-WordCount
{
 <\/span>$wdcsv = import-csv -path $wordCountFile
 <\/span>for ($i = 0 ; $i -le $wdcsv.length -1 ; $i++)
 <\/span>{
  <\/span>$numberOfWords += [int32]$wdcsv[$i].wordCount
 <\/span>}
 <\/span>$numberOfWords
} #end Get-WordCount<\/p>\n

# *** Entry Point to Script ***<\/p>\n

Set-Variables<\/p>\n

<\/span><\/span><\/span><\/p>\n

The CountWordsInWord.ps1 script contains a series of functions, each of which calls another function until the word count report is produced. This is not done to promote code reuse (which is one reason for writing functions), but to make the script easier to read and to understand (another reason for writing functions). You will notice the script is a bit complicated. If a similar script were written using VBScript, it would not be significantly different. The main advantage of using Windows PowerShell for this script is that the Get-ChildItem<\/b> cmdlet is easier to use than the FileSystemObject<\/b>. We have a few other advantages due to the more compact syntax of Windows PowerShell over VBScript. The complexity of the script is due to using the Microsoft Word automation objects to access the word count of the Word documents.<\/p>\n

The first function in the CountWordsInWord.ps1 script is called Set-Variables<\/b>. As the name implies, it sets the values of variables that will be used in the script. A variable table is a good way to keep track of a large number of variables in a script. The variable table for the CountWordsInWord.ps1 script is seen in Table 1.<\/p>\n

Table 1  <\/span>Variable Table<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n
\n

Variable<\/p>\n

<\/strong><\/p>\n<\/td>\n

\n

Initial value<\/p>\n

<\/b><\/p>\n<\/td>\n

\n

Use in script<\/p>\n

<\/b><\/p>\n<\/td>\n<\/tr>\n

\n

$folderpath<\/p>\n<\/td>\n

\n

 <\/span>“c:fso*”<\/p>\n<\/td>\n

\n

Path to search for Word documents.<\/p>\n<\/td>\n<\/tr>\n

\n

$fileTypes<\/p>\n<\/td>\n

\n

 <\/span>“*.docx”,”*doc”<\/p>\n<\/td>\n

\n

Two types of Word documents to look for.<\/p>\n<\/td>\n<\/tr>\n

\n

$confirmConversion<\/p>\n<\/td>\n

\n

 <\/span>$false<\/p>\n<\/td>\n

\n

Used by Open method of Word. Do not prompt if conversion is needed.<\/p>\n<\/td>\n<\/tr>\n

\n

$readOnly<\/p>\n<\/td>\n

\n

 <\/span>$true<\/p>\n<\/td>\n

\n

Used by Open method of Word. Open document read-only.<\/p>\n<\/td>\n<\/tr>\n

\n

$addToRecent<\/p>\n<\/td>\n

\n

 <\/span>$false<\/p>\n<\/td>\n

\n

Used by Open method of Word. Do not add to recently used.<\/p>\n<\/td>\n<\/tr>\n

\n

$passwordDocument<\/p>\n<\/td>\n

\n

 <\/span>“password”<\/p>\n<\/td>\n

\n

Used by Open method of Word. The password to use for any password protected documents.<\/p>\n<\/td>\n<\/tr>\n

\n

$wordCountFile<\/p>\n<\/td>\n

\n

 <\/span>“C:fsowordCount.csv”<\/p>\n<\/td>\n

\n

The path for the output file that holds file names and word count.<\/p>\n<\/td>\n<\/tr>\n

\n

$numberOfWords<\/p>\n<\/td>\n

\n

 <\/span>0<\/p>\n<\/td>\n

\n

Used to hold the total number of words for all Word documents.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

After all of the variables have been initialized, the Set-Variable<\/b> function calls the Set-OutPutFile<\/b> function. By calling the Set-OutPutFile<\/b> function from within the Set-Variables<\/b> function, all of the variables will be made available to the Set-OutPutFile<\/b> function. This is because the Set-Variables<\/b> function will become the parent namespace for the Set-OutPutFile<\/b> function. All variables that are created in the Set-Variables<\/b> namespace will be available within the Set-Variables<\/b> namespace, as well as child namespaces. If, of course, the variables were marked as private, they would only be available within the Set-Variables<\/b> function. WS, you will need to modify the value of the $folderpath<\/b> variable and the $wordCountFile<\/b> variable to match your computer. The Set-Variables<\/b> function is seen here:<\/p>\n

Function Set-Variables
{
 <\/span>$folderpath = “c:fso*”
 <\/span>$fileTypes = “*.docx”,”*doc”
 <\/span>$confirmConversion = $false
 <\/span>$readOnly = $true
 <\/span>$addToRecent = $false
 <\/span>$passwordDocument = “password”
 <\/span>$wordCountFile = “C:fsowordCount.csv”
 <\/span>$numberOfWords = 0
 <\/span>Set-OutputFile
} #end Set-Variables<\/p>\n

<\/span><\/span><\/p>\n

In the Set-OutputFile<\/b> function, the path to the $wordCountFile<\/b> file is checked. If the file exists, it is deleted. A new file is then created by using the redirection arrows. The header for the wordCount.csv file is name<\/b> and wordCount<\/b>. The header for the file is written at the same time that the file is created. After creating the wordCount.csv file, the Set-OutputFile<\/b> function calls the Get-WordDocuments<\/b> function. The Set-OutputFile<\/b> function is shown here:<\/p>\n

Function Set-OutputFile
{
 <\/span>if(Test-Path -path $wordCountFile)
   <\/span>{ Remove-Item -path $wordCountFile }
 <\/span>“name,wordCount” >> $wordCountFile
 <\/span>Get-WordDocuments
} #end Set-OutputFile<\/p>\n

<\/span><\/span><\/p>\n

The Get-WordDocuments<\/b> function is the function that interacts with the Word automation object model. The first thing the Get-WordDocuments<\/b> function does after displaying a status message on the Windows PowerShell console is create an instance of the word.application<\/b> object. This object is the main object you use when working with Microsoft Word. The word.application<\/b> object has a number of methods and properties available to it, which are all documented on MSDN<\/span><\/a>. The visible<\/b> property of the application object is set to $false<\/b> because there is no need to pop up a hundred or more Microsoft Word documents when all you want to do is to obtain the word count from the document. This part of the Get-WordDocuments<\/b> function is seen here:<\/p>\n

 <\/span>“Counting Words in Word Docs in $folderPath”
 <\/span>$word = New-Object -ComObject word.application
 <\/span>$word.visible = $false<\/p>\n

<\/span><\/span><\/p>\n

You can use the Get-ChildItem<\/b> cmdlet from Windows PowerShell to obtain a listing of all of the Microsoft Word documents in the specified folder. Each of the found files is piped to the ForEach-Object<\/b> cmdlet where the path to file is obtained. This is seen here:<\/p>\n

Get-ChildItem -path $folderpath -include $fileTypes |
 <\/span>foreach-object `
  <\/span>{
   <\/span>$path =  <\/span>($_.fullname).substring(0,($_.FullName).lastindexOf(“.”))<\/p>\n

<\/span><\/span><\/p>\n

After the path to the Microsoft Word document has been retrieved, you can use it with the open<\/b> method from the documents<\/b> collection. The documents collection object<\/span><\/a> contains the open method<\/span><\/a> and is retrieved by querying the documents<\/b> property from the word.application<\/b> object. After the document is open, the <\/span><\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

Hey, Scripting Guy! I have a folder that contains a number of Microsoft Word documents that are all related to a specific project. I need to know the number of words in all of those Word documents. This is because the project is billable based upon the number of words. In the past, I used […]<\/p>\n","protected":false},"author":595,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[84,49,3,45,395],"class_list":["post-52273","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-microsoft-word","tag-office","tag-scripting-guy","tag-windows-powershell","tag-word-application"],"acf":[],"blog_post_summary":"

Hey, Scripting Guy! I have a folder that contains a number of Microsoft Word documents that are all related to a specific project. I need to know the number of words in all of those Word documents. This is because the project is billable based upon the number of words. In the past, I used […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/52273","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/595"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=52273"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/52273\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=52273"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=52273"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=52273"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}