IRibbonExtensibility Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The interface through which the Ribbon user interface (UI) communicates with a COM add-in to customize the UI.
public interface class IRibbonExtensibility[System.Runtime.InteropServices.Guid("000C0396-0000-0000-C000-000000000046")]
public interface IRibbonExtensibility[<System.Runtime.InteropServices.Guid("000C0396-0000-0000-C000-000000000046")>]
type IRibbonExtensibility = interfacePublic Interface IRibbonExtensibility- Attributes
Examples
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;
}
Remarks
The IRibbonExtensibility interface has a single method, GetCustomUI.
Methods
| 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. |