OptionMetadata Class

  • Reference

Definition

Namespace:
Microsoft.Xrm.Sdk.Metadata
Assembly:
Microsoft.Xrm.Sdk.dll
Package:
Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Contains metadata representing an option within an Option set.

For the Web API the corresponding type is OptionMetadata ComplexType.

public ref class OptionMetadata : Microsoft::Xrm::Sdk::Metadata::MetadataBase
[Microsoft.Xrm.Sdk.Metadata.MetadataName(LogicalCollectionName="OptionDefinitions", LogicalName="OptionMetadata")]
[System.Runtime.Serialization.DataContract(Name="OptionMetadata", Namespace="http://schemas.microsoft.com/xrm/2011/Metadata")]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StateOptionMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StatusOptionMetadata))]
public class OptionMetadata : Microsoft.Xrm.Sdk.Metadata.MetadataBase
[<Microsoft.Xrm.Sdk.Metadata.MetadataName(LogicalCollectionName="OptionDefinitions", LogicalName="OptionMetadata")>]
[<System.Runtime.Serialization.DataContract(Name="OptionMetadata", Namespace="http://schemas.microsoft.com/xrm/2011/Metadata")>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StateOptionMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StatusOptionMetadata))>]
type OptionMetadata = class
    inherit MetadataBase
Public Class OptionMetadata
Inherits MetadataBase
Inheritance
Object
MetadataBase
OptionMetadata
Derived
Attributes
MetadataNameAttribute DataContractAttribute KnownTypeAttribute

Constructors

OptionMetadata()

Initializes a new instance of the OptionMetadata class
OptionMetadata(Int32)

Initializes a new instance of the OptionMetadata class
OptionMetadata(Int32, IEnumerable<Int32>)
OptionMetadata(Label, Nullable<Int32>)

Initializes a new instance of the OptionMetadata class
OptionMetadata(Label, Nullable<Int32>, IEnumerable<Int32>)

Properties

Color

Gets or sets the hexadecimal value set to assign a color for the option.
Description

Gets or sets the label containing the description for the option.
ExtensionData

Gets or sets the structure that contains extra data.

(Inherited from MetadataBase)
ExternalValue
HasChanged

Gets whether the item of metadata has changed.

(Inherited from MetadataBase)
IsManaged

Gets whether the option is part of a managed solution.
Label

Gets or sets the label containing the text for the option.
MetadataId

Gets or sets a unique identifier for the metadata item.

(Inherited from MetadataBase)
ParentValues
Tag
Value

Gets or sets the value of the option.

Applies to