Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetCustomUI method
Collapse the table of content
Expand the table of content

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)

[DispIdAttribute()]
string GetCustomUI(
	string RibbonID
)

Parameters

RibbonID
Type: System.String

Return value

Type: System.String
String

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; 
}
Show:
© 2015 Microsoft