StateOptionMetadata Class

  • Reference

Definition

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

Contains data to define an option for the options in a State attribute.

For the Web API the corresponding type is StateOptionMetadata ComplexType.

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

Constructors

StateOptionMetadata()

Initializes a new instance of theStateOptionMetadata class

Properties

Color

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

(Inherited from OptionMetadata)
DefaultStatus

Gets or sets the default status value associated with this state.
Description

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

(Inherited from OptionMetadata)
ExtensionData

Gets or sets the structure that contains extra data.

(Inherited from MetadataBase)
ExternalValue (Inherited from OptionMetadata)
HasChanged

Gets whether the item of metadata has changed.

(Inherited from MetadataBase)
InvariantName

Gets or sets the name of the state that does not change.
IsManaged

Gets whether the option is part of a managed solution.

(Inherited from OptionMetadata)
Label

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

(Inherited from OptionMetadata)
MetadataId

Gets or sets a unique identifier for the metadata item.

(Inherited from MetadataBase)
ParentValues (Inherited from OptionMetadata)
Tag (Inherited from OptionMetadata)
Value

Gets or sets the value of the option.

(Inherited from OptionMetadata)

Applies to