DeleteOptionValueRequest 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 delete an option value in a global or local option set.
For the Web API use the DeleteOptionValue Action.
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Xrm.Sdk.Messages.DeleteOptionValueRequest
| Name | Description | |
|---|---|---|
![]() | DeleteOptionValueRequest() | Initializes a new instance of theDeleteOptionValueRequest class |
| Name | Description | |
|---|---|---|
![]() | AttributeLogicalName | Gets or sets the logical name of the attribute from which to delete the option value. Optional. |
![]() | EntityLogicalName | Gets or sets the logical name of the entity that contains the 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.) |
![]() | OptionSetName | Gets or sets the name of the option set that contains the value. Optional. |
![]() | Parameters | Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
![]() | 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 solution name associated with this option value. Optional. |
![]() | Value | Gets or sets the value of the option to delete. Required. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | (Inherited from Object.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetType() | (Inherited from Object.) |
![]() | ToString() | (Inherited from Object.) |
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 DeleteOptionValueResponse.
Privileges and Access Rights
To perform this action, the caller must have privileges listed in DeleteOptionValue message privileges.
Notes for Callers
Use the OptionSetName property when working with global option sets. For local option sets in a picklist attribute, use the EntityLogicalName and AttributeLogicalName properties.
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.
// Use the DeleteOptionValueRequest message // to remove the newly inserted label. DeleteOptionValueRequest deleteOptionValueRequest = new DeleteOptionValueRequest { OptionSetName = _globalOptionSetName, Value = _insertedOptionValue }; // Execute the request. _serviceProxy.Execute(deleteOptionValueRequest);
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

