RetrieveLocLabelsRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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.

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

Inheritance Hierarchy

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

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveLocLabelsRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveLocLabelsRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod RetrieveLocLabelsRequest()

Initializes a new instance of the RetrieveLocLabelsRequest class.

Properties

Name Description
System_CAPS_pubproperty AttributeName

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

System_CAPS_pubproperty EntityMoniker

Gets or sets the entity. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty IncludeUnpublished

Gets or sets whether to include unpublished labels. Required.

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Crm.Sdk.Messages Namespace
Customize labels to support multiple languages
Localize product property values

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright