Classe RetrieveEntityRibbonRequest

Article
12/01/2014

S'applique à: CRM 2015 on-prem, CRM Online

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

Espace de noms: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (dans Microsoft.Crm.Sdk.Proxy.dll)

Syntaxe

'Déclaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RetrieveEntityRibbonRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveEntityRibbonRequest : OrganizationRequest

Exemple

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.

//Retrieve system Entity Ribbons
RetrieveEntityRibbonRequest entRibReq = new RetrieveEntityRibbonRequest() { RibbonLocationFilter = RibbonLocationFilters.All };

foreach (System.String entityName in entitiesWithRibbons)
{
 entRibReq.EntityName = entityName;
 RetrieveEntityRibbonResponse entRibResp = (RetrieveEntityRibbonResponse)_serviceProxy.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.
 Console.WriteLine(entityRibbonPath);
}

Remarques

Message Availability

Pour que ce message fonctionne, l'appelant doit être connecté au serveur.

Usage

Pass an instance of this class to the Execute 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 Privileges.

Hiérarchie d'héritage

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RetrieveEntityRibbonRequest

Cohérence de thread

Tous les membres statiques publics (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres d'instance ne sont pas garantis thread-safe.

Plateformes

Plateformes de développement

Windows Vista, Windows Server 2003 et

Plateformes cibles

Windows Vista,Windows XP

Change History

Voir aussi

Référence

Membres RetrieveEntityRibbonRequest
Espace de noms Microsoft.Crm.Sdk.Messages

Autres ressources

Export Ribbon Definitions

Partager via