Work with choices

This sample shows how to work with choices. Typically, you use choices to set columns so that different columns can share the same set of options, which are maintained in one location. Unlike local options sets which are defined only for a specific column, you can reuse choices. You will also see them used in request parameters in a manner similar to an enumeration.

When you define a choices column by using CreateOptionSetRequest, we recommend that you let the system assign a value. You do this by passing a null value when you create the new OptionMetadata instance. When you define an option, it will contain an option value prefix specific to the context of the publisher set for the solution that the choices column is created in. This prefix helps reduce the chance of creating duplicate choices for a managed solution, and in any choices column that are defined in organizations where your managed solution is installed. For more information, see Merge choices values.

Use the following message request classes to work with choices:

• CreateOptionSetRequest
• DeleteOptionSetRequest
• RetrieveAllOptionSetsRequest
• RetrieveOptionSetRequest
• UpdateOptionSetRequest

Use the following message request classes with choices:

• DeleteOptionValueRequest
• InsertOptionValueRequest
• InsertStatusValueRequest
• OrderOptionRequest
• UpdateOptionValueRequest
• UpdateStateValueRequest

SDK for .NET: Work with choices sample code

How to run this sample

1. Download or clone the Microsoft/PowerApps-Samples repo so that you have a local copy.
2. (Optional) Edit the dataverse/App.config file to define a connection string specifying the Microsoft Dataverse instance you want to connect to.
3. Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in dataverse/App.config, any sample you run will use that connection information.

If you don't specify a connection string in dataverse/App.config file, a dialog opens each time you run the sample and you need to enter information about which Dataverse instance you want to connect to and which credentials you want to use. This dialog caches previous connections so that you can choose a previously used connection.

Those samples in this repo that require a connection to a Dataverse instance to run include a linked reference to the dataverse/App.config file.

What this sample does

The CreateOptionSetRequest, DeleteOptionSetRequest, RetrieveOptionSetRequest, and UpdateOptionSetRequest messages are intended to be used in a scenario where it contains the data that is needed to work with choices.

How this sample works

In order to simulate the scenario described in What this sample does, the sample will do the following:

Setup

Checks for the current version of the org.

Demonstrate

1. The CreateOptionSetRequest method creates a choices column. You need to set the parameter IsGlobal=true.
2. The CreateAttributeRequest method creates a choices column linked to the choices.
3. The UpdateOptionSetRequest method updates the basic information of the choices column.
4. The PublishXmlRequest method publishes the choices column.
5. The InsertOptionValueRequest method inserts a new option into a choices column.
6. The RetrieveOptionSetRequest method retrieves the choices column by it's name.

Clean up

Display an option to delete the records created in the Setup. The deletion is optional in case you want to examine the tables and data created by the sample. You can manually delete the records to achieve the same result.