Office.IRibbonExtensibility.GetCustomUI.md

title	keywords	f1_keywords	api_name	ms.assetid	ms.date	ms.localizationpriority
IRibbonExtensibility.GetCustomUI method (Office)	vbaof11.chm289001	vbaof11.chm289001	Office.IRibbonExtensibility.GetCustomUI	a0106415-999e-94da-379c-70fb7aa6119f	01/16/2019	medium

IRibbonExtensibility.GetCustomUI method (Office)

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 (RibbonID)

expression An expression that returns an IRibbonExtensibility object.

Parameters

Name	Required/Optional	Data type	Description
RibbonID	Required	String	The ID for the RibbonX UI.

Return value

String

Remarks

For Word, Excel, PowerPoint, and Access, there is only one ID for each application. Outlook uses ribbon extensibility to customize not only the ribbon in an inspector, but also the ribbon in an explorer, in various context menus, in contextual tabs on a ribbon, and in the Microsoft Office Backstage view. In each of these scenarios, the developer specifies the custom UI in an XML file that is loaded when Office calls GetCustomUI with a specific ribbon ID.

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 StreamReader object that reads in the customization markup in an external XML file.

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; 
} 

See also

• IRibbonExtensibility object members

[!includeSupport and feedback]