{"id":356,"date":"2009-09-18T14:13:00","date_gmt":"2009-09-18T18:13:00","guid":{"rendered":"http:\/\/jdhitsolutions.com\/blog\/2009\/09\/out-msword-revised\/"},"modified":"2009-09-18T14:13:00","modified_gmt":"2009-09-18T18:13:00","slug":"out-msword-revised","status":"publish","type":"post","link":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/","title":{"rendered":"Out-MSWord Revised"},"content":{"rendered":"

This summer I wrote about a function I developed called Out-MSWord. The function was discussed in my Practical PowerShell column which was published in the free e-Journal Windows Administration in RealTime<\/a> put out by RealTime Publishers<\/a>. The original was published in Issue #17 if you are interested. The function accepted pipelined input and created a Microsoft Word document. Naturally, you need to have Microsoft Word installed in order for this to work.<\/p>\n

PS C:\\> get-service | out-MSWord<\/font><\/p>\n

The function accepted a number of parameters so you could control font name, size, color, append, and more. The function was written for PowerShell v1.0 but also worked on PowerShell v2.0. However, I was revisiting the function and realize there were places I could tweak, such as adding additional error handing. I also realized that if rewrote this for PowerShell v2.0, I could create an advanced function and take advantage of cmdletbinding, advanced parameters and help.<\/p>\n

\n
\n
   1:<\/span> Function Out-MSWord {<\/pre>\n
<\/p>\n
   2:<\/span> #requires -version 2.0<\/span><\/pre>\n
<\/p>\n
   3:<\/span>  <\/pre>\n
<\/p>\n
   4:<\/span> <#<\/span><\/pre>\n
<\/p>\n
   5:<\/span> .Synopsis<\/pre>\n
<\/p>\n
   6:<\/span>     Accept pipelined input from a PowerShell expression and write output to a Microsoft Word document.<\/pre>\n
<\/p>\n
   7:<\/span> .Description<\/pre>\n
<\/p>\n
   8:<\/span>     Pipe cmdlet output to this function<\/span> and create a MS Word document. You must have Microsoft Word installed. <\/pre>\n
<\/p>\n
   9:<\/span>     This has been tested with Microsoft Word 2007. If you don't specify a filename, Microsoft Word will open <\/pre>\n
<\/p>\n
  10:<\/span>     upon completion and you can manually save the document. You can specify a filename along with optional <\/pre>\n
<\/p>\n
  11:<\/span>     parameters -append or -noclobber. <\/pre>\n
<\/p>\n
  12:<\/span>     <\/pre>\n
<\/p>\n
  13:<\/span>     The -noclobber parameter will not overwrite any existing files. Otherwise, if you specify a file and it <\/pre>\n
<\/p>\n
  14:<\/span>     already exists, it will be overwritten.<\/pre>\n
<\/p>\n
  15:<\/span>  <\/pre>\n
<\/p>\n
  16:<\/span>     The -Tee parameter will write piped input to the console as well as send it to the Word file.<\/pre>\n
<\/p>\n
  17:<\/span>     <\/pre>\n
<\/p>\n
  18:<\/span>     You can specify font size, name and color for the document body and footer. The defaults are 8pt Consolas. <\/pre>\n
<\/p>\n
  19:<\/span>     You will get best results using a fixed width font like Courier New or Lucida Console. Page numbering is <\/pre>\n
<\/p>\n
  20:<\/span>     automatically defined for the lower right corner of each page. If you don'<\/span>t specify a footer it defaults to <\/pre>\n
<\/p>\n
  21:<\/span>     Printed [datetime].<\/pre>\n
<\/p>\n
  22:<\/span>  <\/pre>\n
<\/p>\n
  23:<\/span> .Parameter Path<\/pre>\n
<\/p>\n
  24:<\/span>     The path and filename for<\/span> the new Microsoft Word document.<\/pre>\n
<\/p>\n
  25:<\/span> .Parameter InputObject<\/pre>\n
<\/p>\n
  26:<\/span>     Pipelined objects passed to this function<\/span>.<\/pre>\n
<\/p>\n
  27:<\/span> .Parameter Tee<\/pre>\n
<\/p>\n
  28:<\/span>     Display objects in<\/span> the console and write to the Word document.<\/pre>\n
<\/p>\n
  29:<\/span> .Parameter Append<\/pre>\n
<\/p>\n
  30:<\/span>     Append data to the Microsoft Word document<\/pre>\n
<\/p>\n
  31:<\/span> .Parameter NoClobber<\/pre>\n
<\/p>\n
  32:<\/span>     Don't overwrite the Microsoft Word document if it already exists.<\/pre>\n
<\/p>\n
  33:<\/span> .Parameter Font<\/pre>\n
<\/p>\n
  34:<\/span>     Font name to use in the document body. Default is Consolas.<\/pre>\n
<\/p>\n
  35:<\/span> .Parameter FontSize<\/pre>\n
<\/p>\n
  36:<\/span>     Font size to use in the document body. Default is 8. This parameter has an alias of Size.<\/pre>\n
<\/p>\n
  37:<\/span> .Parameter FontColor<\/pre>\n
<\/p>\n
  38:<\/span>     Font color to use in the document body. Valid choices are Auto,Black,Blue,Green,Red,Teal,Violet, and Yellow. <\/pre>\n
<\/p>\n
  39:<\/span>     The default is Auto. This paramater has an alias of Color.<\/pre>\n
<\/p>\n
  40:<\/span> .Parameter FooterText<\/pre>\n
<\/p>\n
  41:<\/span>     Text to use for the document footer. The default is Printed [datetime]. This parameter has an alias<\/pre>\n
<\/p>\n
  42:<\/span>     of Footer.<\/pre>\n
<\/p>\n
  43:<\/span> .Parameter FooterFont<\/pre>\n
<\/p>\n
  44:<\/span>     Font to use for the document footer. Default is Consolas.<\/pre>\n
<\/p>\n
  45:<\/span> .Parameter FooterSize<\/pre>\n
<\/p>\n
  46:<\/span>     Font size to use for the document footer. Default is 8.<\/pre>\n
<\/p>\n
  47:<\/span>  <\/pre>\n
<\/p>\n
  48:<\/span> .Example<\/pre>\n
<\/p>\n
  49:<\/span>      get-service | where {$_.status -eq "running"} | Out-MSWord<\/pre>\n
<\/p>\n
  50:<\/span>     <\/pre>\n
<\/p>\n
  51:<\/span>     This will create a Microsoft Word document with a list of all running processes.<\/pre>\n
<\/p>\n
  52:<\/span> .Example<\/pre>\n
<\/p>\n
  53:<\/span>     gwmi win32_bios | ow -path "c:\\files\\my3.doc" -noclobber<\/pre>\n
<\/p>\n
  54:<\/span>  <\/pre>\n
<\/p>\n
  55:<\/span>     Save the output from Get-WMIObject for the Win32_Bios class to a file called c:\\files\\my3.doc. If the file <\/pre>\n
<\/p>\n
  56:<\/span>     already exists it will not be overwritten.<\/pre>\n
<\/p>\n
  57:<\/span> .Example<\/pre>\n
<\/p>\n
  58:<\/span>     get-eventlog -list | ow c:\\test\\log.docx -tee<\/pre>\n
<\/p>\n
  59:<\/span>     <\/pre>\n
<\/p>\n
  60:<\/span>     Take the outpout from Get-Eventlog and not only save it to the specified file but also display the results <\/pre>\n
<\/p>\n
  61:<\/span>     in the console. This example assumes you are using the alias ow for the Out-MSWord function.<\/pre>\n
<\/p>\n
  62:<\/span> .Example<\/pre>\n
<\/p>\n
  63:<\/span>     get-process | sort workingset -descending | where {$_.workingset -lt 100mb -and $_.workingset -gt 25mb} | ow c:\\files\\ps.doc -fontcolor yellow -font "Lucida Console" -fontsize 10.5 -append<\/pre>\n
<\/p>\n
  64:<\/span>     <\/pre>\n
<\/p>\n
  65:<\/span>     This expression will create a Word document of processes with a workingset of between 25MB and 100MB. The <\/pre>\n
<\/p>\n
  66:<\/span>     results will be appended to the file, ps.doc, written in a yellow Lucida Console 10.5 font. This example <\/pre>\n
<\/p>\n
  67:<\/span>     assumes you are using the ow alias for this function.<\/pre>\n
<\/p>\n
  68:<\/span> .Example<\/pre>\n
<\/p>\n
  69:<\/span>     @((gwmi win32_operatingsystem),(gwmi win32_bios),(gwmi win32_computersystem))  | ow -footertext ("{0} captured: {1}" -f $env:computername,(get-date))<\/pre>\n
<\/p>\n
  70:<\/span>  <\/pre>\n
<\/p>\n
  71:<\/span>     Take the output from the three Get-WMIObject expressions and write output to all of them to a Microsoft Word <\/pre>\n
<\/p>\n
  72:<\/span>     document. A custom footer will be included that shows the computername and the current datetime.<\/pre>\n
<\/p>\n
  73:<\/span> .Example<\/pre>\n
<\/p>\n
  74:<\/span>     $file="c:\\reports\\eventreport.doc"<\/pre>\n
<\/p>\n
  75:<\/span>     C:\\PS>"Eventlog report for $env:computername" | Out-MSWord $file -size 14<\/pre>\n
<\/p>\n
  76:<\/span>     C:\\PS>$events=get-eventlog System -newest 100 | group EntryType<\/pre>\n
<\/p>\n
  77:<\/span>     C:\\PS>for ($i=0;$i -lt $events.count;$i++) {<\/pre>\n
<\/p>\n
  78:<\/span>       switch ($events[$i].name) {<\/pre>\n
<\/p>\n
  79:<\/span>         "Information" {<\/pre>\n
<\/p>\n
  80:<\/span>               Out-MSWord $file -input "Information Events" -size 10 -append<\/pre>\n
<\/p>\n
  81:<\/span>               $events[$i].group | format-list TimeWritten,EventID,Source,Message | <\/pre>\n
<\/p>\n
  82:<\/span>               Out-MSWord $file -color Green -append <\/pre>\n
<\/p>\n
  83:<\/span>         }<\/pre>\n
<\/p>\n
  84:<\/span>         "SuccessAudit" {<\/pre>\n
<\/p>\n
  85:<\/span>               Out-MSWord $file -input "Success Audit Events" -size 10 -append<\/pre>\n
<\/p>\n
  86:<\/span>               $events[$i].group | format-list TimeWritten,EventID,Source,Message | <\/pre>\n
<\/p>\n
  87:<\/span>               Out-MSWord $file -color Green -append     <\/pre>\n
<\/p>\n
  88:<\/span>         }<\/pre>\n
<\/p>\n
  89:<\/span>         "Error" {<\/pre>\n
<\/p>\n
  90:<\/span>               Out-MSWord $file -input "Error Events" -size 10 -append<\/pre>\n
<\/p>\n
  91:<\/span>               $events[$i].group | format-list TimeWritten,EventID,Source,Message | <\/pre>\n
<\/p>\n
  92:<\/span>               Out-MSWord $file -color Red -append<\/pre>\n
<\/p>\n
  93:<\/span>         }<\/pre>\n
<\/p>\n
  94:<\/span>         "FailureAudit" {<\/pre>\n
<\/p>\n
  95:<\/span>               Out-MSWord $file -input "Failure Audit Events" -size 10 -append<\/pre>\n
<\/p>\n
  96:<\/span>               $events[$i].group | format-list TimeWritten,EventID,Source,Message | <\/pre>\n
<\/p>\n
  97:<\/span>               Out-MSWord $file -color Red -append <\/pre>\n
<\/p>\n
  98:<\/span>         }<\/pre>\n
<\/p>\n
  99:<\/span>         "Warning" {<\/pre>\n
<\/p>\n
 100:<\/span>               Out-MSWord $file -input "Warning Events" -size 10 -append<\/pre>\n
<\/p>\n
 101:<\/span>               $events[$i].group | format-list TimeWritten,EventID,Source,Message | <\/pre>\n
<\/p>\n
 102:<\/span>               Out-MSWord $file -color Yellow -append <\/pre>\n
<\/p>\n
 103:<\/span>          }<\/pre>\n
<\/p>\n
 104:<\/span>       } #end Switch<\/pre>\n
<\/p>\n
 105:<\/span>      } #end foreach<\/pre>\n
<\/p>\n
 106:<\/span>  <\/pre>\n
<\/p>\n
 107:<\/span>     In this example a formatted Microsoft Word document is created that list eventlog information for the local<\/pre>\n
<\/p>\n
 108:<\/span>     computer. Event log information is grouped by EntryType and then group is processed by using a For statement<\/pre>\n
<\/p>\n
 109:<\/span>     and a Switch construct. Event information is written to the Microsoft Word document in a corresponding font<\/pre>\n
<\/p>\n
 110:<\/span>     color. This example also shows how to insert text into the document by explicitly using the -InputObject<\/pre>\n
<\/p>\n
 111:<\/span>     parameter.<\/pre>\n
<\/p>\n
 112:<\/span>  <\/pre>\n
<\/p>\n
 113:<\/span> .Inputs<\/pre>\n
<\/p>\n
 114:<\/span>     Accepts objects as pipelined input.<\/pre>\n
<\/p>\n
 115:<\/span> .Outputs<\/pre>\n
<\/p>\n
 116:<\/span>     Microsoft Word document object  <\/pre>\n
<\/p>\n
 117:<\/span> .Link<\/pre>\n
<\/p>\n
 118:<\/span>    Out-Printer<\/pre>\n
<\/p>\n
 119:<\/span>    Out-File<\/pre>\n
<\/p>\n
 120:<\/span> .Notes<\/pre>\n
<\/p>\n
 121:<\/span>  NAME:      Out-MSWord<\/pre>\n
<\/p>\n
 122:<\/span>  VERSION:   2.0<\/pre>\n
<\/p>\n
 123:<\/span>  AUTHOR:    Jeffery Hicks<\/pre>\n
<\/p>\n
 124:<\/span>  LASTEDIT:  September 18, 2009<\/pre>\n
<\/p>\n
 125:<\/span>  <\/pre>\n
<\/p>\n
 126:<\/span>  <\/pre>\n
<\/p>\n
 127:<\/span> #><\/pre>\n
<\/p>\n
 128:<\/span>  <\/pre>\n
<\/p>\n
 129:<\/span> [CmdletBinding()]<\/pre>\n
<\/p>\n
 130:<\/span>  <\/pre>\n
<\/p>\n
 131:<\/span> #define the parameters<\/pre>\n
<\/p>\n
 132:<\/span> param (<\/pre>\n
<\/p>\n
 133:<\/span>     [Parameter(ValueFromPipeline=$False,Position=0,Mandatory=$False,HelpMessage="The filename and path for the saved Word document.")] <\/pre>\n
<\/p>\n
 134:<\/span>     [ValidateScript({Test-Path (split-path $_)})]<\/pre>\n
<\/p>\n
 135:<\/span>     [String]$Path,<\/pre>\n
<\/p>\n
 136:<\/span>     <\/pre>\n
<\/p>\n
 137:<\/span>     [Parameter(ValueFromPipeline=$True,Position=1,Mandatory=$True,HelpMessage="Pipelined input.")] <\/pre>\n
<\/p>\n
 138:<\/span>     [object[]]$InputObject,<\/pre>\n
<\/p>\n
 139:<\/span>  <\/pre>\n
<\/p>\n
 140:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False, HelpMessage="If specified, write to the console and the Word document.")] <\/pre>\n
<\/p>\n
 141:<\/span>     [switch]$Tee,<\/pre>\n
<\/p>\n
 142:<\/span>      <\/pre>\n
<\/p>\n
 143:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="If specified, append to output write to the Word document.")] <\/pre>\n
<\/p>\n
 144:<\/span>     [switch]$Append,<\/pre>\n
<\/p>\n
 145:<\/span>      <\/pre>\n
<\/p>\n
 146:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="If specified, don'<\/span>t overwrite the existing Word document specified by `$path.")] <\/pre>\n
<\/p>\n
 147:<\/span>     [switch]$NoClobber,<\/pre>\n
<\/p>\n
 148:<\/span>           <\/pre>\n
<\/p>\n
 149:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="<\/span>The font family to use for<\/span> the document body.")] <\/pre>\n
<\/p>\n
 150:<\/span>     [string]$Font="<\/span>Consolas",<\/pre>\n
<\/p>\n
 151:<\/span>       <\/pre>\n
<\/p>\n
 152:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="<\/span>The font size to use for<\/span> the document body.")] <\/pre>\n
<\/p>\n
 153:<\/span>     [Alias("<\/span>Size")]<\/pre>\n
<\/p>\n
 154:<\/span>     [double]$FontSize=8,      <\/pre>\n
<\/p>\n
 155:<\/span>       <\/pre>\n
<\/p>\n
 156:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="<\/span>The font color to use for<\/span> the document body.")]<\/pre>\n
<\/p>\n
 157:<\/span>     [ValidateSet("<\/span>Auto","<\/span>Black","<\/span>Blue","<\/span>Green","<\/span>Red","<\/span>Teal","<\/span>Violet","<\/span>Yellow")] <\/pre>\n
<\/p>\n
 158:<\/span>     [Alias("<\/span>Color")]<\/pre>\n
<\/p>\n
 159:<\/span>     [string]$FontColor="<\/span>Auto",<\/pre>\n
<\/p>\n
 160:<\/span>    <\/pre>\n
<\/p>\n
 161:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="<\/span>Text to use for<\/span> the footer.")] <\/pre>\n
<\/p>\n
 162:<\/span>     [Alias("<\/span>Footer")]<\/pre>\n
<\/p>\n
 163:<\/span>     [string]$FooterText=("<\/span>printed {0}" -f (Get-Date)),<\/pre>\n
<\/p>\n
 164:<\/span>     <\/pre>\n
<\/p>\n
 165:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="<\/span>The font to use for<\/span> the document footer.")] <\/pre>\n
<\/p>\n
 166:<\/span>     [string]$FooterFont="<\/span>Consolas",<\/pre>\n
<\/p>\n
 167:<\/span>     <\/pre>\n
<\/p>\n
 168:<\/span>     [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="<\/span>The font size to use for<\/span> the document footer.")] <\/pre>\n
<\/p>\n
 169:<\/span>     [double]$FooterSize=8<\/pre>\n
<\/p>\n
 170:<\/span>     <\/pre>\n
<\/p>\n
 171:<\/span>      ) #end param definition<\/pre>\n
<\/p>\n
 172:<\/span>  <\/pre>\n
<\/p>\n
 173:<\/span>         <\/pre>\n
<\/p>\n
 174:<\/span>  BEGIN{<\/pre>\n
<\/p>\n
 175:<\/span>  <\/pre>\n
<\/p>\n
 176:<\/span>   #define some MS Word variables<\/pre>\n
<\/p>\n
 177:<\/span>   $wdSeekMainDocument       = 0<\/pre>\n
<\/p>\n
 178:<\/span>   $wdSeekPrimaryFooter      = 4<\/pre>\n
<\/p>\n
 179:<\/span>   $wdSeekPrimaryHeader      = 1<\/pre>\n
<\/p>\n
 180:<\/span>   $wdAlignPageNumberCenter  =  1<\/pre>\n
<\/p>\n
 181:<\/span>   $wdAlignPageNumberInside  =  3<\/pre>\n
<\/p>\n
 182:<\/span>   $wdAlignPageNumberLeft    = 0<\/pre>\n
<\/p>\n
 183:<\/span>   $wdAlignPageNumberOutside = 4<\/pre>\n
<\/p>\n
 184:<\/span>   $wdAlignPageNumberRight   =  2<\/pre>\n
<\/p>\n
 185:<\/span>   $wdStory = 6   <\/pre>\n
<\/p>\n
 186:<\/span>   <\/pre>\n
<\/p>\n
 187:<\/span>   #define color values   <\/pre>\n
<\/p>\n
 188:<\/span>   $Auto   = 0<\/pre>\n
<\/p>\n
 189:<\/span>   $Black  =  1 <\/pre>\n
<\/p>\n
 190:<\/span>   $Blue   = 16711680 <\/pre>\n
<\/p>\n
 191:<\/span>   $Green  =  32768<\/pre>\n
<\/p>\n
 192:<\/span>   $Red    = 255<\/pre>\n
<\/p>\n
 193:<\/span>   $Teal   = 8421376<\/pre>\n
<\/p>\n
 194:<\/span>   $Violet = 8388736 <\/pre>\n
<\/p>\n
 195:<\/span>   $Yellow = 32896<\/pre>\n
<\/p>\n
 196:<\/span>   <\/pre>\n
<\/p>\n
 197:<\/span>   # #select font color<\/pre>\n
<\/p>\n
 198:<\/span>   switch ($fontcolor) {<\/pre>\n
<\/p>\n
 199:<\/span>     "<\/span>Auto"   {$color=$Auto}<\/pre>\n
<\/p>\n
 200:<\/span>     "<\/span>Black"  {$color=$Black }<\/pre>\n
<\/p>\n
 201:<\/span>     "<\/span>Blue"   {$color=$Blue }<\/pre>\n
<\/p>\n
 202:<\/span>     "<\/span>Green"  {$color=$Green }<\/pre>\n
<\/p>\n
 203:<\/span>     "<\/span>Red"    {$color=$Red }<\/pre>\n
<\/p>\n
 204:<\/span>     "<\/span>Teal"   {$color=$Teal }<\/pre>\n
<\/p>\n
 205:<\/span>     "<\/span>Violet" {$color=$Violet }<\/pre>\n
<\/p>\n
 206:<\/span>     "<\/span>Yellow" {$color=$Yellow }<\/pre>\n
<\/p>\n
 207:<\/span>     <\/pre>\n
<\/p>\n
 208:<\/span>     default {<\/pre>\n
<\/p>\n
 209:<\/span>      #this line should never get called since there is data validation with the fontcolor parameter, but I'll leave it in<\/pre>\n
<\/p>\n
 210:<\/span>      #just in case<\/pre>\n
<\/p>\n
 211:<\/span>       Write-Warning "<\/span>Invalid color choice: $fontcolor. Using Default. Valid color choices are: Black,Blue,Green,Red,Teal,Violet and Yellow."<\/pre>\n
<\/p>\n
 212:<\/span>       $color=$wdAuto}<\/pre>\n
<\/p>\n
 213:<\/span>   } #end Switch<\/pre>\n
<\/p>\n
 214:<\/span>    <\/pre>\n
<\/p>\n
 215:<\/span>   $ErrorActionPreference="<\/span>SilentlyContinue"<\/pre>\n
<\/p>\n
 216:<\/span>   <\/pre>\n
<\/p>\n
 217:<\/span>   Trap {<\/pre>\n
<\/p>\n
 218:<\/span>     Write-Warning "<\/span>There was an error. Make sure you have Microsoft Word installed and that you are specifying valid filename or path."<\/pre>\n
<\/p>\n
 219:<\/span>     Break<\/pre>\n
<\/p>\n
 220:<\/span>   } <\/pre>\n
<\/p>\n
 221:<\/span>   #create the MS Word COM object<\/pre>\n
<\/p>\n
 222:<\/span>   $word=New-Object -ComObject "<\/span>Word.Application" -ea Stop<\/pre>\n
<\/p>\n
 223:<\/span>   <\/pre>\n
<\/p>\n
 224:<\/span>    #get document if -append<\/pre>\n
<\/p>\n
 225:<\/span>   if ($append)<\/pre>\n
<\/p>\n
 226:<\/span>   {<\/pre>\n
<\/p>\n
 227:<\/span>     #verify file exists and if so, open it<\/pre>\n
<\/p>\n
 228:<\/span>     if (Test-Path $path)<\/pre>\n
<\/p>\n
 229:<\/span>     {<\/pre>\n
<\/p>\n
 230:<\/span>         $doc=$word.documents.open($path) <\/pre>\n
<\/p>\n
 231:<\/span>         $blnNewFile=$False<\/pre>\n
<\/p>\n
 232:<\/span>  <\/pre>\n
<\/p>\n
 233:<\/span>     }<\/pre>\n
<\/p>\n
 234:<\/span>     else<\/pre>\n
<\/p>\n
 235:<\/span>     {<\/pre>\n
<\/p>\n
 236:<\/span>         #you asked to append to a file that doesn't exist so create a new one<\/pre>\n
<\/p>\n
 237:<\/span>         $doc=$word.Documents.add()<\/pre>\n
<\/p>\n
 238:<\/span>         $blnNewfile=$True<\/pre>\n
<\/p>\n
 239:<\/span>     }<\/pre>\n
<\/p>\n
 240:<\/span>   }<\/pre>\n
<\/p>\n
 241:<\/span>   else <\/pre>\n
<\/p>\n
 242:<\/span>   {<\/pre>\n
<\/p>\n
 243:<\/span>     #create a new document<\/pre>\n
<\/p>\n
 244:<\/span>     $doc=$word.Documents.add()<\/pre>\n
<\/p>\n
 245:<\/span>     $blnNewFile=$True<\/pre>\n
<\/p>\n
 246:<\/span>  <\/pre>\n
<\/p>\n
 247:<\/span>    }<\/pre>\n
<\/p>\n
 248:<\/span>  <\/pre>\n
<\/p>\n
 249:<\/span>   $selection=$word.Selection    <\/pre>\n
<\/p>\n
 250:<\/span>   <\/pre>\n
<\/p>\n
 251:<\/span>   #get the footer<\/pre>\n
<\/p>\n
 252:<\/span>   $doc.ActiveWindow.ActivePane.view.SeekView=$wdSeekPrimaryFooter <\/pre>\n
<\/p>\n
 253:<\/span>  <\/pre>\n
<\/p>\n
 254:<\/span>   #set the footer<\/pre>\n
<\/p>\n
 255:<\/span>   $selection.HeaderFooter.Range.Text=$footerText<\/pre>\n
<\/p>\n
 256:<\/span>   <\/pre>\n
<\/p>\n
 257:<\/span>   #add page numbering<\/pre>\n
<\/p>\n
 258:<\/span>   $selection.HeaderFooter.PageNumbers.Add($wdAlignPageNumberRight) | Out-Null<\/pre>\n
<\/p>\n
 259:<\/span>  <\/pre>\n
<\/p>\n
 260:<\/span>   #get the footer and format font<\/pre>\n
<\/p>\n
 261:<\/span>   $footers=$doc.Sections.Last.Footers<\/pre>\n
<\/p>\n
 262:<\/span>  <\/pre>\n
<\/p>\n
 263:<\/span>   foreach ($footer in $footers) {<\/pre>\n
<\/p>\n
 264:<\/span>     if ($footer.exists) {<\/pre>\n
<\/p>\n
 265:<\/span>        $footer.range.font.name=$footerfont<\/pre>\n
<\/p>\n
 266:<\/span>        $footer.range.font.size=$footersize<\/pre>\n
<\/p>\n
 267:<\/span>        }<\/pre>\n
<\/p>\n
 268:<\/span>    } #end Foreach<\/pre>\n
<\/p>\n
 269:<\/span>  <\/pre>\n
<\/p>\n
 270:<\/span>    #return focus to main document<\/pre>\n
<\/p>\n
 271:<\/span>    $doc.ActiveWindow.ActivePane.view.SeekView=$wdSeekMainDocument<\/pre>\n
<\/p>\n
 272:<\/span>  <\/pre>\n
<\/p>\n
 273:<\/span>   #initialize an array to hold incoming objects <\/pre>\n
<\/p>\n
 274:<\/span>   $data=@()<\/pre>\n
<\/p>\n
 275:<\/span>   <\/pre>\n
<\/p>\n
 276:<\/span> } #end BEGIN scriptblock<\/pre>\n
<\/p>\n
 277:<\/span>  <\/pre>\n
<\/p>\n
 278:<\/span>  PROCESS {<\/pre>\n
<\/p>\n
 279:<\/span>    <\/pre>\n
<\/p>\n
 280:<\/span>    #save incoming objects to a variable<\/pre>\n
<\/p>\n
 281:<\/span>    if ($InputObject) {<\/pre>\n
<\/p>\n
 282:<\/span>      $data+=$InputObject<\/pre>\n
<\/p>\n
 283:<\/span>     }<\/pre>\n
<\/p>\n
 284:<\/span>    else<\/pre>\n
<\/p>\n
 285:<\/span>     {<\/pre>\n
<\/p>\n
 286:<\/span>        $data+=$_<\/pre>\n
<\/p>\n
 287:<\/span>     }<\/pre>\n
<\/p>\n
 288:<\/span>    <\/pre>\n
<\/p>\n
 289:<\/span>    #write piped object if -Tee<\/pre>\n
<\/p>\n
 290:<\/span>    if ($tee) <\/pre>\n
<\/p>\n
 291:<\/span>    {<\/pre>\n
<\/p>\n
 292:<\/span>     write $_<\/pre>\n
<\/p>\n
 293:<\/span>    }<\/pre>\n
<\/p>\n
 294:<\/span>     <\/pre>\n
<\/p>\n
 295:<\/span> } #end PROCESS scriptblock<\/pre>\n
<\/p>\n
 296:<\/span>  <\/pre>\n
<\/p>\n
 297:<\/span>  END {<\/pre>\n
<\/p>\n
 298:<\/span>  <\/pre>\n
<\/p>\n
 299:<\/span>    #convert data to string<\/pre>\n
<\/p>\n
 300:<\/span>     $text=$data | Out-String<\/pre>\n
<\/p>\n
 301:<\/span>  <\/pre>\n
<\/p>\n
 302:<\/span>    #only write to the file if $text exists<\/pre>\n
<\/p>\n
 303:<\/span>    if ($text) {<\/pre>\n
<\/p>\n
 304:<\/span>       if (!$blnNewFile)  #the file has been opened before<\/pre>\n
<\/p>\n
 305:<\/span>       { <\/pre>\n
<\/p>\n
 306:<\/span>         #jump to the end<\/pre>\n
<\/p>\n
 307:<\/span>         $selection.Endkey($wdStory) | Out-Null<\/pre>\n
<\/p>\n
 308:<\/span>         #insert blank lines<\/pre>\n
<\/p>\n
 309:<\/span>          $selection.TypeParagraph()<\/pre>\n
<\/p>\n
 310:<\/span>            $selection.TypeParagraph()<\/pre>\n
<\/p>\n
 311:<\/span>  <\/pre>\n
<\/p>\n
 312:<\/span>        } #end if !$blnNewFile<\/pre>\n
<\/p>\n
 313:<\/span>        <\/pre>\n
<\/p>\n
 314:<\/span>        #set font and paragraph settings  <\/pre>\n
<\/p>\n
 315:<\/span>        $selection.font.name=$font<\/pre>\n
<\/p>\n
 316:<\/span>        $selection.font.size=$fontsize<\/pre>\n
<\/p>\n
 317:<\/span>        $selection.font.color=$color<\/pre>\n
<\/p>\n
 318:<\/span>        $selection.paragraphFormat.SpaceBefore = 0<\/pre>\n
<\/p>\n
 319:<\/span>        $selection.paragraphFormat.SpaceAfter = 0<\/pre>\n
<\/p>\n
 320:<\/span>     <\/pre>\n
<\/p>\n
 321:<\/span>       #add the text to the document<\/pre>\n
<\/p>\n
 322:<\/span>       $selection.TypeText($text.Trim()) <\/pre>\n
<\/p>\n
 323:<\/span>       <\/pre>\n
<\/p>\n
 324:<\/span>       if ($path) <\/pre>\n
<\/p>\n
 325:<\/span>        {<\/pre>\n
<\/p>\n
 326:<\/span>         #don't overwrite if -noclobber was specified<\/pre>\n
<\/p>\n
 327:<\/span>         if ($noclobber) <\/pre>\n
<\/p>\n
 328:<\/span>         {<\/pre>\n
<\/p>\n
 329:<\/span>             #does file exist?<\/pre>\n
<\/p>\n
 330:<\/span>             if (Test-path $path) <\/pre>\n
<\/p>\n
 331:<\/span>             {<\/pre>\n
<\/p>\n
 332:<\/span>                 Write-Warning "<\/span>-NoClobber specified and $path exists"<\/pre>\n
<\/p>\n
 333:<\/span>                 #show the document so you can review and\/or save<\/pre>\n
<\/p>\n
 334:<\/span>                 $word.visible=$True<\/pre>\n
<\/p>\n
 335:<\/span>             } #end if item exists<\/pre>\n
<\/p>\n
 336:<\/span>             else <\/pre>\n
<\/p>\n
 337:<\/span>             {<\/pre>\n
<\/p>\n
 338:<\/span>                 $doc.SaveAs([ref]$path)<\/pre>\n
<\/p>\n
 339:<\/span>                 $word.quit()<\/pre>\n
<\/p>\n
 340:<\/span>             }<\/pre>\n
<\/p>\n
 341:<\/span>         } #end if $noclobber<\/pre>\n
<\/p>\n
 342:<\/span>         else<\/pre>\n
<\/p>\n
 343:<\/span>         {<\/pre>\n
<\/p>\n
 344:<\/span>             $doc.SaveAs([ref]$path)    <\/pre>\n
<\/p>\n
 345:<\/span>             $word.quit()<\/pre>\n
<\/p>\n
 346:<\/span>         }<\/pre>\n
<\/p>\n
 347:<\/span>        } #end if $path<\/pre>\n
<\/p>\n
 348:<\/span>        else #no filepath <\/pre>\n
<\/p>\n
 349:<\/span>        {<\/pre>\n
<\/p>\n
 350:<\/span>         #jump to the beginning of the document<\/pre>\n
<\/p>\n
 351:<\/span>         $selection.Homekey($wdStory) | Out-Null<\/pre>\n
<\/p>\n
 352:<\/span>         <\/pre>\n
<\/p>\n
 353:<\/span>         #show the document so you can review and\/or save<\/pre>\n
<\/p>\n
 354:<\/span>         $word.visible=$True<\/pre>\n
<\/p>\n
 355:<\/span>       }<\/pre>\n
<\/p>\n
 356:<\/span>   } #end if $text<\/pre>\n
<\/p>\n
 357:<\/span>   else<\/pre>\n
<\/p>\n
 358:<\/span>   {<\/pre>\n
<\/p>\n
 359:<\/span>     Write-Warning "<\/span>No data to write."<\/pre>\n
<\/p>\n
 360:<\/span>     #turn off alerts<\/span><\/pre>\n
<\/p>\n
 361:<\/span>     $word.displayAlerts=0<\/pre>\n
<\/p>\n
 362:<\/span>     #close without saving<\/span><\/pre>\n
<\/p>\n
 363:<\/span>     $doc.close([ref]$Word.WdSaveOptions.wdDoNotSaveChanges)<\/pre>\n
<\/p>\n
 364:<\/span>    <\/pre>\n
<\/p>\n
 365:<\/span>     #exit Microsoft Word<\/span><\/pre>\n
<\/p>\n
 366:<\/span>       $word.quit()<\/pre>\n
<\/p>\n
 367:<\/span>   }<\/pre>\n
<\/p>\n
 368:<\/span>  } #end END scriptblock<\/span><\/pre>\n
<\/p>\n
 369:<\/span>  <\/pre>\n
<\/p>\n
 370:<\/span> } #end Function<\/span><\/pre>\n
<\/p>\n
 371:<\/span>  <\/pre>\n
<\/p>\n
 372:<\/span> #create an alias <\/span><\/pre>\n
<\/p>\n
 373:<\/span> Set-Alias ow Out-MSWord<\/pre>\n
<\/p>\n
 374:<\/span> Get-Alias ow<\/pre>\n
<\/p>\n
 375:<\/span>  <\/pre>\n
<\/div>\n<\/div>\n
The information at the beginning is used by Get-Help<\/strong> to present help information just as you get with a cmdlet. That\u2019s the great thing in PowerShell v2; you can write an advanced \"help-out-msword\"<\/a>function that behaves essentially like a cmdlet.<\/p>\n
If you use \u2013full you will get full parameter help and a number of examples. I love that I can now incorparate documentation directly into the script or function.<\/p>\n
One thing I was able to accomplish was move some of the error handling to the parameters. In PowerShell v2 you can add validation tests. I\u2019ve added one to verify the specified path value is valid and one to check the value passed for the font color. In the first version I used a Switch construct to verify and write a warning message if an invalid value was passed., Now I can use parameter validation.<\/p>\n
\n
\n
   1:<\/span> [Parameter(ValueFromPipeline=$False,Mandatory=$False,HelpMessage="The font color to use for the document body."<\/span>)]<\/pre>\n
<\/p>\n
   2:<\/span>     [ValidateSet("Auto"<\/span>,"Black"<\/span>,"Blue"<\/span>,"Green"<\/span>,"Red"<\/span>,"Teal"<\/span>,"Violet"<\/span>,"Yellow"<\/span>)] <\/pre>\n
<\/p>\n
   3:<\/span>     [Alias("Color"<\/span>)]<\/pre>\n
<\/p>\n
   4:<\/span>     [string]$FontColor="Auto"<\/span>,<\/pre>\n
<\/div>\n<\/div>\n
You\u2019ll notice I also defined an alias for this parameter. Read the help topic about_Functions_Advanced_Parameters to learn more. <\/p>\n
My script file also defines an alias, ow, for the Out-MSWord function. Be sure to look at the help examples to see how to use this function.<\/p>\n
Download <\/p>\n
\n
Out-MSWordv2.txt<\/a><\/div>\n<\/div>\n
  and save it as a .ps1 file. You\u2019ll need to dot source the script to load it into your session or script or add it to your profile.<\/p>\n
If you find a use for this in a production environment, I\u2019d love to hear about it.<\/p>\n","protected":false},"excerpt":{"rendered":"
This summer I wrote about a function I developed called Out-MSWord. The function was discussed in my Practical PowerShell column which was published in the free e-Journal Windows Administration in RealTime put out by RealTime Publishers. The original was published in Issue #17 if you are interested. The function accepted pipelined input and created a Microsoft Word document. Naturally, you need to have Microsoft Word installed in order for this to work.<\/p>\n
PS C:\\> get-service | out-MSWord<\/p>\n
The function accepted a number of parameters so you could control font name, size, color, append, and more. The function was written for PowerShell v1.0 but also worked on PowerShell v2.0. However, I was revisiting the function and realize there were places I could tweak, such as adding additional error handing. I also realized that if rewrote this for PowerShell v2.0, I could create an advanced function and take advantage of cmdletbinding, advanced parameters and help.<\/p>\n","protected":false},"author":1,"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,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[72,75,48,8],"tags":[32,93,534,49,91,92],"class_list":["post-356","post","type-post","status-publish","format-standard","hentry","category-commandline","category-powershell-v2-0","category-realtime","category-scripting","tag-functions","tag-parameters","tag-powershell","tag-practical-powershell","tag-v2","tag-word"],"yoast_head":"\nOut-MSWord Revised • The Lonely Administrator<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Out-MSWord Revised • The Lonely Administrator\" \/>\n<meta property=\"og:description\" content=\"This summer I wrote about a function I developed called Out-MSWord. The function was discussed in my Practical PowerShell column which was published in the free e-Journal Windows Administration in RealTime put out by RealTime Publishers. The original was published in Issue #17 if you are interested. The function accepted pipelined input and created a Microsoft Word document. Naturally, you need to have Microsoft Word installed in order for this to work. PS C:> get-service | out-MSWord The function accepted a number of parameters so you could control font name, size, color, append, and more. The function was written for PowerShell v1.0 but also worked on PowerShell v2.0. However, I was revisiting the function and realize there were places I could tweak, such as adding additional error handing. I also realized that if rewrote this for PowerShell v2.0, I could create an advanced function and take advantage of cmdletbinding, advanced parameters and help.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/\" \/>\n<meta property=\"og:site_name\" content=\"The Lonely Administrator\" \/>\n<meta property=\"article:published_time\" content=\"2009-09-18T18:13:00+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/jdhitsolutions.com\/blog\/wp-content\/uploads\/2009\/09\/helpoutmsword_thumb.png\" \/>\n<meta name=\"author\" content=\"Jeffery Hicks\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@JeffHicks\" \/>\n<meta name=\"twitter:site\" content=\"@JeffHicks\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Jeffery Hicks\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"10 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/\"},\"author\":{\"name\":\"Jeffery Hicks\",\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/#\\\/schema\\\/person\\\/d0258030b41f07fd745f4078bdf5b6c9\"},\"headline\":\"Out-MSWord Revised\",\"datePublished\":\"2009-09-18T18:13:00+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/\"},\"wordCount\":398,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/#\\\/schema\\\/person\\\/d0258030b41f07fd745f4078bdf5b6c9\"},\"image\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/#primaryimage\"},\"thumbnailUrl\":\"http:\\\/\\\/jdhitsolutions.com\\\/blog\\\/wp-content\\\/uploads\\\/2009\\\/09\\\/helpoutmsword_thumb.png\",\"keywords\":[\"functions\",\"parameters\",\"PowerShell\",\"Practical PowerShell\",\"v2\",\"Word\"],\"articleSection\":[\"CommandLine\",\"PowerShell v2.0\",\"RealTime\",\"Scripting\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/\",\"url\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/\",\"name\":\"Out-MSWord Revised • The Lonely Administrator\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/#primaryimage\"},\"thumbnailUrl\":\"http:\\\/\\\/jdhitsolutions.com\\\/blog\\\/wp-content\\\/uploads\\\/2009\\\/09\\\/helpoutmsword_thumb.png\",\"datePublished\":\"2009-09-18T18:13:00+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/#primaryimage\",\"url\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/wp-content\\\/uploads\\\/2009\\\/09\\\/helpoutmsword_thumb.png\",\"contentUrl\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/wp-content\\\/uploads\\\/2009\\\/09\\\/helpoutmsword_thumb.png\",\"width\":\"244\",\"height\":\"181\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/scripting\\\/356\\\/out-msword-revised\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CommandLine\",\"item\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/category\\\/commandline\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Out-MSWord Revised\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/\",\"name\":\"The Lonely Administrator\",\"description\":\"Practical Advice for the Automating IT Pro\",\"publisher\":{\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/#\\\/schema\\\/person\\\/d0258030b41f07fd745f4078bdf5b6c9\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":[\"Person\",\"Organization\"],\"@id\":\"https:\\\/\\\/jdhitsolutions.com\\\/blog\\\/#\\\/schema\\\/person\\\/d0258030b41f07fd745f4078bdf5b6c9\",\"name\":\"Jeffery Hicks\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/832ae5d438fdcfc1420d720cd1991307927de8a0b12f2342e81c30f773e21098?s=96&d=wavatar&r=pg\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/832ae5d438fdcfc1420d720cd1991307927de8a0b12f2342e81c30f773e21098?s=96&d=wavatar&r=pg\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/832ae5d438fdcfc1420d720cd1991307927de8a0b12f2342e81c30f773e21098?s=96&d=wavatar&r=pg\",\"caption\":\"Jeffery Hicks\"},\"logo\":{\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/832ae5d438fdcfc1420d720cd1991307927de8a0b12f2342e81c30f773e21098?s=96&d=wavatar&r=pg\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Out-MSWord Revised • The Lonely Administrator","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/","og_locale":"en_US","og_type":"article","og_title":"Out-MSWord Revised • The Lonely Administrator","og_description":"This summer I wrote about a function I developed called Out-MSWord. The function was discussed in my Practical PowerShell column which was published in the free e-Journal Windows Administration in RealTime put out by RealTime Publishers. The original was published in Issue #17 if you are interested. The function accepted pipelined input and created a Microsoft Word document. Naturally, you need to have Microsoft Word installed in order for this to work. PS C:> get-service | out-MSWord The function accepted a number of parameters so you could control font name, size, color, append, and more. The function was written for PowerShell v1.0 but also worked on PowerShell v2.0. However, I was revisiting the function and realize there were places I could tweak, such as adding additional error handing. I also realized that if rewrote this for PowerShell v2.0, I could create an advanced function and take advantage of cmdletbinding, advanced parameters and help.","og_url":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/","og_site_name":"The Lonely Administrator","article_published_time":"2009-09-18T18:13:00+00:00","og_image":[{"url":"http:\/\/jdhitsolutions.com\/blog\/wp-content\/uploads\/2009\/09\/helpoutmsword_thumb.png","type":"","width":"","height":""}],"author":"Jeffery Hicks","twitter_card":"summary_large_image","twitter_creator":"@JeffHicks","twitter_site":"@JeffHicks","twitter_misc":{"Written by":"Jeffery Hicks","Est. reading time":"10 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/#article","isPartOf":{"@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/"},"author":{"name":"Jeffery Hicks","@id":"https:\/\/jdhitsolutions.com\/blog\/#\/schema\/person\/d0258030b41f07fd745f4078bdf5b6c9"},"headline":"Out-MSWord Revised","datePublished":"2009-09-18T18:13:00+00:00","mainEntityOfPage":{"@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/"},"wordCount":398,"commentCount":0,"publisher":{"@id":"https:\/\/jdhitsolutions.com\/blog\/#\/schema\/person\/d0258030b41f07fd745f4078bdf5b6c9"},"image":{"@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/#primaryimage"},"thumbnailUrl":"http:\/\/jdhitsolutions.com\/blog\/wp-content\/uploads\/2009\/09\/helpoutmsword_thumb.png","keywords":["functions","parameters","PowerShell","Practical PowerShell","v2","Word"],"articleSection":["CommandLine","PowerShell v2.0","RealTime","Scripting"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/","url":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/","name":"Out-MSWord Revised • The Lonely Administrator","isPartOf":{"@id":"https:\/\/jdhitsolutions.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/#primaryimage"},"image":{"@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/#primaryimage"},"thumbnailUrl":"http:\/\/jdhitsolutions.com\/blog\/wp-content\/uploads\/2009\/09\/helpoutmsword_thumb.png","datePublished":"2009-09-18T18:13:00+00:00","breadcrumb":{"@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/#primaryimage","url":"https:\/\/jdhitsolutions.com\/blog\/wp-content\/uploads\/2009\/09\/helpoutmsword_thumb.png","contentUrl":"https:\/\/jdhitsolutions.com\/blog\/wp-content\/uploads\/2009\/09\/helpoutmsword_thumb.png","width":"244","height":"181"},{"@type":"BreadcrumbList","@id":"https:\/\/jdhitsolutions.com\/blog\/scripting\/356\/out-msword-revised\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"CommandLine","item":"https:\/\/jdhitsolutions.com\/blog\/category\/commandline\/"},{"@type":"ListItem","position":2,"name":"Out-MSWord Revised"}]},{"@type":"WebSite","@id":"https:\/\/jdhitsolutions.com\/blog\/#website","url":"https:\/\/jdhitsolutions.com\/blog\/","name":"The Lonely Administrator","description":"Practical Advice for the Automating IT Pro","publisher":{"@id":"https:\/\/jdhitsolutions.com\/blog\/#\/schema\/person\/d0258030b41f07fd745f4078bdf5b6c9"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/jdhitsolutions.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":["Person","Organization"],"@id":"https:\/\/jdhitsolutions.com\/blog\/#\/schema\/person\/d0258030b41f07fd745f4078bdf5b6c9","name":"Jeffery Hicks","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/832ae5d438fdcfc1420d720cd1991307927de8a0b12f2342e81c30f773e21098?s=96&d=wavatar&r=pg","url":"https:\/\/secure.gravatar.com\/avatar\/832ae5d438fdcfc1420d720cd1991307927de8a0b12f2342e81c30f773e21098?s=96&d=wavatar&r=pg","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/832ae5d438fdcfc1420d720cd1991307927de8a0b12f2342e81c30f773e21098?s=96&d=wavatar&r=pg","caption":"Jeffery Hicks"},"logo":{"@id":"https:\/\/secure.gravatar.com\/avatar\/832ae5d438fdcfc1420d720cd1991307927de8a0b12f2342e81c30f773e21098?s=96&d=wavatar&r=pg"}}]}},"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_likes_enabled":true,"jetpack-related-posts":[{"id":138,"url":"https:\/\/jdhitsolutions.com\/blog\/powershell\/138\/practical-powershell-scripts-and-code\/","url_meta":{"origin":356,"position":0},"title":"Practical PowerShell Scripts and Code","author":"Jeffery Hicks","date":"March 11, 2008","format":false,"excerpt":"If you've been reading the Windows Administration in RealTime ejournal, I hope you've enjoyed my Practical PowerShell column. If not, you're missing out. Each column solves a real-world and practical problem with PowerShell. I explain how the PowerShell code works and why. It's not only a great way to learn\u2026","rel":"","context":"In "PowerShell"","block_context":{"text":"PowerShell","link":"https:\/\/jdhitsolutions.com\/blog\/category\/powershell\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":703,"url":"https:\/\/jdhitsolutions.com\/blog\/scripting\/703\/export-function\/","url_meta":{"origin":356,"position":1},"title":"Export-Function","author":"Jeffery Hicks","date":"July 19, 2010","format":false,"excerpt":"I love that you can do so much with PowerShell on the fly.\u00a0 For example, I don\u2019t need to launch a script editor to create a PowerShell function. I can do it right from the command prompt. PS C:\\> function tm {(get-date).ToLongTimeString()} PS C:\\> tm 12:41:27 PM As long as\u2026","rel":"","context":"In "PowerShell v2.0"","block_context":{"text":"PowerShell v2.0","link":"https:\/\/jdhitsolutions.com\/blog\/category\/powershell-v2-0\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":129,"url":"https:\/\/jdhitsolutions.com\/blog\/powershell\/129\/practical-powershell\/","url_meta":{"origin":356,"position":2},"title":"Practical PowerShell","author":"Jeffery Hicks","date":"February 13, 2008","format":false,"excerpt":"I am writing a new monthly column for a new eJournal from RealTime Publishers. The column, Practical PowerShell, will be a regular feature in Windows Administration in Realtime. The eJournal is a free PDF although I think you have to give up an email address. My column is intended to\u2026","rel":"","context":"In "PowerShell"","block_context":{"text":"PowerShell","link":"https:\/\/jdhitsolutions.com\/blog\/category\/powershell\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1330,"url":"https:\/\/jdhitsolutions.com\/blog\/powershell-v2-0\/1330\/powershell-ise-convert-all-aliases\/","url_meta":{"origin":356,"position":3},"title":"PowerShell ISE Convert All Aliases","author":"Jeffery Hicks","date":"April 8, 2011","format":false,"excerpt":"Yesterday I posted an article on how to convert a selected word to an alias or cmdlet. While I think there is still some value in this piecemeal approach. sometimes you want to make wholesale changes, such as when troubleshooting a script that someone else wrote that is full of\u2026","rel":"","context":"In "PowerShell v2.0"","block_context":{"text":"PowerShell v2.0","link":"https:\/\/jdhitsolutions.com\/blog\/category\/powershell-v2-0\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":134,"url":"https:\/\/jdhitsolutions.com\/blog\/powershell\/134\/prof-powershell-is-taking-roll\/","url_meta":{"origin":356,"position":4},"title":"Prof. PowerShell is taking roll","author":"Jeffery Hicks","date":"March 6, 2008","format":false,"excerpt":"My weekly column that I've been writing for MCPMag.com is now officially Prof. PowerShell. The column's goal is to introduce you to PowerShell and help you get up to speed. I obviously can't teach you everything in a weekly 300 word column, but hopefully it will be enough to get\u2026","rel":"","context":"In "PowerShell"","block_context":{"text":"PowerShell","link":"https:\/\/jdhitsolutions.com\/blog\/category\/powershell\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1423,"url":"https:\/\/jdhitsolutions.com\/blog\/scripting\/1423\/warning-signs\/","url_meta":{"origin":356,"position":5},"title":"Warning Signs","author":"Jeffery Hicks","date":"May 11, 2011","format":false,"excerpt":"I was working on a project with an advanced PowerShell function. One of the goals was to take advantage of the common parameters like -ErrorVariable and -WarningVariable so that when you run the function you can save errors and warnings and work with them later. Turns out one of these\u2026","rel":"","context":"In "PowerShell v2.0"","block_context":{"text":"PowerShell v2.0","link":"https:\/\/jdhitsolutions.com\/blog\/category\/powershell-v2-0\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/jdhitsolutions.com\/blog\/wp-content\/uploads\/2011\/05\/warningvariable-300x184.png?resize=350%2C200","width":350,"height":200},"classes":[]}],"_links":{"self":[{"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/356","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/comments?post=356"}],"version-history":[{"count":0,"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/356\/revisions"}],"wp:attachment":[{"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/media?parent=356"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/categories?post=356"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/jdhitsolutions.com\/blog\/wp-json\/wp\/v2\/tags?post=356"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}