RetrieveEntityRibbonRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class RetrieveEntityRibbonRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveEntityRibbonRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveEntityRibbonRequest = class
    inherit OrganizationRequest

Public NotInheritable Class RetrieveEntityRibbonRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
RetrieveEntityRibbonRequest

Attributes: DataContractAttribute

Examples

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 instance. For the complete sample, see the link later in this topic.

Remarks

For the Web API use the RetrieveEntityRibbon function.

Usage

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.

Constructors

RetrieveEntityRibbonRequest()

Initializes a new instance of the RetrieveEntityRibbonRequest class.

Properties

EntityName	Gets or sets the logical name of an entity in order to retrieve a ribbon definition. Required.
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 the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
RibbonLocationFilter	Gets or sets a filter to retrieve a specific set of ribbon definitions for an entity. Required.

Applies to

Share via