wordpress hit counter
Welcome to OpenXML Developer Sign in | Join | Help

Custom UI Editor Tool

LASTEST VERSION OF THE CUSTOM UI EDITOR - updated to work with the RTM build of Office 2007 and Beta build of Office 2010 - ATTACHED TO THIS POST

The 2007 Microsoft Office System has an all-new "ribbon" interface which developers can customize in many ways. One of the ways to extend the ribbon is to insert an XML part into an Office Open XML document that defines your custom UI. With this approach, you can add new groups and controls, hide existing ribbon elements, and define callbacks to handlers that you write in managed code.

The XML part is not part of the Open XML format itself but could be added to any XML document by using a new namespace. The Open XML file formats are fully extensible, so applications can store information like workflow, metadata, custom XML, or even custom UI behaviors in a document that aren't necessarily tied to the document content.

Adding your custom-UI part to an Office Open XML document requires that you create a folder within the package, drop in your part, then define a relationship to the new part. For more information about how it all works, check out this technical artice or the "Extending the Office 2007 UI with a Custom Ribbon" screencast on this page.

custom UI editor

Attached to this post is a great utility for working with ribbon customizations stored in Office Open XML documents: Trang Luu's custom UI editor. It's a Windows tool that automates the process of putting your custom UI part into the package and defining a relationship to it: that's all handled by a single mouse click.

You open an existing document with File/Open, then enter your custom UI XML into the main edit box. (Click the image to the right for a full screen shot.) Other options include inserting icons for your custom control, generating callbacks, and validating your custom XML.

Install the tool and try it out, and if you have any questions about using it you can post them right here.

Comments

 

pdanes said:

Looks great, a fantastic idea, but it doesn't work for me. I followed the instructions to the letter, but the new tab doesn't appear in the document.
November 26, 2009 2:07 PM
 

JSRW said:

This version doesn't seem to work for me either. The previous version worked great.
December 20, 2009 12:24 PM
 

moses said:

Excellent tool. Worked gr8 by me. Note that any mistake will cause the new tab not to appear. The best way is to check each new line of code piecemeal, i.e. add a tab and then check it in Office, add a group and check it, etc.
December 21, 2009 10:49 AM
 

Dirus said:

The new tool did not work for me either, but I found a workaround.  When you add a new UI part you will notice that it is named customUI14.xml on the left hand side.  If you were using the schema with dates 2006/01 you will  need to add another UI part and it will be named customUI.xml.  I removed the initial UI part and used the correctly named customUI.xml one and I was fine going forward.
January 6, 2010 11:05 AM
 

abhinav said:

The sample xml templates provided with the tool are targeted only for Office 2010 documents. Adding one more set of sample xml files for Office 2007 would help avoid ambiguity and namespace mismatch errors that lot of users currently face.
Also, the screenshot of the tool's UI needs updatiion :)
January 7, 2010 4:41 PM
 

snoopen said:

Would be great if you could release the source under GPL licence or something similar. I'm sure there are a few people who would be willing to add more functionality to the editor! Such as a Find function :)
January 31, 2010 11:31 PM
 

snoopen said:

I will also point out that there is a bug in this. If the "Samples" folder is missing the program will crash when expanding the Insert menu.
February 2, 2010 5:54 PM
 

peterennis said:

Windows 7 64bit Ultimate. Installed 32 bit Office 2010 RC.
Installed latest Custom UI Editor.
Open / Sample / Excel...
"Corrupted data..."

Insert Sample XML,
"Unhandled exception..."
for any data sample.

Seems like the latest RC breaks the program.
February 6, 2010 10:07 PM
Anonymous comments are disabled