RetrieveEntityRibbonRequest RetrieveEntityRibbonRequest RetrieveEntityRibbonRequest RetrieveEntityRibbonRequest Class


Contains the data that is needed to retrieve ribbon definitions for an entity.

For the Web API use the RetrieveEntityRibbon Function.

public ref class RetrieveEntityRibbonRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
public sealed class RetrieveEntityRibbonRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RetrieveEntityRibbonRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveEntityRibbonRequest
Inherits OrganizationRequest


//Retrieve system Entity Ribbons

var entRibReq = new RetrieveEntityRibbonRequest() { RibbonLocationFilter = RibbonLocationFilters.All };
foreach (System.String entityName in entitiesWithRibbons)

 entRibReq.EntityName = entityName;
 RetrieveEntityRibbonResponse entRibResp = (RetrieveEntityRibbonResponse)svc.Execute(entRibReq);
 System.String entityRibbonPath = Path.GetFullPath(exportFolder + "\\" + entityName + "Ribbon.xml");
 File.WriteAllBytes(entityRibbonPath, unzipRibbon(entRibResp.CompressedEntityXml));
 //Write the path where the file has been saved.

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

ExportRibbonXml#ExportRibbonXml4 ExportRibbonXmlVB#ExportRibbonXml4


Message Availability

For this message to work, the caller must be connected to the server.


Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the RetrieveEntityRibbonResponse class.

Privileges and Access Rights

To perform this action, the caller must have the required privileges, as listed in RetrieveEntityRibbon message privileges.


RetrieveEntityRibbonRequest() RetrieveEntityRibbonRequest() RetrieveEntityRibbonRequest() RetrieveEntityRibbonRequest()

Initializes a new instance of the RetrieveEntityRibbonRequest class.


EntityName EntityName EntityName EntityName

Gets or sets the logical name of an entity in order to retrieve a ribbon definition. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RibbonLocationFilter RibbonLocationFilter RibbonLocationFilter RibbonLocationFilter

Gets or sets a filter to retrieve a specific set of ribbon definitions for an entity. Required.

Applies to