IRibbonExtensibility.GetCustomUI(String) Method

Reference

Definition

Namespace:: Microsoft.Office.Core

Assembly:: office.dll

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.

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

public:
 System::String ^ GetCustomUI(System::String ^ RibbonID);

public string GetCustomUI (string RibbonID);

abstract member GetCustomUI : string -> string

Public Function GetCustomUI (RibbonID As String) As String

Parameters

RibbonID: String

Returns

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

Applies to

Share via