{"id":614,"date":"2008-08-15T05:00:53","date_gmt":"2008-08-15T13:00:53","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/2008\/08\/15\/more-fun-with-microsoft-word-and-powershell\/"},"modified":"2008-08-15T05:00:53","modified_gmt":"2008-08-15T13:00:53","slug":"more-fun-with-microsoft-word-and-powershell","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2008\/08\/15\/more-fun-with-microsoft-word-and-powershell\/","title":{"rendered":"More fun with Microsoft Word and PowerShell"},"content":{"rendered":"

I needed a demonstration for one of my last online PowerShell classes on using COM objects in PowerShell. I took an old VBScript that used Microsoft Word to get document statistics such as word and page count and transformed it into PowerShell. I quickly realized I could flesh out the demo into a larger function that I can actually use. Given that I generate a lot of Word docs, being able to get some document statistics is helpful. So I created a function called Get-DocStatistic. Here’s the function:<\/p>\n

\n
\n
   1:<\/span> Function Get-DocStatistic {<\/pre>\n
   2:<\/span>  <\/pre>\n
   3:<\/span> BEGIN {<\/pre>\n
   4:<\/span>    $word=New-Object -com \"Word.Application\"<\/span><\/pre>\n
   5:<\/span>   }<\/pre>\n
   6:<\/span>  <\/pre>\n
   7:<\/span> PROCESS {<\/pre>\n
   8:<\/span>     $file=$_<\/pre>\n
   9:<\/span>          <\/pre>\n
  10:<\/span>     $doc=$word.documents.open($file.Fullname)<\/pre>\n
  11:<\/span>     Write-Progress -Activity \"Gathering document statistics\"<\/span> `<\/pre>\n
  12:<\/span>     -Status \"Analyzing $file\"<\/span> `<\/pre>\n
  13:<\/span>     -currentoperation \"Counting Words\"<\/span><\/pre>\n
  14:<\/span>     <\/pre>\n
  15:<\/span>     $words=$doc.ComputeStatistics(\"wdStatisticWords\"<\/span>)<\/pre>\n
  16:<\/span>     <\/pre>\n
  17:<\/span>     Write-Progress -Activity \"Gathering document statistics\"<\/span> `<\/pre>\n
  18:<\/span>     -Status \"Analyzing $file\"<\/span> `<\/pre>\n
  19:<\/span>     -currentoperation \"Counting lines\"<\/span><\/pre>\n
  20:<\/span>     $lines=$doc.ComputeStatistics(\"wdStatisticLines\"<\/span>)<\/pre>\n
  21:<\/span>     <\/pre>\n
  22:<\/span>     Write-Progress -Activity \"Gathering document statistics\"<\/span> `<\/pre>\n
  23:<\/span>     -Status \"Analyzing $file\"<\/span> `<\/pre>\n
  24:<\/span>     -currentoperation \"Counting paragraphs\"<\/span><\/pre>\n
  25:<\/span>     $para=$doc.ComputeStatistics(\"wdStatisticParagraphs\"<\/span>)<\/pre>\n
  26:<\/span>     <\/pre>\n
  27:<\/span>     Write-Progress -Activity \"Gathering document statistics\"<\/span> `<\/pre>\n
  28:<\/span>     -Status \"Analyzing $file\"<\/span> `<\/pre>\n
  29:<\/span>     -currentoperation \"Counting pages\"<\/span><\/pre>\n
  30:<\/span>     $pages=$doc.ComputeStatistics(\"wdStatisticPages\"<\/span>)<\/pre>\n
  31:<\/span>     <\/pre>\n
  32:<\/span>     #close document discarding any changes<\/span><\/pre>\n
  33:<\/span>     $doc.close([ref]$false)<\/pre>\n
  34:<\/span>     <\/pre>\n
  35:<\/span>     $obj=New-Object PSObject<\/pre>\n
  36:<\/span>     <\/pre>\n
  37:<\/span>     $obj | Add-Member -MemberType NoteProperty -Name \"Document\"<\/span>  -Value $file<\/pre>\n
  38:<\/span>     $obj | Add-Member -MemberType NoteProperty -Name \"Directory\"<\/span> -Value $file.directoryname<\/pre>\n
  39:<\/span>     $obj | Add-Member -MemberType NoteProperty -Name \"Filename\"<\/span>  -Value $file.Name<\/pre>\n
  40:<\/span>     $obj | Add-Member -MemberType NoteProperty -Name \"Size\"<\/span>  -Value $file.length<\/pre>\n
  41:<\/span>     $obj | Add-Member -MemberType NoteProperty -Name \"Words\"<\/span> -Value $words<\/pre>\n
  42:<\/span>     $obj | Add-Member -MemberType NoteProperty -Name \"Lines\"<\/span> -Value $lines<\/pre>\n
  43:<\/span>     $obj | Add-Member -MemberType NoteProperty -Name \"Paragraphs\"<\/span> -Value $para<\/pre>\n
  44:<\/span>     $obj | Add-Member -MemberType NoteProperty -Name \"Pages\"<\/span> -Value $pages<\/pre>\n
  45:<\/span>     <\/pre>\n
  46:<\/span>     write $obj<\/pre>\n
  47:<\/span>        <\/pre>\n
  48:<\/span>     }<\/pre>\n
  49:<\/span>  <\/pre>\n
  50:<\/span> END {<\/pre>\n
  51:<\/span>      $word.Quit()<\/pre>\n
  52:<\/span>     }<\/pre>\n
  53:<\/span>  <\/pre>\n
  54:<\/span> }<\/pre>\n<\/div>\n<\/div>\n
The function uses Begin, Process and End scriptblocks so you can pipe objects to it. In the Begin script block I create the Word.Application COM object. I only need to do this once so using the Begin script block is perfect because any code here executes once before any pipelined objects are processed.<\/p>\n
In the Process script block I create new object for the Word document. This is also a COM object. You can pipe it to Get-Member to discover all of its properties and methods. One if its methods is ComputeStatistics(). This method takes a parameter indicating what statistic to compute. In VBScript I would have had to define a constant value for something like wdStatisticWords. But in PowerShell all I have to do is use the constant. PowerShell will get the correct constant value.<\/p>\n
Throughout the Process block I use Write-Progress to let me know what is happening. I have a lot of Word docs and piping them to Get-Docstatistic can take some time.<\/p>\n
After all the objects are processed the End script block runs where I quit and close Microsoft Word. Without this command I would have a Winword process running in the background. <\/p>\n
Here are some examples on how you might use it. <\/p>\n
PS C:\\> dir c:\\test\\dns.docx  | Get-DocStatistic<\/font><\/p>\n
PS C:\\test> dir c:\\test\\dns.docx | get-docstatistic <\/font><\/p>\n
Document   : C:\\test\\dns.docx
Directory  : C:\\test
Filename   : dns.docx
Size       : 23606
Words      : 1952
Lines      : 510
Paragraphs : 422
Pages      : 10<\/font><\/p>\n
PS C:\\> $stats=dir “$env:userprofile\\documents\\*” -include *.doc,*.docx -recurse| Get-DocStatistic<\/font><\/p>\n
PS C:\\> $stats | Measure-Object pages -Sum <\/font><\/p>\n
PS C:\\scripts\\PoSH> $stats | Measure-Object pages -Sum <\/font><\/p>\n
Count    : 319
Average  :
Sum      : 7615
Maximum  :
Minimum  :
Property : Pages<\/font><\/p>\n
I don’t know if you’ll find as much a need for this as I do, but you hopefully you’ve see how easy it is to use COM objects in PowerShell.<\/p>\n
\n
Download  Get-Docstatistic<\/a><\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"
I needed a demonstration for one of my last online PowerShell classes on using COM objects in PowerShell. I took an old VBScript that used Microsoft Word to get document statistics such as word and page count and transformed it into PowerShell. I quickly realized I could flesh out the demo into a larger function that I can actually use. Given that I generate a lot of Word docs, being able to get some document statistics is helpful. So I created a function called Get-DocStatistic.<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[25],"tags":[223,65,61,198,241,242,82,28,151,57,275],"class_list":["post-614","post","type-post","status-publish","format-standard","hentry","category-windows-powershell","tag-add-member","tag-automation","tag-com","tag-function","tag-microsoft-word","tag-new-object","tag-objects","tag-powershell","tag-scriptblock","tag-scripting","tag-write-progress"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/614","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=614"}],"version-history":[{"count":0,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/614\/revisions"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=614"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=614"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=614"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}