RetrieveLocLabelsRequest RetrieveLocLabelsRequest RetrieveLocLabelsRequest RetrieveLocLabelsRequest Class

Definition

Contains the data that is needed to retrieve localized labels for a limited set of entity attributes.

For the Web API use the RetrieveLocLabels Function.

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

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

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

Privileges and Access Rights

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

Notes for Callers

This message only retrieves the localized display names for specific entity attributes or localizable properties. It can’t retrieve localized labels that are used for other application user interface areas, such as the labels that are used in the ribbon or form elements.

Supported Entities

This message only supports the following entity attributes or localized property values

  • DynamicProperty.Name

  • DynamicPropertyOptionSetItem.DynamicPropertyOptionName

  • DynamicPropertyOptionSetItem.DynamicPropertyOptionDescription

  • Product.Name

  • SavedQuery.Description

  • SavedQuery.Name

  • SavedQueryVisualization.Description

  • SavedQueryVisualization.Name

  • SystemForm.Description

  • SystemForm.Name

  • TimeZoneDefinition.UserInterfaceName

  • TimeZoneDefinition.StandardName

  • TimeZoneLocalizedName.UserInterfaceName

Constructors

RetrieveLocLabelsRequest() RetrieveLocLabelsRequest() RetrieveLocLabelsRequest() RetrieveLocLabelsRequest()

Initializes a new instance of the RetrieveLocLabelsRequest class.

Properties

AttributeName AttributeName AttributeName AttributeName

Gets or sets the name of the attribute for which to retrieve the localized labels. Required.

EntityMoniker EntityMoniker EntityMoniker EntityMoniker

Gets or sets the entity. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
IncludeUnpublished IncludeUnpublished IncludeUnpublished IncludeUnpublished

Gets or sets whether to include unpublished labels. Required.

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)

Applies to