RibbonManager.GetCustomUI Method

This API supports the Visual Studio Tools for Office infrastructure and is not intended to be used directly from your code.

Implements the GetCustomUI method of the Microsoft.Office.Core.IRibbonExtensibility interface.

Namespace:  Microsoft.Office.Tools.Ribbon
Assembly:  Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)

Syntax

'Declaration
Public Function GetCustomUI ( _
    ribbonId As String _
) As String
'Usage
Dim instance As RibbonManager
Dim ribbonId As String
Dim returnValue As String

returnValue = instance.GetCustomUI(ribbonId)
public string GetCustomUI(
    string ribbonId
)

Parameters

  • ribbonId
    Type: System.String
    The ID of the Ribbon that is being requested by the Microsoft Office application.

Return Value

Type: System.String
An XML string that defines the user interface of a Ribbon in your project that matches the ribbonId parameter.

Implements

IRibbonExtensibilityGetCustomUI(String)

Remarks

You should not call this method directly in your own code. Microsoft Office applications call this method to get an XML string that describes the UI of a Ribbon customization.

.NET Framework Security

See Also

Reference

RibbonManager Class

RibbonManager Members

Microsoft.Office.Tools.Ribbon Namespace