OrderOptionRequest OrderOptionRequest OrderOptionRequest OrderOptionRequest Class

Definition

Contains the data that is needed to set the order for an option set.

For the Web API use the OrderOption Action.

public ref class OrderOptionRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class OrderOptionRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type OrderOptionRequest = class
    inherit OrganizationRequest
Public NotInheritable Class OrderOptionRequest
Inherits OrganizationRequest
Inheritance
OrderOptionRequestOrderOptionRequestOrderOptionRequestOrderOptionRequest
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 IOrganizationServiceinterface.

This sample shows how to change the order of options in a local option set. The following sample retrieves a custom PicklistAttributeMetadata attribute and changes the order of the original options using the OrderBy LINQ function to sort items in ascending order by the label text. Then it uses OrderOptionRequest to set the new order of the options for the attribute.

Use the OrderByDecending LINQ function to order the items in descending order.

// Use the RetrieveAttributeRequest message to retrieve  
// a attribute by it's logical name.
RetrieveAttributeRequest retrieveAttributeRequest =
    new RetrieveAttributeRequest
{
    EntityLogicalName = Contact.EntityLogicalName,
    LogicalName = "new_picklist",
    RetrieveAsIfPublished = true
};

// Execute the request. RetrieveAttributeResponse retrieveAttributeResponse =(RetrieveAttributeResponse)svc.Execute(retrieveAttributeRequest);

// Access the retrieved attribute. PicklistAttributeMetadata retrievedPicklistAttributeMetadata =(PicklistAttributeMetadata)retrieveAttributeResponse.AttributeMetadata;

// Get the current options list for the retrieved attribute. OptionMetadata[] optionList = retrievedPicklistAttributeMetadata.OptionSet.Options.ToArray();

// Change the order of the original option's list. // Use the OrderBy (OrderByDescending) linq function to sort options in
// ascending (descending) order according to label text. // For ascending order use this: var updateOptionList = optionList.OrderBy(x => x.Label.LocalizedLabels[0].Label).ToList();

// For descending order use this: var updateOptionList =optionList.OrderByDescending(x => x.Label.LocalizedLabels[0].Label).ToList();

// Create the request. OrderOptionRequest orderOptionRequest = new OrderOptionRequest { // Set the properties for the request. AttributeLogicalName = "new_picklist", EntityLogicalName = Contact.EntityLogicalName,

// Set the changed order using Select linq function 
// to get only values in an array from the changed option list.
Values = updateOptionList.Select(x => x.Value.Value).ToArray()

};

// Execute the request svc.Execute(orderOptionRequest); Console.WriteLine("Option Set option order changed");

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

This sample shows how to change the order of options in a local option set. The following sample retrieves a custom PicklistAttributeMetadata attribute and changes the order of the original options using the OrderBy LINQ function to sort items in ascending order by the label text. Then it uses OrderOptionRequest to set the new order of the options for the attribute.

Use the OrderByDecending LINQ function to order the items in descending order.

attributes#WorkWithAttributes8 attributesVB#WorkWithAttributes8

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

Privileges and Access Rights

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

Notes for Callers

You can use this message to edit options for global option sets or local option sets inside a PicklistAttributeMetadata attribute. For global option sets use the OptionSetName property. For local option sets specify the EntityLogicalName and the AttributeLogicalName.

Constructors

OrderOptionRequest() OrderOptionRequest() OrderOptionRequest() OrderOptionRequest()

Initializes a new instance of the OrderOptionRequest class

Properties

AttributeLogicalName AttributeLogicalName AttributeLogicalName AttributeLogicalName

Gets or sets the logical name of the PicklistAttributeMetadata attribute. Optional.

EntityLogicalName EntityLogicalName EntityLogicalName EntityLogicalName

Gets or sets the logical name of the entity that contains the attribute. Optional.

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
OptionSetName OptionSetName OptionSetName OptionSetName

Gets or sets the name of the global option set you want to edit options for. Optional.

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

Gets or sets the name of the solution you want to add the solution component to. Optional.

Values Values Values Values

Gets or sets the array of option values in the wanted order. Required.

Applies to