IRibbonExtensibility.GetCustomUI Method
Loads the XML markup, either from an XML customization file or from XML markup embedded in the procedure, that customizes the Ribbon user interface.
Namespace: Microsoft.Office.Core
Assembly: office (in office.dll)
Syntax
'Declaration
Function GetCustomUI ( _
RibbonID As String _
) As String
'Usage
Dim instance As IRibbonExtensibility
Dim RibbonID As String
Dim returnValue As String
returnValue = instance.GetCustomUI(RibbonID)
string GetCustomUI(
string RibbonID
)
Parameters
- RibbonID
Type: System.String
Return Value
Type: System.String
String
Examples
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.
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;
}