StateOptionMetadata Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API the corresponding type is StateOptionMetadata ComplexType.

Namespace:   Microsoft.Xrm.Sdk.Metadata
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.Metadata.MetadataBase
    Microsoft.Xrm.Sdk.Metadata.OptionMetadata
      Microsoft.Xrm.Sdk.Metadata.StateOptionMetadata

Syntax

[MetadataNameAttribute(LogicalName = "StateOptionMetadata", LogicalCollectionName = "StateOptionDefinitions")]
[DataContractAttribute(Name = "StateOptionMetadata", Namespace = "http://schemas.microsoft.com/xrm/2011/Metadata")]
public sealed class StateOptionMetadata : OptionMetadata
<MetadataNameAttribute(LogicalName := "StateOptionMetadata", LogicalCollectionName := "StateOptionDefinitions")>
<DataContractAttribute(Name := "StateOptionMetadata", Namespace := "http://schemas.microsoft.com/xrm/2011/Metadata")>
Public NotInheritable Class StateOptionMetadata
    Inherits OptionMetadata

Constructors

Name Description
System_CAPS_pubmethod StateOptionMetadata()

Initializes a new instance of theStateOptionMetadata class

Properties

Name Description
System_CAPS_pubproperty Color

Gets or sets the hexadecimal value set to assign a color for the option.(Inherited from OptionMetadata.)

System_CAPS_pubproperty DefaultStatus

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

System_CAPS_pubproperty Description

Gets or sets the label containing the description for the option.(Inherited from OptionMetadata.)

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data.(Inherited from MetadataBase.)

System_CAPS_pubproperty HasChanged

Gets whether the item of metadata has changed.(Inherited from MetadataBase.)

System_CAPS_pubproperty InvariantName

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

System_CAPS_pubproperty IsManaged

Gets whether the option is part of a managed solution.(Inherited from OptionMetadata.)

System_CAPS_pubproperty Label

Gets or sets the label containing the text for the option.(Inherited from OptionMetadata.)

System_CAPS_pubproperty MetadataId

Gets or sets a unique identifier for the metadata item.(Inherited from MetadataBase.)

System_CAPS_pubproperty Value

Gets or sets the value of the option.(Inherited from OptionMetadata.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Xrm.Sdk.Metadata Namespace
Customize entity attribute metadata

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright