This documentation is archived and is not being maintained.

IRibbonExtensibility.GetCustomUI Method

Office 2007

Loads the XML markup, either from an XML customization file or from XML markup embedded in the procedure, that customizes the Ribbon user interface.

Syntax

expression.GetCustomUI(bstrRibbonID)

expression An expression that returns a IRibbonExtensibility object.

Parameters

Name	Required/Optional	Data Type	Description
bstrRibbonID	Required	String	The ID for the RibbonX UI. For Word, Excel, PowerPoint, and Access, there is only one ID for each application. For Outlook, there will be one for each type of Inspector object.

Return Value
String

Example

In the following example, written in C#, the IRibbonExtensibility interface is specified in the class definition. The example then implements the interfaces's only method, GetCustomUI. The method creates an instance of a SteamReader object that reads in the customization markup in an external XML file.

C#
`public class Connect : Object, Extensibility.IDTExtensibility2, IRibbonExtensibility ... public string GetCustomUI(string RibbonID) { StreamReader customUIReader = new System.IO.StreamReader("C:\\RibbonXSampleCS\\customUI.xml"); string customUIData = customUIReader.ReadToEnd(); return customUIData; }`

public class Connect : Object, Extensibility.IDTExtensibility2, IRibbonExtensibility
...
public string GetCustomUI(string RibbonID)
{
   StreamReader customUIReader = new System.IO.StreamReader("C:\\RibbonXSampleCS\\customUI.xml");
   string customUIData = customUIReader.ReadToEnd();
   return customUIData;
}