OrderOptionRequest Class
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the data that is needed to set the order for an option set.
For the Web API use the OrderOption Action.
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)
| Name | Description | |
|---|---|---|
![]() | OrderOptionRequest | Initializes a new instance of the OrderOptionRequest class |
| Name | Description | |
|---|---|---|
![]() | Gets or sets the logical name of the PicklistAttributeMetadata attribute. Optional. | |
![]() | Gets or sets the logical name of the entity that contains the attribute. Optional. | |
![]() | Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.) | |
![]() | Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.) | |
![]() | Gets or sets the name of the global option set you want to edit options for. Optional. | |
![]() | Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) | |
![]() | Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.) | |
![]() | Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) | |
![]() | Gets or sets the name of the solution you want to add the solution component to. Optional. | |
![]() | Gets or sets the array of option values in the wanted order. Required. |
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 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.
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.
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright

