RetrieveEntityRibbonRequest Klasse

Artikel
07/17/2015

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

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<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

Beispiel

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);
}

Anmerkungen

Message Availability

Damit diese Meldung funktioniert, muss der Anrufer mit dem Server verbunden sein.

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.

Vererbungshierarchie

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

Thread-Sicherheit

Alle öffentlichen statischen Mitglieder (Shared in Visual Basic) dieses Typs sind thread-sicher. Bei Instanzmitgliedern kann keine Garantie für die Thread-Sicherheit übernommen werden.

Plattformen

Development Platforms

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Target Platforms

Windows Server 2008,Windows Server 2012,Windows 7

Change History

Siehe auch

Referenz

RetrieveEntityRibbonRequest Mitglieder
Microsoft.Crm.Sdk.Messages Namespace

Weitere Ressourcen

Export Ribbon Definitions

Freigeben über