RetrieveApplicationRibbonRequest Class

Definition

Contains the data that is needed to retrieve the data that defines the content and behavior of the application ribbon.

For the Web API use the RetrieveApplicationRibbon Function.

public ref class RetrieveApplicationRibbonRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveApplicationRibbonRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveApplicationRibbonRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveApplicationRibbonRequest
Inherits OrganizationRequest
Inheritance
RetrieveApplicationRibbonRequest
Attributes

Examples


//Retrieve the Appliation Ribbon

var appribReq = new RetrieveApplicationRibbonRequest();
var appribResp = (RetrieveApplicationRibbonResponse)svc.Execute(appribReq);
System.String applicationRibbonPath = Path.GetFullPath(exportFolder + "\\applicationRibbon.xml");
File.WriteAllBytes(applicationRibbonPath, unzipRibbon(appribResp.CompressedApplicationRibbonXml));

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#ExportRibbonXml3 ExportRibbonXmlVB#ExportRibbonXml3

Remarks

Message Availability

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

Usage

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

Privileges and Access Rights

To perform this action, the caller must have the privileges that are listed in RetrieveApplicationRibbon message privileges.

Notes for Callers

Constructors

RetrieveApplicationRibbonRequest()

Initializes a new instance of the RetrieveApplicationRibbonRequest class.

Properties

ExtensionData

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

(Inherited from OrganizationRequest)
Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters

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

(Inherited from OrganizationRequest)
RequestId

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

(Inherited from OrganizationRequest)
RequestName

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

(Inherited from OrganizationRequest)

Applies to