Detailed Description of PowerTools for Open XML cmdlets
This post contains a detailed description of each of the PowerTools for Open XML cmdlets. For an overview and screen cast of PowerTools for Open XML, see Automated Processing of Open XML Documents using PowerShell. For more information on the cmdlets, see: www.codeplex.com/powertools.
This blog is inactive.
New blog: EricWhite.com/blog
Blog TOCAccept-OpenXmlChange
The Accept-OpenXmlTextChange cmdlet processes documents with text revisions (change tracking elements), by accepting all the text changes performed on the document.
Add-OpenXmlContent
The Add-OpenXmlContent cmdlet injects XML markup into a specified custom XML part from a Wordprocessing document
Add-OpenXmlDigitalSignature
The Add-OpenXmlDigitalSignature cmdlet uses a digital certificate to digitally sign 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-OpenXmlDocumentTOC
The Add-OpenXmlDocumentTOC cmdlet creates a Table of Contents based on the headings found it in the document. The TOC will be created at the end of the 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-OpenXmlDocumentTOA
The Add-OpenXmlDocumentTOA cmdlet creates a Table of Authorities based on the citations (references or authorities) found it in the document. The TOA will be created at the end of the document.
Add-OpenXmlDocumentTOF
The Add-OpenXmlDocumentTOF cmdlet creates a Table of Figures based on the figures found it in the document. The TOF will be created at the end of the document.
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-OpenXmlToHtml
The Export-OpenXmlToHtml cmdlet transforms the content of Wordprocessing documents into an html file by applying an XSLT transformation over the main content and extracting images from the package to a given location.
Export-OpenXmlWordprocessing
The Export-OpenXmlWordprocessing uses plain text to create 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-OpenXmlComment
The Get-OpenXmlComment extracts all the comments from a document, and return all of them in a XDocument
Get-OpenXmlCustomXmlData
The Get-OpenXmlCustomXmlData cmdlet gets the first customXml part that matches the given name and returns it as an XDocument object.
Get-OpenXmlDigitalSignature
The Get-OpenXmlDigitalSignature cmdlet returns a summary of digital signatures present in the Wordprocessing document
Get-OpenXmlDocument
The Get-OpenXmlDocument cmdlet returns an OpenXML document object for each document file. The actual object will depend on the type of document in the file. For example, if it is a spreadsheet, the object will be a SpreadsheetDocument, which is derived from OpenXMLDocument.
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-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-OpenXmlStyle
The Get-OpenXmlStyle cmdlet retrieves the styles definition part from a WordprocessingML or SpreadsheetML document and returns an XDocument object containing the styles content.
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 (System.IO.Packaging.Package) is returned that corresponds to the theme file.
Get-OpenXmlWatermark
The Get-OpenXmlWatermark cmdlet retrieves the text of the document's watermark.
Lock-OpenXmlDocument
The Lock-OpenXmlDocument cmdlet sets a lock inside one or more Wordprocessing documents to prevent them from being edited.
Merge-OpenXmlDocument
The Merge-OpenXmlDocument cmdlet creates a new Open XML word processing document from ranges of paragraphs in one or more existing documents.
Remove-OpenXmlComment
The Remove-OpenXmlComment cmdlet locates and removes comment contents and references from Wordprocessing documents.
Remove-OpenXmlDigitalSignature
The Remove-OpenXmlDigitalSignature cmdlet removes digital signatures from a Wordprocessing document
Select-OpenXmlString
The Select-OpenXmlString cmdlet searchs for paragraphs in a word processing document. You can search based on style name or on the contents of paragraphs.
Set-OpenXmlBackground
The Set-OpenXmlBackground cmdlet changes the background image or background color of 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-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-OpenXmlCustomXmlData
The Set-OpenXmlCustomXmlData cmdlet sets or replaces the specified custom XML part in the document.
Set-OpenXmlFooter
The Set-OpenXmlFooter cmdlet inserts footer parts into all sections of a Wordprocessing document.
Set-OpenXmlHeader
The Set-OpenXmlHeader cmdlet inserts header parts into all sections of a Wordprocessing document.
Set-OpenXmlStyle
The Set-OpenXmlStyle cmdlet replaces the style library in a WordprocessingML or SpreadsheetML document.
Set-OpenXmlTheme
The Set-OpenXmlTheme cmdlet sets the current theme in a Wordprocessing document to the specified theme.
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.
Comments
Anonymous
November 18, 2008
PingBack from http://www.tmao.info/detailed-description-of-powertools-for-open-xml-cmdlets/Anonymous
November 19, 2008
Eric White from Microsoft DPE has published this interesting post describing the list of cmdlets included in the first version of "Power Tools for Open Xml" (a set of cmdlets for PowerShell to create and modify Open Xml based documents).&amAnonymous
November 19, 2008
Eric White from Microsoft DPE has published this interesting post describing the list of cmdlets included in the first version of "Power Tools for Open Xml" (a set of cmdlets for PowerShell to create and modify Open Xml based documents). ..Anonymous
November 19, 2008
Eric White de Microsoft DPE ha publicado una lista detallada de los cmdlets incluidos en la primer versión de la herramienta "Power Tools for Open Xml" (un conjunto de cmdlets para PowerShell que permite crear y modificar documentos b ..Anonymous
November 24, 2008
Comme à l'accoutumé, voici une brochette de liens de la semaine sur Open XML. Posts techniques en vracAnonymous
December 09, 2008
If you've been at one of the recent DII workshops, you may recall that some of us from Microsoft haveAnonymous
March 19, 2009
Today, Eric in the team released PowerTools for Open XML V1.1 . PowerTools for Open XML is an open sourceAnonymous
April 10, 2009
Today, I’m pleased to announce the release of PowerTools for Open XML V1.1. PowerTools for Open XML is