UpdateOptionValueRequest Class

Definition

Contains the data that is needed to update an option value in a global or local option set.

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

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.

// In order to change labels on option set values (or delete) option set
// values, you must use UpdateOptionValueRequest 
// (or DeleteOptionValueRequest).
UpdateOptionValueRequest updateOptionValueRequest =
    new UpdateOptionValueRequest
    {
        OptionSetName = _globalOptionSetName,
        // Update the second option value.
        Value = optionList[1].Value.Value,
        Label = new Label("Updated Option 1", _languageCode)
    };
        svc.Execute(updateOptionValueRequest);

//Publish the OptionSet
PublishXmlRequest pxReq3 = new PublishXmlRequest { ParameterXml = String.Format("<importexportxml><optionsets><optionset>{0}</optionset></optionsets></importexportxml>", _globalOptionSetName) };
svc.Execute(pxReq3);

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.

optionsets#WorkwithGlobalOptionSets7 optionsetsVB#WorkwithGlobalOptionSets7

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges listed in UpdateOptionValue message privileges.

Notes for Callers

Constructors

UpdateOptionValueRequest()

Initializes a new instance of the UpdateOptionValueRequest class

Properties

AttributeLogicalName

Gets or sets the name of the attribute when updating a local option set in a picklist attribute. Optional.

Description

Gets or sets a description for the option. Optional.

EntityLogicalName

Gets or sets the logical name of the entity when updating the local option set in a picklist attribute. Optional.

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

Gets or sets the label for the option. Optional.

MergeLabels

Gets or sets whether to keep text defined for languages not included in the Label. Required.

OptionSetName

Gets or sets the name of the global option set. Optional.

Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
ParentValues
RequestId

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

(Inherited from OrganizationRequest)
RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
SolutionUniqueName

Gets or sets the name of the unmanaged solution that this global option set should be associated with. Optional.

Value

Gets or sets the value for the option. Required.

Applies to