Sample: Export ribbon definitions

Article
08/22/2023

This sample shows how to export ribbon definitions. It uses the SDK for .NET RetrieveApplicationRibbonRequest and RetrieveEntityRibbonRequest classes.

SDK for .NET: Export ribbon definitions sample code

How to run this sample

Download or clone the Samples repo so that you have a local copy.
(Optional) Edit the dataverse/App.config file to define a connection string specifying the Microsoft Dataverse instance you want to connect to.
Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in dataverse/App.config, any sample you run will use that connection information.

If you do not specify a connection string in dataverse/App.config file, a dialog will open each time you run the sample and you will need to enter information about which Dataverse instance you want to connect to and which credentials you want to use. This dialog will cache previous connections so that you can choose a previously used connection.

Those samples in this repo that require a connection to a Dataverse instance to run will include a linked reference to the dataverse/App.config file.

What this sample does

The RetrieveApplicationRibbon message is intended to be used in a scenario where it contains data that is needed to retrieve the data that defines the content and behavior of the application ribbon. The RetrieveEntityRibbon message is intended to be used in a scenario where it contains data that is needed to retrieve ribbon definitions for a table.

How this sample works

In order to simulate the scenario described in What this sample does, the sample will do the following:

Setup

Checks for the current version of the org.

Demonstrate

The RetrieveApplicationRibbon message retrieves the application ribbon.
The RetrieveEntityRibbon message retrieves the system table ribbons

Clean up

No clean up is required for this sample