PowerTools for Open XML

Created Issue: Create a cmdlet to extract paragraphs from a document

bmcclellan — Sat, 22 Nov 2008 22:19:26 GMT

This cmdlet will get a range of paragraphs from an existing document and output a new document with just that range of paragraphs. The code supporting this cmdlet will need to deal with ranges and references within those paragraphs. For example, comments and bookmarks can cross paragraph boundries, so these "ranges" need to be fixed if only part of the range is extracted from the document. Paragraphs may contain many external references (e.g. images, styles, and footnotes). These referenced objects must be copied to the new document with the paragraphs.

Created Issue: Create an improved, more efficient, test suite

bmcclellan — Sat, 22 Nov 2008 21:59:23 GMT

The current test suite has a separate document for each test script. Also, the documents are too simple to really test the capabilities of the cmdlets.

Create a few documents that are larger and more complex along with test scripts that use those documents. The resulting tests should more thoroughly test the cmdlet's functionality. Scripts could also test multiple variations of a cmdlet instead of having each variation in a separate script.

Created Issue: Add a parameter to Add-OpenXmlDocumentIndex/TOA/TOC/TOF to update only

bmcclellan — Sat, 22 Nov 2008 21:48:46 GMT

This parameter would cause the existing table or index to be updated by the cmdlet, rather than another one being created. Currently, if this is executed twice for the same document, it will create two tables or indexes.

Created Issue: Add Section parameter for Set-OpenXmlFooter and Set-OpenXmlHeader

bmcclellan — Sat, 22 Nov 2008 21:44:58 GMT

Currently, these cmdlets will only change the header or footer in the first Section of the document (or create a section, if there is not one currently). Instead, add a parameter to specify a section, by number. 1 would be the first section, 2 the second, and so on. If the parameter is not specified, the default is 1, so that it works as it does now.

Updated Wiki: Home

EricWhiteDpe — Tue, 18 Nov 2008 13:35:10 GMT

Combining the technologies of PowerShell and Open XML is a powerful and convenient way to do server-side document processing. The PowerTools for Open XML are sample source code and guidance for developers showing how to build PowerShell cmdlets that can create and modify Open XML documents. Also included are a number of examples of PowerShell scripts that use the cmdlets.

To install and use the PowerTools for Open XML:

You need to have any edition (including Visual C# 2008 Express Edition) of Visual Studio 2008 installed. You can download Express Edition at http://www.microsoft.com/express/download/.
You need to have PowerShell 1.0 installed. You can download PowerShell at http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx.
PowerTools for Open XML is built using the Open XML SDK. You can download the SDK at http://go.microsoft.com/fwlink/?LinkId=120908.
You also need the PowerTools source code, which is available in the "Releases" tab above.

PowerTools for Open XML Home Page: http://blogs.msdn.com/ericwhite/pages/PowerTools.aspx

Set-OpenXmlCustomXmlData

The Set-OpenXmlCustomXmlData cmdlet sets or replaces the specified custom XML part in the document.

Remove-OpenXmlComment

The Remove-OpenXmlComment cmdlet locates and removes comment contents and references from Wordprocessing documents.

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-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.

Set-OpenXmlWatermark

The Set-OpenXmlWatermark cmdlet adds watermark text to the background of a document. iI the DiagonalOrientation parameter is specified, then the text will be in a diagonal
orientation rather than horizontal.

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.

Set-OpenXmlHeader

The Set-OpenXmlHeader cmdlet inserts header parts into all sections of a Wordprocessing document.

Lock-OpenXmlDocument

The Lock-OpenXmlDocument cmdlet sets a lock inside one or more Wordprocessing documents to prevent them from being edited.

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.

Accept-OpenXmlChange

The Accept-OpenXmlTextChange cmdlet processes documents with text revisions (change tracking elements), by accepting all the text changes performed on the document.

Set-OpenXmlBackground

The Set-OpenXmlBackground cmdlet changes the background image or background color of a Wordprocessing document.

Get-OpenXmlComment

The Get-OpenXmlComment extracts all the comments from a document, and return all of them in a XDocument

Add-OpenXmlDigitalSignature

The Add-OpenXmlDigitalSignature cmdlet uses a digital certificate to digitally sign a 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-OpenXmlCustomXmlData

The Get-OpenXmlCustomXmlData cmdlet gets the first customXml part that matches the given name and returns it as an XDocument object.

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.

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.

Set-OpenXmlStyle

The Set-OpenXmlStyle cmdlet replaces the style library in a WordprocessingML or SpreadsheetML document.

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-OpenXmlDigitalSignature

The Get-OpenXmlDigitalSignature cmdlet returns a summary of digital signatures present in the Wordprocessing document

Set-OpenXmlTheme

The Set-OpenXmlTheme cmdlet sets the current theme in a Wordprocessing document to the specified theme.

Remove-OpenXmlDigitalSignature

The Remove-OpenXmlDigitalSignature cmdlet removes digital signatures from a Wordprocessing document

Add-OpenXmlContent

The Add-OpenXmlContent cmdlet injects custom xml markup inside a given part from a Wordprocessing document

Export-OpenXmlWordprocessing

The Export-OpenXmlWordprocessing uses plain text to create 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-OpenXmlFooter

The Set-OpenXmlFooter cmdlet inserts footer parts into all sections of a Wordprocessing document.

Get-OpenXmlWatermark

The Get-OpenXmlWatermark cmdlet retrieves the text of the document's watermark.

Get-OpenXmlBackground

The Get-OpenXmlBackground cmdlet extracts the background (color or image) from a document according to the parameters Image or Color.

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.

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.

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.

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.

If you have any issues with downloading, building, or using the PowerTools for Open XML, please feel free to contact Eric White: white.eric (at) microsoft.com

Updated Release: PowerTools for Open XML 1.0 (Jun 11, 2008)

bmcclellan — Mon, 10 Nov 2008 01:31:23 GMT

First release of the PowerTools cmdlets.

Released: PowerTools for Open XML 1.0 (Jun 11, 2008)

Mon, 10 Nov 2008 01:31:22 GMT

First release of the PowerTools cmdlets.

New Post: Export-OpenXmlToHtml cmdlet

bmcclellan — Sun, 09 Nov 2008 19:56:40 GMT

Sorry for the slow reply...

The error seems to indicate that the folder "htmlOut" does not exist. The cmdlet will not create a folder if it does not already exist.

New Post: Bug in WatermarkAccesor::InsertWatermark?

bmcclellan — Sun, 09 Nov 2008 19:51:46 GMT

I think you're correct. The change will be included in the next version.

Updated Wiki: Home

bmcclellan — Mon, 03 Nov 2008 04:05:27 GMT

You need to have any edition (including Visual C# 2008 Express Edition) of Visual Studio 2008 installed. You can download Express Edition at http://www.microsoft.com/express/download/.
You need to have PowerShell 1.0 installed. You can download PowerShell at http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx.
PowerTools for Open XML is built using the Open XML SDK. You can download the SDK at http://go.microsoft.com/fwlink/?LinkId=120908.
You also need the PowerTools source code, which is available in the "Releases" tab above.

PowerTools for Open XML Home Page: http://blogs.msdn.com/ericwhite/pages/PowerTools.aspx

If you have any issues with downloading, building, or using the PowerTools for Open XML, please feel free to contact Eric White: white.eric (at) microsoft.com

Updated Wiki: Home

bmcclellan — Mon, 03 Nov 2008 04:03:56 GMT

You need to have any edition (including C# Express Edition) of Visual Studio 2008 installed. You can download Express Edition at http://www.microsoft.com/express/download/.
You need to have PowerShell 1.0 installed. You can download PowerShell at http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx.
PowerTools for Open XML is built using the Open XML SDK. You can download the SDK at http://go.microsoft.com/fwlink/?LinkId=120908.
You also need the PowerTools source code, which is available in the "Releases" tab above.

New Post: Get Power Tools for Open Xml Binaries Here

johanngranados — Thu, 11 Sep 2008 23:57:15 GMT

Hi,

You can get latest Power Tools for Open Xml Binaries (regularly updated) from here: http://staffdotnet.com/services/powertools.html

Best regards,

Johann Granados
Staff DotNet

New Post: Can we get a binary?

johanngranados — Thu, 11 Sep 2008 23:43:17 GMT

Hello,

I'm sorry to be so late with this reply (because by reading your posts I guess you have already created the Open Xml Power Tools binaries). However, for future releases you can get latest binaries for Power Tools from here: http://staffdotnet.com/services/powertools.html

Best regards,

Johann Granados
Staff DotNet

New Post: Can we get a binary?

halr9000 — Thu, 11 Sep 2008 22:57:06 GMT

FWIW, I did figure it out. I removed and re-added the reference and it worked fine. Anyway..$0$0$0$0I think others would appreciate a binary :)$0

New Post: Can we get a binary?

halr9000 — Thu, 11 Sep 2008 22:46:36 GMT

I grabbed all the prereqs and I get this err: $0$0Error 1 The type or namespace name 'DocumentFormat' could not be found (are you missing a using directive or an assembly reference?) C:\Documents and Settings\hrottenberg\My Documents\Visual Studio 2008\Projects\OpenXML PowerTools\Cmdlets\OpenXmlCmdlet.cs 19 7 OpenXml Power Tools$0$0$0$0$0Is it required to reboot after installing the SDK? That wouldna't make any sense. I see the reference for DocumentFormat.OpenXml with an exclamation point. It's pretty obvious what the problem is, but not obvious what I need to do about it. Help pretty please?$0$0

New Post: Can we get a binary?

halr9000 — Thu, 11 Sep 2008 22:35:14 GMT

I'm well known for my laziness in not wanting to setup build environments, ask anybody. (Which is actually kinda funny because I have vs2008 full plus several other IDE/ISE's installed.) I'm not a dev and I don't like changing to that mode, it makes my brain uncomfortable. :)$0$0$0$0I'd like to see some binaries released if you guys can do that.$0

New Post: New SpreadSheetML cmdlets available

johanngranados — Thu, 04 Sep 2008 23:36:12 GMT

Hello,

I just want to let you know that there are new available cmdlets for performing the following operations on SpreadSheetML documents:
-Adding table definitions to worksheets
-Setting values for cells
-Setting styles for cells
-Setting width for columns

More information and a sample script here: http://blogs.staffdotnet.com/johanngranados/blog/default.aspx?id=9&t=New-SpreadSheetML-cmdlets-at-Power-Tools

Johann Granados
Staff DotNet

Source code checked in, #15482

johanngranados — Thu, 04 Sep 2008 05:29:39 GMT

Update help file for new and modified cmdlets at change set 15480 Author: Johann Granados Company: Staff DotNet Email: johann.granados@staffdotnet.com Date: 9/3/2008

Source code checked in, #15480

johanngranados — Thu, 04 Sep 2008 01:57:06 GMT

Adding the following new cmdlets: Add-OpenXmlSpreadSheetTable Set-OpenXmlSpreadSheetColumnWidth Set-OpenXmlSpreadSheetCellValue Set-OpenXmlSpreadSheetCellStyle Modifying Export-OpenXmlSpreadsheet to accept -InitialRow parameter Modifying Get-OpenXmlStyle and Set-OpenXmlStyle to support SpreadSheetML Author: Johann Granados Company: Staff DotNet Email: johann.granados@staffdotnet.com Date: 9/2/2008

New Post: Export-OpenXmlToHtml cmdlet

kenjiii — Wed, 20 Aug 2008 14:37:28 GMT

Hi,

Thank you for the quick reply Roger! I used the binairies from http://staffdotnet.com/services/powertools.html. I still have this error when i'm using full path.

PS C:\PS> Export-OpenXmlToHtml -Path 'cyberlex.docx' -HtmlOutputName 'default.html' -OutputPath 'C:\PS' -XslPath 'c:\ps\DocX2Html.xsl'
Export-OpenXmlToHtml : L'argument spécifié n'était pas dans les limites de la plage des valeurs valides.
Nom du paramètre : id
At line:1 char:21
+ Export-OpenXmlToHtml <<<< -Path 'cyberlex.docx' -HtmlOutputName 'default.html' -OutputPath 'C:\PS' -XslPath 'c:\ps\DocX2Html.xsl'