IRibbonExtensibility IRibbonExtensibility IRibbonExtensibility Interface


The interface through which the Ribbon user interface (UI) communicates with a COM add-in to customize the UI.

public interface class IRibbonExtensibility
public interface IRibbonExtensibility
Public Interface IRibbonExtensibility


In the following example, written in C#, the IRibbonExtensibility interface is specified in the class definition. The procedure then implements the interfaces's only method, GetCustomUI. This method creates an instance of a SteamReader object that reads in the customized markup stored 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; 


The IRibbonExtensibility interface has a single method, GetCustomUI.


GetCustomUI(String) GetCustomUI(String) GetCustomUI(String)

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

Applies to