Expand Minimize

DocumentBase.CreateRibbonExtensibilityObject Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Returns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

protected virtual IRibbonExtensibility CreateRibbonExtensibilityObject()

Return Value

Type: Microsoft.Office.Core.IRibbonExtensibility
An object that implements the Microsoft.Office.Core.IRibbonExtensibility interface.

Override this method to return an implementation of the Microsoft.Office.Core.IRibbonExtensibility interface. If you have multiple Ribbons in your project, you can specify which Ribbons to display at run time.

You do not have to override this method to return Ribbons that you add to the project by using the Ribbon (Visual Designer) item template. By default, this method returns a RibbonManager object that represents all Ribbon (Visual Designer) items in the project. For more information, see Ribbon Overview.

You must override the CreateRibbonExtensibilityObject or RequestService method to return Ribbons in your project that you add by using the Ribbon (XML) item template. For more information about how to override the CreateRibbonExtensibilityObject method, see Ribbon XML.

The following code example overrides the CreateRibbonExtensibilityObject method in the ThisAddin or ThisDocument class of the project and returns the Ribbon that you want to display. The example requires that you add two Ribbons to your project called Ribbon1 and Ribbon2 by using the Ribbon (Visual Designer) item. The example checks the value of a field named myCondition and returns the appropriate Ribbon. To use this example, run it from the ThisDocument class in a document-level project.

    protected override Microsoft.Office.Core.IRibbonExtensibility
CreateRibbonExtensibilityObject()
    {
        if (myCondition == true)
        {
            return Globals.Factory.GetRibbonFactory().CreateRibbonManager(
                new Microsoft.Office.Tools.Ribbon.IRibbonExtension[] { new Ribbon1() });
        }
        else
        {
            return Globals.Factory.GetRibbonFactory().CreateRibbonManager(
                new Microsoft.Office.Tools.Ribbon.IRibbonExtension[] { new Ribbon2() });
        }
    }

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft