Add-OpenXmlContent
Insert custom markup inside a specific part in a Wordprocessing document
Add
OpenXmlContent
The Add-OpenXmlContent cmdlet injects custom xml markup inside a given part from a Wordprocessing document
Add-OpenXmlContent
Path
Specifies the path to the item(s) whose contents will be modified. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
PartPath
URI path of a part inside the Word Processing document package.
String[]
InsertionPoint
XPath query after whose results the new content will be added.
String
Content
Xml fragment to be injected into the part
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) whose contents will be modified. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
PartPath
URI path of a part inside the Word Processing document package.
String[]
String[]
InsertionPoint
XPath query after whose results the new content will be added.
String
String
Content
Xml fragment to be injected into the part
String
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Set-OpenXmlContentFormat
Set-OpenXmlContentStyle
Add-OpenXmlDigitalSignature
Inserts a new digital signature inside a Wordprocessing document
Add
OpenXmlDigitalSignature
The Add-OpenXmlDigitalSignature cmdlet uses a digital certificate to digitally sign a Wordprocessing document.
Add-OpenXmlDigitalSignature
Path
Specifies the path to the item(s) to digitally-sign. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
Certificate
File (including the path if needed) containing the digital certificate used for generation of the digital signature. The certificate must be X509 compatible.
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to digitally-sign. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
Certificate
File (including the path if needed) containing the digital certificate used for generation of the digital signature. The certificate must be X509 compatible.
String
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlDigitalSignature
Remove-OpenXmlDigitalSignature
Add-OpenXmlDocumentIndex
Generate the index of a Wordprocessing document
Add
OpenXmlDocumentIndex
The Add-OpenXmlDocumentIndex cmdlet creates an index based on the index references found in the document. The index will be created at the end of the document.
Add-OpenXmlDocumentIndex
Path
Specifies the path to the item(s) where the index will be generated. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
StylesSourcePath
Path to a styles file that contains the styles needed for the index (Index1).
String
AddDefaultStyles
Specify if the default styles should be created or if the styles should be found in the StylesSourcePath.
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) where the index will be generated. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
StylesSourcePath
Path to a styles file that contains the styles needed for the index (Index1).
String
String
AddDefaultStyles
Specify if the default styles should be created or if the styles should be found in the StylesSourcePath.
SwitchParameter
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Add-OpenXmlDocumentTOA
Add-OpenXmlDocumentTOC
Add-OpenXmlDocumentTOF
Add-OpenXmlDocumentTOA
Generate the TOA (Table Of Authorities) of a Wordprocessing document
Add
OpenXmlDocumentTOA
The Add-OpenXmlDocumentTOA cmdlet creates a Table of Authorities based on the citations (references or authorities) found in the document.
Add-OpenXmlDocumentTOA
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) where the TOA will be generated. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
InsertionPoint
XPath query expression that specifies where the table of authorities will be inserted into the document.
String
Switches
String that specifies how to create the table of authorities. See examples and Open XML document section 17.16.5.67 for details about its format.
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) where the TOA will be generated. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
InsertionPoint
XPath query expression that specifies where the table of authorities will be inserted into the document.
String
String
Switches
String that specifies how to create the table of authorities. See examples and Open XML document section 17.16.5.67 for details about its format.
String
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Add-OpenXmlDocumentIndex
Add-OpenXmlDocumentTOC
Add-OpenXmlDocumentTOF
Add-OpenXmlDocumentTOC
Generate the TOC (Table Of Contents) of a Wordprocessing document
Add
OpenXmlDocumentTOC
The Add-OpenXmlDocumentTOC cmdlet creates a Table of Contents based on the headings found in the document.
Add-OpenXmlDocumentTOC
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) where the TOC will be generated. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
InsertionPoint
XPath query expression that specifies where the table of contents will be inserted into the document.
String
Switches
String that specifies how to create the table of contents. See examples and Open XML document section 17.16.5.68 for details about its format.
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) where the TOC will be generated. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
InsertionPoint
XPath query expression that specifies where the table of contents will be inserted into the document.
String
String
Switches
String that specifies how to create the table of contents. See examples and Open XML document section 17.16.5.68 for details about its format.
String
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Add-OpenXmlDocumentIndex
Add-OpenXmlDocumentTOA
Add-OpenXmlDocumentTOF
Add-OpenXmlDocumentTOF
Generate the TOF (Table Of Figures) of a Wordprocessing document
Add
OpenXmlDocumentTOF
The Add-OpenXmlDocumentTOF cmdlet creates a Table of Figures based on the figures found in the document.
Add-OpenXmlDocumentTOF
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) where the TOF will be generated. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
InsertionPoint
XPath query expression that specifies where the table of figures will be inserted into the document.
String
Switches
String that specifies how to create the table of figures. See examples and Open XML document section 17.16.5.69 for details about its format.
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) where the TOF will be generated. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
InsertionPoint
XPath query expression that specifies where the table of figures will be inserted into the document.
String
String
Switches
String that specifies how to create the table of figures. See examples and Open XML document section 17.16.5.69 for details about its format.
String
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Add-OpenXmlDocumentIndex
Add-OpenXmlDocumentTOA
Add-OpenXmlDocumentTOC
Add-OpenXmlPicture
Inserts a picture inside an OpenXML document
Add
OpenXmlPicture
The Add-OpenXmlPicture cmdlet inserts a picture at a specific location inside an OpenXML document. The picture will be stored inside the document as an embedded resource. Picture location is specified by an XPath query expression.
Add-OpenXmlPicture
Path
Specifies the path to the item(s) to add pictures to. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
InsertionPoint
XPath query after whose results the new image will be added.
String
PicturePath
Path to a file containing the picture to be added. This command requires this parameter or an image that is piped into the command.
String
ImageFile
Accepts System.IO.FileInfo objects as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns FileInfo objects (e.g. Get-ChildItem or Get-OpenXmlBackground).
FileInfo
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to add pictures to. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
InsertionPoint
XPath query after whose results the new image will be added.
String
String
PicturePath
Path to a file containing the picture to be added. This command requires this parameter or an image that is piped into the command.
String
String
ImageFile
Accepts System.IO.FileInfo objects as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns FileInfo objects (e.g. Get-ChildItem or Get-OpenXmlBackground).
FileInfo
FileInfo
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument, FileInfo
The picture may be piped into the object by referring to the file containing that picture. The System.IO.FileInfo object is output by Get-ChildItem and Get-OpenXmlBackground -Image, among others.
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlBackground
Add-OpenXmlSpreadSheetTable
Add a new table definition to a worksheet in a Spreadsheet document.
Add
OpenXmlSpreadSheetTable
Add a new table definition to a worksheet in a Spreadsheet document.
Add-OpenXmlSpreadSheetTable
Path
Specifies the path to the spreadsheet document files to modify. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
TableStyle
Table style to be applied to the table being added.
String
FromColumn
Initial column of table.
Int16
ToColumn
Final column of table.
Int16
FromRow
Initial row of table.
Int32
ToRow
Final row of table.
Int32
WorksheetName
Name of worksheet where the table will be added.
String
HasHeaders
If present, it indicates that the first row in table range will be a filtered header row.
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the spreadsheet document files to modify. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
TableStyle
Table style to be applied to the table being added.
String
String
FromColumn
Initial column of table.
Int16
Int16
ToColumn
Final column of table.
Int16
Int16
FromRow
Initial row of table.
Int32
Int32
ToRow
Final row of table.
Int32
Int32
WorksheetName
Name of worksheet where the table will be added.
String
String
HasHeaders
If present, it indicates that the first row in table range will be a filtered header row.
SwitchParameter
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Confirm-OpenXmlValid
Validate all the XML elements in a document.
Confirm
OpenXmlValid
Checks every element and attribute of the XML in all parts of the document. Any errors will output as ValidationInfo objects that have detailed information about the error along with the path of the document with the error.
Confirm-OpenXmlValid
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) whose contents will be validated. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) whose contents will be validated. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
String[]
OpenXmlPowerToolsDocument
OpenXmlPowerTools.ValidationInfo
Edit-OpenXmlChange
Confirms or rejects tracked changes in a Wordprocessing document.
Edit
OpenXmlChange
The resulting document will not have any tracked changes in it. The Accept parameter causes all tracked changes to be accepted. The Reject parameter is not yet implemented.
Edit-OpenXmlChange
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) whose contents will be modified. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
Accept
Signals that the tracked changes should be accepted. (Note: There is currently no Reject option, but that is a probable future enhancement.)
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) whose contents will be modified. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
Accept
Signals that the tracked changes should be accepted. (Note: There is currently no Reject option, but that is a probable future enhancement.)
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Remove-OpenXmlMarkup
Export-OpenXmlSpreadsheet
Generates a spreadsheet document from piped objects.
Export
OpenXmlSpreadsheet
The Export-OpenXmlSpreadsheet gets the public properties from any objects and generates a spreadsheet with columns showing for each property. Optionally, a chart can be created from a subset of those properties.
Export-OpenXmlSpreadsheet
OutputPath
Path of the file that will contain the new spreadsheet.
String
InputObject
An array of objects whose properties will be shown into the resulting spreadsheet. This is usually supplied by piping the objects into the cmdlet.
PSObject[]
Chart
Use this switch if you want to include a chart for a subset of object properties.
ChartType
Type of chart to include into the spreadsheet document. Valid types are Bar, Column, Pie, Area, and Line.
ChartType
ColumnsToChart
List of columns to use as data series for charting.
String
HeaderColumn
Name of property to use as data category for charting.
String
InitialRow
Initial row to start copying the data
Int32
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
OutputPath
Path of the file that will contain the new spreadsheet.
String
String
InputObject
An array of objects whose properties will be shown into the resulting spreadsheet. This is usually supplied by piping the objects into the cmdlet.
PSObject[]
PSObject[]
Chart
Use this switch if you want to include a chart for a subset of object properties.
SwitchParameter
ChartType
Type of chart to include into the spreadsheet document. Valid types are Bar, Column, Pie, Area, and Line.
ChartType
ChartType
ColumnsToChart
List of columns to use as data series for charting.
String
String
HeaderColumn
Name of property to use as data category for charting.
String
String
InitialRow
Initial row to start copying the data
Int32
Int32
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
Objects
OpenXmlPowerToolsDocument (if PassThru)
A file will be created that contains the new spreadsheet document. The returned object will refer to that new document file.
Export-OpenXmlWordprocessing
Export-OpenXmlToHtml
Exports Wordprocessing documents to html documents
Export
OpenXmlToHtml
The Export-OpenXmlToHtml cmdlet transforms the content of Wordprocessing documents into an html file. Any images are stored in a separate subfolder with matching references in the html file.
Export-OpenXmlToHtml
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to export to html. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
PageTitle
The HTML page will be created with this title.
String
OutputPath
The path of the output folder that will contain the created files.
String
ImageFolder
Path to a folder where images will be stored. The default is a folder named "images" at the same path as the original document.
String
ImagePrefix
Image files will be created with this prefix followed by a sequence number.
String
CssPath
Path and name of a file that contains the CSS.
String
CssClassPrefix
This prefix will be added to the document style name to create the CSS class.
String
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to export to html. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
PageTitle
The HTML page will be created with this title.
String
String
OutputPath
The path of the output folder that will contain the created files.
String
String
ImageFolder
Path to a folder where images will be stored. The default is a folder named "images" at the same path as the original document.
String
String
ImagePrefix
Image files will be created with this prefix followed by a sequence number.
String
String
CssPath
Path and name of a file that contains the CSS.
String
String
CssClassPrefix
This prefix will be added to the document style name to create the CSS class.
String
String
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
Export-OpenXmlWordprocessing
Create a new Wordprocessing document from text.
Export
OpenXmlWordprocessing
The Export-OpenXmlWordprocessing uses plain text to create a Wordprocessing document.
Export-OpenXmlWordprocessing
OutputPath
Path and name of the file to create with the new content.
String
Text
The text to included in the document.
String[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
OutputPath
Path and name of the file to create with the new content.
String
String
Text
The text to included in the document.
String[]
String[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
String[]
Text to be contained inside a new Wordprocessing document.
OpenXmlPowerToolsDocument (if PassThru)
Export-OpenXmlSpreadsheet
Get-OpenXmlBackground
Extracts background information from a Wordprocessing document
Get
OpenXmlBackground
The Get-OpenXmlBackground cmdlet extracts the background (color or image) from a document according to the parameters Image or Color.
Get-OpenXmlBackground
Path
Specifies the path to the item(s) to retrieve background information from. Wildcards are allowed. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for the background image.
String
Image
Specifies that the cmdlet result will be the FileInfo object (System.IO.FileInfo) of the file containing a copy of the background image. No object will be returned if there is no background image.
Color
Specifies that the cmdlet result will be the System.Drawing.Color object containing the background color of the document.
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to retrieve background information from. Wildcards are allowed. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for the background image.
String
String
Image
Specifies that the cmdlet result will be the FileInfo object (System.IO.FileInfo) of the file containing a copy of the background image. No object will be returned if there is no background image.
SwitchParameter
Color
Specifies that the cmdlet result will be the System.Drawing.Color object containing the background color of the document.
SwitchParameter
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
FileInfo or Color
If Image is specified, a file is created to hold the background image, if any, and a System.IO.FileInfo object is returned that refers to that file. If Color is specified, a System.Drawing.Color object is returned that contains the background color.
Set-OpenXmlBackground
Add-OpenXmlPicture
Get-OpenXmlComment
Extracts all the comments contained in a Wordprocessing document
Get
OpenXmlComment
The Get-OpenXmlComment extracts all the comments from a document, and return all of them in a XDocument
Get-OpenXmlComment
Path
Specifies the path to the item(s) to retrieve comments from. Wildcards are allowed. If you specify multiple paths, use commas to separate the paths.
String[]
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to retrieve comments from. Wildcards are allowed. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument
Takes documents passed by pipe or specified by filename
XDocument
XDocument containing all the comments
-------------- Example 1 --------------
C:\PS>
C:\PS>
Get-OpenXmlComment Comments.docx
Outputs all the comments from the 'Comments.docx' document.
Get-OpenXmlCustomXmlData
Gets a customXml part from a document.
Get
OpenXmlCustomXmlData
The Get-OpenXmlCustomXmlData cmdlet gets the first customXml part that matches the given name and returns it as an XDocument object.
Get-OpenXmlCustomXmlData
Path
Specifies the path to the item(s) to retrieve customXml information from. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
Part
Name of customXml part inside the Word Processing document package
String
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to retrieve customXml information from. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
Part
Name of customXml part inside the Word Processing document package
String
String
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument
XDocument
Set-OpenXmlCustomXmlData
Get-OpenXmlDigitalSignature
Gets information about digital signatures present in a Wordprocessing document
Get
OpenXmlDigitalSignature
The Get-OpenXmlDigitalSignature cmdlet returns a summary of digital signatures present in the Wordprocessing document
Get-OpenXmlDigitalSignature
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) containing digital signatures. Wildcards are permitted.
String[]
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) containing digital signatures. Wildcards are permitted.
String[]
String[]
OpenXmlPowerToolsDocument
String
-------------- Example 1 --------------
C:\PS>
C:\PS>
Get-OpenXmlDigitalSignature test.docx
Gets a summary of digital signatures for the test.docx document.
Signature: CN=fname1.lname1 (UntrustedRoot)
Signature: CN=fname2.lname2 (UntrustedRoot)
Add-OpenXmlDigitalSignature
Remove-OpenXmlDigitalSignature
Get-OpenXmlDocument
Creates objects for OpenXML documents
Get
OpenXmlDocument
The Get-OpenXmlDocument cmdlet pipes out an OpenXmlPowerToolsDocument for each document file.
Get-OpenXmlDocument
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the items to load into memory as Wordprocessing documents. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the items to load into memory as Wordprocessing documents. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OpenXmlPowerToolsDocument (if PassThru)
-------------- Example 1 --------------
C:\PS>
C:\PS>
$doc = Get-OpenXmlDocument file.docx
Stores into $doc a Wordprocessing document created from contents of file.docx.
Get-OpenXmlFooter
Retrieves footer information from Wordprocessing documents
Get
OpenXmlFooter
The Get-OpenXmlFooter cmdlet retrieves all the specified footer parts from a document and returns an XDocument array of those footers. An object is returned for the specified footer in each Section of the document.
Get-OpenXmlFooter
Path
Specifies the path to the item(s) to retrieve footer information from. Wildcards are allowed. If you specify multiple paths use commas to separate the paths.
String[]
FooterType
Specified which footers to retrieve from the document. Options are First, Even or Default. If even and odd page footers are used, Default will retrieve the odd page footers.
FooterType
Section
Section number to use for retrieving footer.
Int32
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to retrieve footer information from. Wildcards are allowed. If you specify multiple paths use commas to separate the paths.
String[]
String[]
FooterType
Specified which footers to retrieve from the document. Options are First, Even or Default. If even and odd page footers are used, Default will retrieve the odd page footers.
FooterType
FooterType
Section
Selects the section that will be used to get the footer. The first section is 1 and is also the default.
Int32
Int32
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument
XDocument
Set-OpenXmlFooter
Get-OpenXmlHeader
Get-OpenXmlHeader
Retrieves header(s) information from Wordprocessing documents
Get
OpenXmlHeader
The Get-OpenXmlHeader retrieves all the existing header parts from a document. The execution returns an XDocument array of all the header parts found in the document.
Get-OpenXmlHeader
Path
Specifies the item(s) to the items to retrieve header information from. Wildcards are allowed. If you specify multiple paths use commas to separate the paths.
String[]
HeaderType
Specified which headers to retrieve from the document. Options are First, Even or Default. If even and odd page headers are used, Default will retrieve the odd page headers.
HeaderType
Section
Section number to use for retrieving header.
Int32
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the item(s) to the items to retrieve header information from. Wildcards are allowed. If you specify multiple paths use commas to separate the paths.
String[]
String[]
HeaderType
Specified which headers to retrieve from the document. Options are First, Even or Default. If even and odd page headers are used, Default will retrieve the odd page headers.
HeaderType
HeaderType
Section
Selects the section that will be used to get the header. The first section is 1 and is also the default.
Int32
Int32
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument
Documents to retrieve header information from
XDocument
Array of headers
Set-OpenXmlHeader
Get-OpenXmlFooter
Get-OpenXmlStyle
Retrieves style definitions from a Wordprocessing or a Spreadsheet document.
Get
OpenXmlStyle
The Get-OpenXmlStyle cmdlet retrieves the styles definition part from a Wordprocessing or Spreadsheet document and returns an XDocument object containing the styles content.
Get-OpenXmlStyle
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to retrieve style information from. Wildcards are allowed. If you specify multiple paths use commas to separate the paths.
String[]
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to retrieve style information from. Wildcards are allowed. If you specify multiple paths use commas to separate the paths.
String[]
String[]
OpenXmlPowerToolsDocument
XDocument
Set-OpenXmlStyle
Get-OpenXmlTheme
Gets the theme content from a Wordprocessing document.
Get
OpenXmlTheme
The Get-OpenXmlTheme cmdlet extracts the whole theme part from a Wordprocessing document as a thmx file (with media resources embedded). A Package object is returned as an OpenXmlPowerToolsDocument that corresponds to the theme file.
Get-OpenXmlTheme
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the items to retrieve theme information from. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputPath
Path of the created theme file.
String
PassThru
Outputs the theme to the pipeline.
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the items to retrieve theme information from. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputPath
Path of the created theme file.
String
String
PassThru
Outputs the theme to the pipeline.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument
Set-OpenXmlTheme
Get-OpenXmlWatermark
Gets watermark text from a Wordprocessing document.
Get
OpenXmlWatermark
The Get-OpenXmlWatermark cmdlet retrieves the text of the document's watermark.
Get-OpenXmlWatermark
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to retrieve watermark information from. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
Document
Specifies the item(s) from the pipeline that will be read by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to retrieve watermark information from. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OpenXmlPowerToolsDocument
String
-------------- Example 1 --------------
C:\PS>
C:\PS>
Get-OpenXmlWatermark test.docx
Gets the text from watermark in test.docx.
Confidential
Set-OpenXmlWatermark
Lock-OpenXmlDocument
Locks one or more Wordprocessing documents.
Lock
OpenXmlDocument
The Lock-OpenXmlDocument cmdlet sets a lock inside one or more Wordprocessing documents to prevent them from being edited.
Lock-OpenXmlDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to lock. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the item(s) to lock. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
-------------- Example 1 --------------
C:\PS>
C:\PS>
Lock-OpenXmlDocument test1.docx,test2.docx
Sets a lock on test1.docx and test2.docx that prevents them from being modified.
Merge-OpenXmlDocument
Merge multiple source documents into a new document.
Merge
OpenXmlDocument
Create a new document that merges the contents of multiple source documents. All or part of the source documents may be merged into the final document. There are three main ways that this cmdlet may be used. First, all of the documents specified by the Path parameter will be merged into the output document. Second, you can specify a single document with the Path parameter along with the Start and Count parameters to create a new document with part of the source document. Third, you can detail which parts you want from multiple source documents using the Sources parameter.
(There is a fourth way where you specify multiple documents with a single start and count for all of the documents. That combination is unlikely to be useful.)
There are some parts of a document that cannot be merged, like settings. These will all come from the first source document. You can specify a 0 Count for the first source document to get those settings without including any paragraphs.
Merge-OpenXmlDocument
Path
Specifies the path to the documents to use as the source. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputPath
Path and name of the file to create with the new content.
String
Start
Specifies the first element to be used from the source document or documents. For many documents, the only elements are paragraphs, but some may contain tables and other types of elements, like range start or end elements.
Int32
Count
Specifies the number of elements to use from the source document. For many documents, the only elements are paragraphs, but some may contain tables and other types of elements, like range start or end elements.
Int32
Sources
This parameter is an array of one or more OpenXml.PowerTools.DocumentSource objects that define each source document and range of elements(paragraphs) that will be copied from that source document into the merged document. The DocumentSource object may specify an entire document or part of the document. One of the examples shows how to use these objects.
DocumentSource[]
KeepSections
Use this parameter if you want the output document to contain section breaks between each source document.
Document
Specifies the item(s) from the pipeline that will be used by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the documents to use as the source. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputPath
Path and name of the file to create with the new content.
String
String
Start
Specifies the first element to be used from the source document or documents. For many documents, the only elements are paragraphs, but some may contain tables and other types of elements, like range start or end elements.
Int32
Int32
Count
Specifies the number of elements to use from the source document. For many documents, the only elements are paragraphs, but some may contain tables and other types of elements, like range start or end elements.
Int32
Int32
Sources
This parameter is an array of one or more OpenXml.PowerTools.DocumentSource objects that define each source document and range of elements(paragraphs) that will be copied from that source document into the merged document. The DocumentSource object may specify an entire document or part of the document. One of the examples shows how to use these objects.
DocumentSource[]
DocumentSource[]
KeepSections
Use this parameter if you want the output document to contain section breaks between each source document.
SwitchParameter
Document
Specifies the item(s) from the pipeline that will be used by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
Source documents to be included in the output document.
OpenXmlPowerToolsDocument (if PassThru)
-------------- Example 1 --------------
C:\PS>
C:\PS>
Merge-OpenXmlDocument -OutputPath merge.docx -Path input1.docx,input2.docx,input3.docx
Merges all three source documents into a single output document.
-------------- Example 2 --------------
C:\PS>
C:\PS>
Merge-OpenXmlDocument -OutputPath extract.docx -Path input1.docx -Start 10 -Count 5
Creates a new document containing five elements (paragraphs) from "input1.docx" starting at the 10th element.
-------------- Example 3 --------------
C:\PS>
C:\PS>
$doc1 = New-Object -TypeName OpenXml.PowerTools.DocumentSource -ArgumentList "Input1.docx"
$doc1.KeepSection = 1
$doc2 = New-Object -TypeName OpenXml.PowerTools.DocumentSource -ArgumentList "Input.docx", 3, 5
Merge-OpenXmlDocument -OutputPath merge.docx -Sources $doc1,$doc2
This example shows how to use the DocumentSource objects to specify exactly how to compose a new document from multiple source documents.
Split-OpenXmlDocument
Merge-OpenXmlDocumentComment
Merge comments from multiple source documents into a new document.
Merge
OpenXmlDocumentComment
All source documents must be identical, except for the comments. The resulting merged document will contain all comments from the source documents.
Merge-OpenXmlDocumentComment
Path
Specifies the path to the item(s) whose contents will be merged. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
OutputPath
Path and name of the file to create with the new document that has all comments in it.
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) whose contents will be merged. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
String[]
OutputPath
Path and name of the file to create with the new document that has all comments in it.
String
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Remove-OpenXmlComment
Removes comments from Wordprocessing documents.
Remove
OpenXmlComment
The Remove-OpenXmlComment cmdlet locates and removes comment contents and references from Wordprocessing documents.
Remove-OpenXmlComment
Path
Specifies the path to the item(s) to remove comments from. Wildcards are permitted. If you specify multiple paths use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to remove comments from. Wildcards are permitted. If you specify multiple paths use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Edit-OpenXmlChange
Remove-OpenXmlDigitalSignature
Removes the digital signature of a Wordprocessing document
Remove
OpenXmlDigitalSignature
The Remove-OpenXmlDigitalSignature cmdlet removes digital signatures from a Wordprocessing document
Remove-OpenXmlDigitalSignature
Path
Specifies the path to the item(s) to remove digital signature from. Wildcards are permitted. If you specify multiple paths use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to remove digital signature from. Wildcards are permitted. If you specify multiple paths use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
-------------- Example 1 --------------
C:\PS>
C:\PS>
Remove-OpenXmlDigitalSignature SignedDocument.docx
Removes all the digital signatures from 'SignedDocument.docx'
Add-OpenXmlDigitalSignature
Get-OpenXmlDigitalSignature
Remove-OpenXmlMarkup
Removes a variety of complex markups from a Wordprocessing document.
Remove
OpenXmlMarkup
Each parameter indicates another kind of complex markup that should be removed from the document. Any number of the parameters may be processed at the same time.
Remove-OpenXmlMarkup
Path
Specifies the path to the item(s) whose contents will be modified. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
AcceptRevisions
Accepts all tracked revisions to the document.
RemoveContentControls
Removes content controls.
RemoveSmartTags
Removes Smart Tags.
RemoveRsidInfo
Removes RSID information.
RemoveComments
Removes all comments from the document.
RemoveEndAndFootNotes
Remove all endnote and footnote information.
ReplaceTabsWithSpaces
Change tabs into an appropriate number of spaces.
RemoveFieldCodes
Remove all field codes from the document.
RemovePermissions
Removes all permissions.
RemoveProof
Remove proofs.
RemoveSoftHyphens
Remove all soft hyphens from document.
RemoveLastRenderedPageBreak
Removes the last rendered page break.
RemoveBookmarks
Remove all bookmarks from the document.
RemoveWebHidden
Remove hidden web information.
RemoveGoBackBookmark
Remove the Go Back bookmark from the document.
NormalizeXml
Normalize XML in the document.
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) whose contents will be modified. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
AcceptRevisions
Accepts all tracked revisions to the document.
SwitchParameter
RemoveContentControls
Removes content controls.
SwitchParameter
RemoveSmartTags
Removes Smart Tags.
SwitchParameter
RemoveRsidInfo
Removes RSID information.
SwitchParameter
RemoveComments
Removes all comments from the document.
SwitchParameter
RemoveEndAndFootNotes
Remove all endnote and footnote information.
SwitchParameter
ReplaceTabsWithSpaces
Change tabs into an appropriate number of spaces.
SwitchParameter
RemoveFieldCodes
Remove all field codes from the document.
SwitchParameter
RemovePermissions
Removes all permissions.
SwitchParameter
RemoveProof
Remove proofs.
SwitchParameter
RemoveSoftHyphens
Remove all soft hyphens from document.
SwitchParameter
RemoveLastRenderedPageBreak
Removes the last rendered page break.
SwitchParameter
RemoveBookmarks
Remove all bookmarks from the document.
SwitchParameter
RemoveWebHidden
Remove hidden web information.
SwitchParameter
RemoveGoBackBookmark
Remove the Go Back bookmark from the document.
SwitchParameter
NormalizeXml
Normalize XML in the document.
SwitchParameter
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Edit-OpenXmlChange
Remove-OpenXmlPersonalInformation
Removes personal information from a Wordprocessing document.
Remove
OpenXmlPersonalInformation
The Remove-OpenXmlPersonalInformation cmdlet removes personal information from the settings of the document.
Remove-OpenXmlPersonalInformation
Path
Specifies the path to the item(s) to remove personal information from. Wildcards are permitted. If you specify multiple paths use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to remove personal information from. Wildcards are permitted. If you specify multiple paths use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
-------------- Example 1 --------------
C:\PS>
C:\PS>
Remove-OpenXmlPersonalInformation -Path Test.docx
Removes the personal information from the "Test.docx" document.
Select-OpenXmlString
Identifies patterns in Wordprocessing documents.
Select
OpenXmlString
Searches Wordprocessing documents for matches of the specified pattern. By default, Select-OpenXmlString uses the Pattern parameter to match against elements in documents and/or the Style parameter to match against style names of paragraphs in the document. To learn more about regular expressions in Windows PowerShell, type get-help about_regular_expression. You can suppress the regular expression match by using the SimpleMatch parameter.
The cmdlet will search documents specified by the Path parameter that supports wildcards. Alternatively, a document or documents can be piped in, usually from the output of another PowerTools cmdlet.
Output from this cmdlet is a MatchInfo object that includes detailed information about the matches. The object includes properties like Filename and ElementNumber that can be used for other cmdlets like Merge-OpenXmlDocument. You can use the List parameter to stop after the first match in each input document.
Select-OpenXmlString
Path
Specifies the path to the documents to use as the source. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
Pattern
Specifies the string or regular expression that represents the matching criteria. To learn about regular expressions in Windows PowerShell, type get-help about_regular_expression at the Windows PowerShell command prompt.
String[]
Style
Specifies the string or regular expression that represents the matching criteria for a style in the document. To learn about regular expressions in Windows PowerShell, type get-help about_regular_expression at the Windows PowerShell command prompt.
String[]
simpleMatch
Specifies that a simple match, rather than a regular expression match, should be used.
caseSensitive
Makes matches case sensitive. By default, matching is not case sensitive.
list
Specifies that only one match should result for each input document. The returned MatchInfo objects only include information about that first match.
Document
Specifies the item(s) from the pipeline that will be used by this command.
OpenXmlPowerToolsDocument[]
Path
Specifies the path to the documents to use as the source. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
Pattern
Specifies the string or regular expression that represents the matching criteria. To learn about regular expressions in Windows PowerShell, type get-help about_regular_expression at the Windows PowerShell command prompt.
String[]
String[]
Style
Specifies the string or regular expression that represents the matching criteria for a style in the document. To learn about regular expressions in Windows PowerShell, type get-help about_regular_expression at the Windows PowerShell command prompt.
String[]
String[]
simpleMatch
Specifies that a simple match, rather than a regular expression match, should be used.
SwitchParameter
caseSensitive
Makes matches case sensitive. By default, matching is not case sensitive.
SwitchParameter
list
Specifies that only one match should result for each input document. The returned MatchInfo objects only include information about that first match.
SwitchParameter
Document
Specifies the item(s) from the pipeline that will be used by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument
Source documents to be searched for matches.
OpenXmlPowerTools.MatchInfo
The MatchInfo object has the following properties:
Path: string
Filename: string
ElementNumber: integer
Content: string
Style: string
Pattern: string
IgnoreCase: boolean
Merge-OpenXmlDocument
Set-OpenXmlString
Set-OpenXmlBackground
Sets the background color or image of a Wordprocessing document.
Set
OpenXmlBackground
The Set-OpenXmlBackground cmdlet changes the background image or background color of a Wordprocessing document.
Set-OpenXmlBackground
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
ImagePath
Path of the image to set as the document background.
String
ColorName
Hexadecimal representation of the color to set as the document background.
String
Color
A System.Drawing.Color object that is used to set the background color. Usually this will come from the output of the Get-OpenXmlBackground cmdlet.
Color
ImageFile
A System.IO.FileInfo object that refers to a file that is used to set the background image. Usually this will come from the output of the Get-OpenXmlBackground cmdlet.
FileInfo
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
ImagePath
Path of the image to set as the document background.
String
String
ColorName
Hexadecimal representation of the color to set as the document background.
String
String
Color
A System.Drawing.Color object that is used to set the background color. Usually this will come from the output of the Get-OpenXmlBackground cmdlet.
Color
Color
ImageFile
A System.IO.FileInfo object that refers to a file that is used to set the background image. Usually this will come from the output of the Get-OpenXmlBackground cmdlet.
FileInfo
FileInfo
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
Color, FileInfo or OpenXmlPowerToolsDocument
See the Color, ImageFile and Document parameters for more information.
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlBackground
Set-OpenXmlContentFormat
Sets the format of a paragraph or run on a Wordprocessing document.
Set
OpenXmlContentFormat
The Set-OpenXmlContentFormat cmdlet inserts markup containing format to be applied on a given run or paragraph. Format location is specified as an xpath query.
Set-OpenXmlContentFormat
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
InsertionPoint
XPath query to the paragraph or run in which to apply the format.
String
Content
XML markup defining format to be applied. You are responsible for providing valid XML.
String
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
InsertionPoint
XPath query to the paragraph or run in which to apply the format.
String
String
Content
XML markup defining format to be applied. You are responsible for providing valid XML.
String
String
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Set-OpenXmlContentStyle
Set-OpenXmlContentStyle
Sets the style for a paragraph or run on a Wordprocessing document.
Set
OpenXmlContentStyle
The Set-OpenXmlContentStyle cmdlet inserts inserts markup containing the style format to be applied on a given run or paragraph. Format location is specified as an XPath query.
Set-OpenXmlContentStyle
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
InsertionPoint
XPath query to the paragraph or run in which to apply style.
String
StyleName
Name of the style to apply.
String
StylesSourcePath
Path to the style library file. If the specified style does not exist in the style library of the document, the new style is copied into the document from this style library. See also StylesSource.
String
StylesSource
XDocument object containing the style library. If the specified style does not exist in the style library of the document, the new style is copied into the document from this style library. See also StylesSourcePath. This object could be supplied by the Get-OpenXmlStyle cmdlet.
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
InsertionPoint
XPath query to the paragraph or run in which to apply style.
String
String
StyleName
Name of the style to apply.
String
String
StylesSourcePath
Path to the style library file. If the specified style does not exist in the style library of the document, the new style is copied into the document from this style library. See also StylesSource.
String
String
StylesSource
XDocument object containing the style library. If the specified style does not exist in the style library of the document, the new style is copied into the document from this style library. See also StylesSourcePath. This object could be supplied by the Get-OpenXmlStyle cmdlet.
XDocument
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Set-OpenXmlContentFormat
Set-OpenXmlCustomXmlData
Sets the contents of a custom XML part in a Wordprocessing document.
Set
OpenXmlCustomXmlData
The Set-OpenXmlCustomXmlData cmdlet sets or replaces the specified custom XML part in the document.
Set-OpenXmlCustomXmlData
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
PartPath
Path of custom XML file used to set or replace custom XML data. Either this parameter or Part must are mandatory.
String
PartName
Name that will be used for the custom XML data part. If a PartPath is specified, the base file name will be also used at the PartName.
String
Part
XDocument object containing the custom XML data. Either this parameter or PartPath are mandatory.
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
PartPath
Path of custom XML file used to set or replace custom XML data. Either this parameter or Part must are mandatory.
String
String
PartName
Name that will be used for the custom XML data part. If a PartPath is specified, the base file name will be also used at the PartName.
String
String
Part
XDocument object containing the custom XML data. Either this parameter or PartPath are mandatory.
XDocument
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
XDocument or OpenXmlPowerToolsDocument
The XDocument object should contain the custom XML. See the Part parameter.
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlCustomXmlData
Set-OpenXmlFooter
Sets footers in a Wordprocessing document.
Set
OpenXmlFooter
The Set-OpenXmlFooter cmdlet inserts footer parts into all sections of a Wordprocessing document.
Set-OpenXmlFooter
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
FooterPath
Paths of footer file to be set.
String
FooterType
Specified which footers to set in the document. Options are First, Even or Default. If even and odd page footers are used, Default refers to the odd page footers.
FooterType
Section
Section number to use for setting footer.
Int32
Footer
XDocument containing the footer definition.
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
FooterPath
Paths of footer file to be set.
String
String
FooterType
Specified which footers to set in the document. Options are First, Even or Default. If even and odd page footers are used, Default refers to the odd page footers.
FooterType
FooterType
Section
Selects the section that will be used to set the footer. The first section is 1 and is also the default.
Int32
Int32
Footer
XDocument containing the footer definition.
XDocument
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
XDocument or OpenXmlPowerToolsDocument
See the Footer or Document parameters.
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlFooter
Set-OpenXmlHeader
Set-OpenXmlHeader
Sets headers on a Wordprocessing document.
Set
OpenXmlHeader
The Set-OpenXmlHeader cmdlet inserts header parts into all sections of a Wordprocessing document.
Set-OpenXmlHeader
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
HeaderPath
Paths of header files to be set.
String
HeaderType
Specified which headers to set in the document. Options are First, Even or Default. If even and odd page headers are used, Default refers to the odd page headers.
HeaderType
Section
Section number to use for setting header.
Int32
Header
XDocument containing the header definition.
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
HeaderPath
Paths of header files to be set.
String
String
HeaderType
Specified which headers to set in the document. Options are First, Even or Default. If even and odd page headers are used, Default refers to the odd page headers.
HeaderType
HeaderType
Section
Selects the section that will be used to set the header. The first section is 1 and is also the default.
Int32
Int32
Header
XDocument containing the header definition.
XDocument
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
XDocument or OpenXmlPowerToolsDocument
See the Header or Document parameters.
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlHeader
Set-OpenXmlFooter
Set-OpenXmlSpreadSheetCellStyle
Applies a cell style to a cell or cell range in a worksheet
Set
OpenXmlSpreadSheetCellStyle
Applies a cell style to a cell or range of cells in a worksheet
Set-OpenXmlSpreadSheetCellStyle
Path
Specifies the path to the SpreadsheetML file(s) to modify
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
FromRow
Cell row (same value as ToRow if you are affecting a single cell) or Cell Range initial row
Int32
ToRow
Cell row (same value as FromRow if you are affecting a single cell) or Cell Range final row
Int32
FromColumn
Cell column (same value as ToColumn if you are affecting a single cell) or Cell Range initial column
Int16
ToColumn
Cell column (same value as FromColumn if you are affecting a single cell) or Cell Range final column
Int16
CellStyle
Name for cell style to apply to the cell or cell range
String
WorksheetName
Worksheet containing the cell or cell range to affect
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the SpreadsheetML file(s) to modify
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
FromRow
Cell row (same value as ToRow if you are affecting a single cell) or Cell Range initial row
Int32
Int32
ToRow
Cell row (same value as FromRow if you are affecting a single cell) or Cell Range final row
Int32
Int32
FromColumn
Cell column (same value as ToColumn if you are affecting a single cell) or Cell Range initial column
Int16
Int16
ToColumn
Cell column (same value as FromColumn if you are affecting a single cell) or Cell Range final column
Int16
Int16
CellStyle
Name for cell style to apply to the cell or cell range
String
String
WorksheetName
Worksheet containing the cell or cell range to affect
String
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Set-OpenXmlSpreadSheetCellValue
Set-OpenXmlSpreadSheetColumnWidth
Set-OpenXmlSpreadSheetCellValue
Set a value for a cell or a cell range in a worksheet
Set
OpenXmlSpreadSheetCellValue
Sets the values on a single cell or range of cells in a worksheet.
Set-OpenXmlSpreadSheetCellValue
Path
Specifies the path to the SpreadsheetML file(s) to modify
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
FromRow
Cell row (same value as ToRow if you are affecting a single cell) or Cell Range initial row
Int32
ToRow
Cell row (same value as FromRow if you are affecting a single cell) or Cell Range final row
Int32
FromColumn
Cell column (same value as ToColumn if you are affecting a single cell) or Cell Range initial column
Int16
ToColumn
Cell column (same value as FromColumn if you are affecting a single cell) or Cell Range final column
Int16
Value
Value to be set for the specified cell or cell range
String
WorksheetName
Worksheet containing the cell or cell range to affect
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the SpreadsheetML file(s) to modify
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
FromRow
Cell row (same value as ToRow if you are affecting a single cell) or Cell Range initial row
Int32
Int32
ToRow
Cell row (same value as FromRow if you are affecting a single cell) or Cell Range final row
Int32
Int32
FromColumn
Cell column (same value as ToColumn if you are affecting a single cell) or Cell Range initial column
Int16
Int16
ToColumn
Cell column (same value as FromColumn if you are affecting a single cell) or Cell Range final column
Int16
Int16
Value
Value to be set for the specified cell or cell range
String
String
WorksheetName
Worksheet containing the cell or cell range to affect
String
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Set-OpenXmlSpreadSheetCellStyle
Set-OpenXmlSpreadSheetColumnWidth
Set-OpenXmlSpreadSheetColumnWidth
Sets the width for a column or column range in a worksheet
Set
OpenXmlSpreadSheetColumnWidth
Sets the width for a column or column range in a worksheet
Set-OpenXmlSpreadSheetColumnWidth
Path
Specifies the path to the SpreadsheetML file(s) to modify
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
FromColumn
Cell column (same value as ToColumn if you are affecting a single column) or Range initial column
Int16
ToColumn
Cell column (same value as FromColumn if you are affecting a single column) or Range final column
Int16
Width
Width value to be set to column or column range
Int32
WorksheetName
Worksheet containing the column or column range to affect
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the SpreadsheetML file(s) to modify
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
FromColumn
Cell column (same value as ToColumn if you are affecting a single column) or Range initial column
Int16
Int16
ToColumn
Cell column (same value as FromColumn if you are affecting a single column) or Range final column
Int16
Int16
Width
Width value to be set to column or column range
Int32
Int32
WorksheetName
Worksheet containing the column or column range to affect
String
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Set-OpenXmlSpreadSheetCellStyle
Set-OpenXmlSpreadSheetCellValue
Set-OpenXmlString
Changes matching strings in a Wordprocessing document to a new value.
Set
OpenXmlString
This is the equivalent of search and replace of all matching strings in a document.
Set-OpenXmlString
Path
Specifies the path to the item(s) whose contents will be modified. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
Pattern
Specifies the string that represents the matching criteria.
String
Replace
Specifies the string that will be substituted wherever there is a match of the Pattern parameter.
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
CaseSensitive
Makes matches case sensitive. By default, matching is not case sensitive.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) whose contents will be modified. Wildcards are permitted. Do not use if documents are piped into this command.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
Pattern
Specifies the string that represents the matching criteria.
String
String
Replace
Specifies the string that will be substituted wherever there is a match of the Pattern parameter.
String
String
Document
Accepts OpenXML documents as input to the cmdlet. Use a variable that contains objects or pipe them from a cmdlet that returns documents.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
CaseSensitive
Makes matches case sensitive. By default, matching is not case sensitive.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Select-OpenXmlString
Set-OpenXmlStyle
Sets the style library for a Wordprocessing or a Spreadsheet document.
Set
OpenXmlStyle
The Set-OpenXmlStyle cmdlet replaces the style library in a Wordprocessing or Spreadsheet document.
Set-OpenXmlStyle
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
StylePath
Path of the styles library to use.
String
Style
An XDocument object containing the style library to set on the document.
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
StylePath
Path of the styles library to use.
String
String
Style
An XDocument object containing the style library to set on the document.
XDocument
XDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
XDocument or OpenXmlPowerToolsDocument
See Style or Document parameters.
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlStyle
Set-OpenXmlTheme
Sets a Wordprocessing document theme.
Set
OpenXmlTheme
The Set-OpenXmlTheme cmdlet sets the current theme in a Wordprocessing document to the specified theme.
Set-OpenXmlTheme
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
ThemePath
Path of thmx file with theme contents.
String
ThemePackage
Package document (OpenXmlPowerToolsDocument) that contains the theme definition and associated files.
OpenXmlPowerToolsDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
ThemePath
Path of thmx file with theme contents.
String
String
ThemePackage
Package document (OpenXmlPowerToolsDocument) that contains the theme definition and associated files.
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
See the ThemePackage or Document parameters.
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlTheme
Set-OpenXmlWatermark
Sets a watermark in a Wordprocessing document.
Set
OpenXmlWatermark
The Set-OpenXmlWatermark cmdlet adds watermark text to the background of a document. If the DiagonalOrientation parameter is specified, then the text will be in a diagonal orientation rather than horizontal.
Set-OpenXmlWatermark
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
WatermarkText
Text to display as the watermark.
String
DiagonalOrientation
Use this switch to display watermark with diagonal orientation. Horizontal orientation will be used otherwise.
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be modified. Wildcards are permitted. If you specify multiple paths, use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for modified documents. If this is not specified, the original document will be modified.
String
String
WatermarkText
Text to display as the watermark.
String
String
DiagonalOrientation
Use this switch to display watermark with diagonal orientation. Horizontal orientation will be used otherwise.
SwitchParameter
Document
Specifies the item(s) from the pipeline that will be modified by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
False
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
String or OpenXmlPowerToolsDocument
See WatermarkText or Document parameters.
OpenXmlPowerToolsDocument (if PassThru)
Get-OpenXmlWatermark
Split-OpenXmlDocument
Splits documents at section breaks.
Split
OpenXmlDocument
A new document is created for each section of the original documents. The prefix name is used to generate file names for each document.
Split-OpenXmlDocument
Path
Specifies the path to the item(s) to be split. Wildcards are permitted. If you specify multiple paths use commas to separate the paths.
String[]
OutputFolder
Destination folder for created documents.
String
Prefix
Specifies the prefix for the resulting split document files. A sequence number will be added to each file that is created.
String
Document
Specifies the item(s) from the pipeline that will be processed by this command.
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
Confirm
Prompts you for confirmation before overwriting a file.
Path
Specifies the path to the item(s) to be split. Wildcards are permitted. If you specify multiple paths use commas to separate the paths.
String[]
String[]
OutputFolder
Destination folder for created documents.
String
String
Prefix
Specifies the prefix for the resulting split document files. A sequence number will be added to each file that is created.
String
String
Document
Specifies the item(s) from the pipeline that will be processed by this command.
OpenXmlPowerToolsDocument[]
OpenXmlPowerToolsDocument[]
PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
SwitchParameter
WhatIf
Describes what files would be overwritten by this command, but does not overwrite the files.
SwitchParameter
Confirm
Prompts you for confirmation before overwriting a file.
SwitchParameter
OpenXmlPowerToolsDocument
OpenXmlPowerToolsDocument (if PassThru)
Merge-OpenXmlDocument