en-US/PSWord.dll-Help.xml
<?xml version="1.0" encoding="utf-8" ?> <helpItems xmlns="http://msh" schema="maml"> <!-- Edited with: SAPIEN PowerShell HelpWriter 2015 v1.0.16--> <!-- Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16--> <!-- Module: PSWord Version: 0.1 --> <!-- All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Add-WordPicture</command:name> <maml:description> <maml:para>Inserts a Picture file into the document.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>WordPicture</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path for the Word Document File.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PicturePath</maml:name> <maml:description> <maml:para>Path of the picture to be added into the document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Show</maml:name> <maml:description> <maml:para>Opens the Word Document after the command has run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name> System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-WordPicture -FilePath .\example.docx -PicturePath .\image.png -Show</dev:code> <dev:remarks> <maml:para>Simple adition of a image into the example.docx file</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Add-WordTable</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>WordTable</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Add-WordTable</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path for the Word Document File.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>PSObject to be parsed into a Table in the document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Design</maml:name> <maml:description> <maml:para>Built-in Table designs for the converted table</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TableDesign</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Show</maml:name> <maml:description> <maml:para>Opens the Word Document after the command has run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path for the Word Document File.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>PSObject to be parsed into a Table in the document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Design</maml:name> <maml:description> <maml:para>Built-in Table designs for the converted table</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TableDesign</command:parameterValue> <dev:type> <maml:name>TableDesign</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Show</maml:name> <maml:description> <maml:para>Opens the Word Document after the command has run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name> System.Management.Automation.PSObject[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-Process | Select-Object -Property Name, Id, WorkingSet | Add-WordTable -FilePath .\example.docx -Design ColorfulGrid -Show</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Add-WordText</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>WordText</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Add-WordText</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path for the Word Document File.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>Text</maml:name> <maml:description> <maml:para>Text to be added to the document</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Size</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Bold</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Italic</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Show</maml:name> <maml:description> <maml:para>Opens the Word Document after the command has run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FontFamily</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">FontFamily</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FontColor</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">KnownColor</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path for the Word Document File.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>Text</maml:name> <maml:description> <maml:para>Text to be added to the document</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Size</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Bold</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Italic</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Show</maml:name> <maml:description> <maml:para>Opens the Word Document after the command has run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FontFamily</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">FontFamily</command:parameterValue> <dev:type> <maml:name>FontFamily</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FontColor</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">KnownColor</command:parameterValue> <dev:type> <maml:name>KnownColor</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name> System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-WordText -FilePath .\example.docx -Text 'This is an example' -Size 12 -FontFamily 'Arial' -FontColor 'Cyan' -Bold -Show</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-WordText -FilePath .\example.docx -Text 'This is an example' -Size 18 -FontFamily 'Arial' -FontColor 'Blue' -Italic -Show</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-WordText -FilePath .\example.docx -Text 'This is an example' -Size 12 -FontFamily 'Verdana' -FontColor 'Red' -Bold -Italic -Show</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-WordText -FilePath .\example.docx -Text 'This is an example' -Size 14 -FontFamily 'Times New Roman' -FontColor 'Black' -Show</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Update-WordText</command:name> <maml:description> <maml:para>Replaces a given string within the Word Document</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>WordText</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Update-WordText</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path for the Word Document File.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ReplacingText</maml:name> <maml:description> <maml:para>Text you wish to replace</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="2" aliases=""> <maml:name>NewText</maml:name> <maml:description> <maml:para>New Text to be placed</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TrackChanges</maml:name> <maml:description> <maml:para>Track changes for further revision</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Show</maml:name> <maml:description> <maml:para>Opens the Word Document after the command has run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path for the Word Document File.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ReplacingText</maml:name> <maml:description> <maml:para>Text you wish to replace</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="2" aliases=""> <maml:name>NewText</maml:name> <maml:description> <maml:para>New Text to be placed</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TrackChanges</maml:name> <maml:description> <maml:para>Track changes for further revision</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Show</maml:name> <maml:description> <maml:para>Opens the Word Document after the command has run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name> System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Update-WordText -FilePath .\example.docx -ReplacingText 'Guido' -NewText 'GuidoOliveira.com' -Show</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Update-WordText -FilePath .\example.docx -ReplacingText 'Guido' -NewText 'GuidoOliveira.com' -TrackChanges -Show</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16--> </helpItems> |