Summary<\/b>: Microsoft Scripting Guy, Ed Wilson, talks about using Windows PowerShell to find specific built-in properties from Word documents.<\/p>\n
Microsoft Scripting Guy, Ed Wilson, is here. Well the script for today took a bit of work … actually it took quite a bit of work. The script does the following:<\/p>\n
Today’s script is similar to the Find All Word Documents that Contain a Specific Phrase<\/a> <\/i>script from yesterday, so reviewing that posting would be a good thing to do. This script also accomplishes a few of the things I wanted to do in yesterday’s script that I did not get a chance to do—namely, I return a custom object that contains the built-in properties I choose. This is a great benefit because it permits further analysis and processing of the data—and it would even permit export to a CSV file if I wish.<\/p>\n It is very difficult to work with Word document properties, and I have written several blogs about this<\/a>. You should refer to those blogs for additional information. The first thing I do is create a couple of command-line parameters. This permits changing the path to search, as well as modifying the include<\/b> <\/i>filter that is used by the Get-ChildItem<\/b> cmdlet. Next, I create the Word.Application<\/b> object and set it to be invisible. Next, I need to create BindingFlags<\/b> and WdSaveOptions<\/b>. The reason for creating WdSaveOptions<\/b> is to keep Word from modifying the last save option on the Word files. Finally, I obtain a collection of fileinfo<\/b> objects and store the returned objects in the $docs<\/b> variable. This portion of the script is shown here.<\/p>\n Param(<\/p>\n $path = “C:fso”,<\/p>\n [array]$include = @(“HSG*.docx”,”WES*.docx”))<\/p>\n $AryProperties = “Title”,”Author”,”Keywords”, “Number of words”, “Number of pages”<\/p>\n $application = New-Object -ComObject word.application<\/p>\n $application.Visible = $false<\/p>\n $binding = “System.Reflection.BindingFlags” -as [type]<\/p>\n [ref]$SaveOption = “microsoft.office.interop.word.WdSaveOptions” -as [type]<\/p>\n $docs = Get-childitem -path $Path -Recurse -Include $include <\/p>\n Now I need to walk through the collection of documents. I use the foreach<\/b> <\/i>statement. Inside the foreach<\/b> <\/i>loop, I open each document,and return the BuiltInDocumentProperties<\/b> collection. I also create a hash table that I will use to create the custom object later in the script. This portion of the code is shown here.<\/p>\n Foreach($doc in $docs)<\/p>\n {<\/p>\n $document = $application.documents.open($doc.fullname)<\/p>\n $BuiltinProperties = $document.BuiltInDocumentProperties<\/p>\n $objHash = @{“Path”=$doc.FullName}<\/p>\n It is time to work through the array of built in properties that I selected earlier. To do this, once again I use a foreach<\/b> <\/i>statement. I use Try<\/b> when attempting to access each built-in property because an error generates if the property contains no value. I already know the name of the property that I desire to obtain; therefore, I use it directly when obtaining the value of the property. Both the name and the value of the built-in document properties are assigned to the hash table as a keyvalue pair. If an error occurs, I print a message via Write-Host<\/b> that the value was not found. I use Write-Host<\/b> for this so I can specify the color (blue). The code is shown here.<\/p>\n foreach($p in $AryProperties)<\/p>\n {Try<\/p>\n {<\/p>\n $pn = [System.__ComObject].invokemember(“item”,$binding::GetProperty,$null,$BuiltinProperties,$p)<\/p>\n $value = [System.__ComObject].invokemember(“value”,$binding::GetProperty,$null,$pn,$null)<\/p>\n $objHash.Add($p,$value) }<\/p>\n Catch [system.exception]<\/p>\n { write-host -foreground blue “Value not found for $p” } <\/p>\n I then create a new custom PSObject<\/b> and use the hash table for the properties of that object. I display that object, and close the Word document without saving any changes. Finally, I release the document object and the BuiltInProperties<\/b> object, and I continue to loop through the collection of documents. This code is shown here.<\/p>\n $docProperties = New-Object psobject -Property $objHash<\/p>\n $docProperties<\/p>\n $document.close([ref]$saveOption::wdDoNotSaveChanges)<\/p>\n [System.Runtime.InteropServices.Marshal]::ReleaseComObject($BuiltinProperties) | Out-Null<\/p>\n [System.Runtime.InteropServices.Marshal]::ReleaseComObject($document) | Out-Null<\/p>\n Remove-Variable -Name document, BuiltinProperties<\/p>\n }<\/p>\n When I have completed processing the collection of documents, I release the Word.Application<\/b> COM object and call garbage collection. This code is shown here.<\/p>\n $application.quit()<\/p>\n [System.Runtime.InteropServices.Marshal]::ReleaseComObject($application) | Out-Null<\/p>\n Remove-Variable -Name application<\/p>\n [gc]::collect()<\/p>\n [gc]::WaitForPendingFinalizers() <\/p>\n One reason for returning an object is that it allows for grouping, sorting, and for further processing. I could have written everything in a function, but it works just as well as a script. For example, when I run the script, it returns the following objects.<\/p>\n PS C:> C:dataScriptingGuys2012HSG_7_30_12Get-SpecificDocumentProperties.ps1<\/p>\n Path : C:fsoHSG-7-23-12.docx<\/p>\n Number of words : 1398<\/p>\n Number of pages : 4<\/p>\n Author : edwils<\/p>\n Keywords :<\/p>\n Title :<\/p>\n <\/p>\n Path : C:fsoHSG-7-24-12.docx<\/p>\n Number of words : 1035<\/p>\n Number of pages : 4<\/p>\n Author : edwils<\/p>\n Keywords : guest blogger, powershell<\/p>\n Title : <\/p>\n Because the objects return from the script, I can search the output and find only documents that contain the word “guest blogger” as shown here.<\/p>\n PS C:> C:dataScriptingGuys2012HSG_7_30_12Get-SpecificDocumentProperties.ps1 | where keywords -match “guest blogger”<\/p>\n <\/p>\n Path : C:fsoHSG-7-24-12.docx<\/p>\n Number of words : 1035<\/p>\n Number of pages : 4<\/p>\n Author : edwils<\/p>\n Keywords : guest blogger, powershell<\/p>\n Title : <\/p>\n It is even possible to modify the way the output appears and to split only the file name from the remainder of the path. This is shown here.<\/p>\n PS C:> C:dataScriptingGuys2012HSG_7_30_12Get-SpecificDocumentProperties.ps1 | sort “number of words” -Descending | select @{LABEL=”file”;EXPRESSION={split-path $_.path -Leaf}}, “number of words”, author, keywords | ft -AutoSize<\/p>\n <\/p>\n file Number of words Author Keywords <\/p>\n —- ————— —— ——– <\/p>\n HSG-7-23-12.docx 1398 edwils <\/p>\n HSG-7-27-12.docx 1208 edwils <\/p>\n HSG-8-2-11.docx 1206 edwils <\/p>\n hsg-9-28-11.docx 1131 edwils <\/p>\n HSG-7-24-12.docx 1035 edwils guest blogger, powershell<\/p>\n HSG-8-1-11.docx 963 edwils <\/p>\n HSG-7-25-12.docx 882 edwils <\/p>\n HSG-7-26-12.docx 848 edwils <\/p>\n <\/p>\n PS C:> <\/p>\n The complete Get-SpecificDocumentProperties.ps1 script<\/a> is on the Scripting Guys Script Repository. <\/p>\n Join me tomorrow when I will talk about programmatically assigning values to the Word documents.<\/p>\n I invite you to follow me on Twitter<\/a> and Facebook<\/a>. If you have any questions, send email to me at scripter@microsoft.com<\/a>, or post your questions on the Official Scripting Guys Forum<\/a>. See you tomorrow. Until then, peace.<\/p>\n Ed Wilson, Microsoft Scripting Guy<\/b><\/p><\/p>\n","protected":false},"excerpt":{"rendered":" Summary: Microsoft Scripting Guy, Ed Wilson, talks about using Windows PowerShell to find specific built-in properties from Word documents. Microsoft Scripting Guy, Ed Wilson, is here. Well the script for today took a bit of work … actually it took quite a bit of work. The script does the following: Searches a specific folder for […]<\/p>\n","protected":false},"author":596,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[359,3,45,360],"class_list":["post-8511","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-microsoft-office","tag-scripting-guy","tag-windows-powershell","tag-word"],"acf":[],"blog_post_summary":" Summary: Microsoft Scripting Guy, Ed Wilson, talks about using Windows PowerShell to find specific built-in properties from Word documents. Microsoft Scripting Guy, Ed Wilson, is here. Well the script for today took a bit of work … actually it took quite a bit of work. The script does the following: Searches a specific folder for […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/8511","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\/596"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=8511"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/8511\/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=8511"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=8511"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=8511"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}Working with Word Document properties<\/h2>\n
Using the returned objects<\/h2>\n