CreateOptionSetRequest CreateOptionSetRequest CreateOptionSetRequest CreateOptionSetRequest Class

Definition

Contains the data that is needed to create a new global option set.

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

#region How to create global option set
// Define the request object and pass to the service.
CreateOptionSetRequest createOptionSetRequest = new CreateOptionSetRequest
{
    // Create a global option set (OptionSetMetadata).
    OptionSet = new OptionSetMetadata
    {
        Name = _globalOptionSetName,
        DisplayName = new Label("Example Option Set", _languageCode),
        IsGlobal = true,
        OptionSetType = OptionSetType.Picklist,
        Options = 
    {
        new OptionMetadata(new Label("Open", _languageCode), null),
        new OptionMetadata(new Label("Suspended", _languageCode), null),
        new OptionMetadata(new Label("Cancelled", _languageCode), null),
        new OptionMetadata(new Label("Closed", _languageCode), null)
    }
    }
};

// Execute the request. CreateOptionSetResponse optionsResp = (CreateOptionSetResponse)svc.Execute(createOptionSetRequest);

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#WorkwithGlobalOptionSets2 OptionSetsVB#WorkwithGlobalOptionSets2

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

Privileges and Access Rights

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

Notes for Callers

Constructors

CreateOptionSetRequest() CreateOptionSetRequest() CreateOptionSetRequest() CreateOptionSetRequest()

Initializes a new instance of the CreateOptionSetRequest class.

Properties

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

Gets or sets the definition of the global option set. Required.

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 unmanaged solution you want to add this global option set to. Optional.

Applies to