AttributeMetadata Class

 

Applies To: Dynamics CRM 2015

Contains all the metadata for an entity attribute.

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.AttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.BigIntAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.BooleanAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.DateTimeAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.DecimalAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.DoubleAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.EnumAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.ImageAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.IntegerAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.LookupAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.ManagedPropertyAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.MemoAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.MoneyAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.StringAttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.UniqueIdentifierAttributeMetadata

Syntax

[KnownTypeAttribute(typeof(DoubleAttributeMetadata))]
[KnownTypeAttribute(typeof(ManagedPropertyAttributeMetadata))]
[KnownTypeAttribute(typeof(MemoAttributeMetadata))]
[KnownTypeAttribute(typeof(LookupAttributeMetadata))]
[KnownTypeAttribute(typeof(DateTimeAttributeMetadata))]
[KnownTypeAttribute(typeof(DecimalAttributeMetadata))]
[KnownTypeAttribute(typeof(MoneyAttributeMetadata))]
[KnownTypeAttribute(typeof(UniqueIdentifierAttributeMetadata))]
[KnownTypeAttribute(typeof(ImageAttributeMetadata))]
[KnownTypeAttribute(typeof(IntegerAttributeMetadata))]
[KnownTypeAttribute(typeof(BigIntAttributeMetadata))]
[KnownTypeAttribute(typeof(BooleanAttributeMetadata))]
[KnownTypeAttribute(typeof(EntityNameAttributeMetadata))]
[KnownTypeAttribute(typeof(PicklistAttributeMetadata))]
[KnownTypeAttribute(typeof(StateAttributeMetadata))]
[KnownTypeAttribute(typeof(StatusAttributeMetadata))]
[KnownTypeAttribute(typeof(StringAttributeMetadata))]
[DataContractAttribute(Name = "AttributeMetadata", Namespace = "http://schemas.microsoft.com/xrm/2011/Metadata")]
public class AttributeMetadata : MetadataBase
[KnownTypeAttribute((DoubleAttributeMetadata^::typeid))]
[KnownTypeAttribute((ManagedPropertyAttributeMetadata^::typeid))]
[KnownTypeAttribute((MemoAttributeMetadata^::typeid))]
[KnownTypeAttribute((LookupAttributeMetadata^::typeid))]
[KnownTypeAttribute((DateTimeAttributeMetadata^::typeid))]
[KnownTypeAttribute((DecimalAttributeMetadata^::typeid))]
[KnownTypeAttribute((MoneyAttributeMetadata^::typeid))]
[KnownTypeAttribute((UniqueIdentifierAttributeMetadata^::typeid))]
[KnownTypeAttribute((ImageAttributeMetadata^::typeid))]
[KnownTypeAttribute((IntegerAttributeMetadata^::typeid))]
[KnownTypeAttribute((BigIntAttributeMetadata^::typeid))]
[KnownTypeAttribute((BooleanAttributeMetadata^::typeid))]
[KnownTypeAttribute((EntityNameAttributeMetadata^::typeid))]
[KnownTypeAttribute((PicklistAttributeMetadata^::typeid))]
[KnownTypeAttribute((StateAttributeMetadata^::typeid))]
[KnownTypeAttribute((StatusAttributeMetadata^::typeid))]
[KnownTypeAttribute((StringAttributeMetadata^::typeid))]
[DataContractAttribute(Name = "AttributeMetadata", Namespace = "http://schemas.microsoft.com/xrm/2011/Metadata")]
public ref class AttributeMetadata : MetadataBase
[<KnownTypeAttribute(typeof(DoubleAttributeMetadata))>]
[<KnownTypeAttribute(typeof(ManagedPropertyAttributeMetadata))>]
[<KnownTypeAttribute(typeof(MemoAttributeMetadata))>]
[<KnownTypeAttribute(typeof(LookupAttributeMetadata))>]
[<KnownTypeAttribute(typeof(DateTimeAttributeMetadata))>]
[<KnownTypeAttribute(typeof(DecimalAttributeMetadata))>]
[<KnownTypeAttribute(typeof(MoneyAttributeMetadata))>]
[<KnownTypeAttribute(typeof(UniqueIdentifierAttributeMetadata))>]
[<KnownTypeAttribute(typeof(ImageAttributeMetadata))>]
[<KnownTypeAttribute(typeof(IntegerAttributeMetadata))>]
[<KnownTypeAttribute(typeof(BigIntAttributeMetadata))>]
[<KnownTypeAttribute(typeof(BooleanAttributeMetadata))>]
[<KnownTypeAttribute(typeof(EntityNameAttributeMetadata))>]
[<KnownTypeAttribute(typeof(PicklistAttributeMetadata))>]
[<KnownTypeAttribute(typeof(StateAttributeMetadata))>]
[<KnownTypeAttribute(typeof(StatusAttributeMetadata))>]
[<KnownTypeAttribute(typeof(StringAttributeMetadata))>]
[<DataContractAttribute(Name = "AttributeMetadata", Namespace = "http://schemas.microsoft.com/xrm/2011/Metadata")>]
type AttributeMetadata = 
    class
        inherit MetadataBase
    end
<KnownTypeAttribute(GetType(DoubleAttributeMetadata))>
<KnownTypeAttribute(GetType(ManagedPropertyAttributeMetadata))>
<KnownTypeAttribute(GetType(MemoAttributeMetadata))>
<KnownTypeAttribute(GetType(LookupAttributeMetadata))>
<KnownTypeAttribute(GetType(DateTimeAttributeMetadata))>
<KnownTypeAttribute(GetType(DecimalAttributeMetadata))>
<KnownTypeAttribute(GetType(MoneyAttributeMetadata))>
<KnownTypeAttribute(GetType(UniqueIdentifierAttributeMetadata))>
<KnownTypeAttribute(GetType(ImageAttributeMetadata))>
<KnownTypeAttribute(GetType(IntegerAttributeMetadata))>
<KnownTypeAttribute(GetType(BigIntAttributeMetadata))>
<KnownTypeAttribute(GetType(BooleanAttributeMetadata))>
<KnownTypeAttribute(GetType(EntityNameAttributeMetadata))>
<KnownTypeAttribute(GetType(PicklistAttributeMetadata))>
<KnownTypeAttribute(GetType(StateAttributeMetadata))>
<KnownTypeAttribute(GetType(StatusAttributeMetadata))>
<KnownTypeAttribute(GetType(StringAttributeMetadata))>
<DataContractAttribute(Name := "AttributeMetadata", Namespace := "http://schemas.microsoft.com/xrm/2011/Metadata")>
Public Class AttributeMetadata
    Inherits MetadataBase

Constructors

Name Description
System_CAPS_pubmethod AttributeMetadata()

Initializes a new instance of the AttributeMetadata class.

System_CAPS_protmethod AttributeMetadata(AttributeTypeCode)

Initializes a new instance of the AttributeMetadata class.

System_CAPS_protmethod AttributeMetadata(AttributeTypeCode, String)

Initializes a new instance of the AttributeMetadata class.

Properties

Name Description
System_CAPS_pubproperty AttributeOf

Gets the name of the attribute that this attribute extends.

System_CAPS_pubproperty AttributeType

Gets the type for the attribute.

System_CAPS_pubproperty AttributeTypeName

Gets the name of the type for the attribute.

System_CAPS_pubproperty CanBeSecuredForCreate

Gets whether field-level security can be applied to prevent a user from adding data to this attribute.

System_CAPS_pubproperty CanBeSecuredForRead

Gets whether field-level security can be applied to prevent a user from viewing data from this attribute.

System_CAPS_pubproperty CanBeSecuredForUpdate

Gets whether field-level security can be applied to prevent a user from updating data for this attribute.

System_CAPS_pubproperty CanModifyAdditionalSettings

Gets or sets the property that determines whether any settings not controlled by managed properties can be changed.

System_CAPS_pubproperty ColumnNumber

Gets an organization-specific ID for the attribute used for auditing.

System_CAPS_pubproperty DeprecatedVersion

Gets the Microsoft Dynamics CRM version that the attribute was deprecated in.

System_CAPS_pubproperty Description

Gets or sets the description of the attribute.

System_CAPS_pubproperty DisplayName

Gets or sets the display name for the attribute.

System_CAPS_pubproperty EntityLogicalName

Gets the logical name of the entity that contains the attribute.

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 IntroducedVersion

Gets a string identifying the solution version that the solution component was added in.

System_CAPS_pubproperty IsAuditEnabled

Gets or sets the property that determines whether the attribute is enabled for auditing.

System_CAPS_pubproperty IsCustomAttribute

Gets whether the attribute is a custom attribute.

System_CAPS_pubproperty IsCustomizable

Gets or sets the property that determines whether the attribute allows customization.

System_CAPS_pubproperty IsLogical

Gets whether the attribute is a logical attribute.

System_CAPS_pubproperty IsManaged

Gets whether the attribute is part of a managed solution.

System_CAPS_pubproperty IsPrimaryId

Gets whether the attribute represents the unique identifier for the record.

System_CAPS_pubproperty IsPrimaryName

Gets or sets whether the attribute represents the primary attribute for the entity.

System_CAPS_pubproperty IsRenameable

Gets or sets the property that determines whether the attribute display name can be changed.

System_CAPS_pubproperty IsSecured

Gets or sets whether the attribute is secured for field-level security.

System_CAPS_pubproperty IsValidForAdvancedFind

Gets or sets the property that determines whether the attribute appears in Advanced Find.

System_CAPS_pubproperty IsValidForCreate

Gets whether the value can be set when a record is created.

System_CAPS_pubproperty IsValidForRead

Gets whether the value can be retrieved.

System_CAPS_pubproperty IsValidForUpdate

Gets whether the value can be updated.

System_CAPS_pubproperty LinkedAttributeId

Gets or sets an attribute that is linked between appointments and recurring appointments.

System_CAPS_pubproperty LogicalName

Gets or sets the logical name for the attribute.

System_CAPS_pubproperty MetadataId

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

System_CAPS_pubproperty RequiredLevel

Gets or sets the property that determines the data entry requirement level enforced for the attribute.

System_CAPS_pubproperty SchemaName

Gets or sets the schema name for the attribute.

System_CAPS_pubproperty SourceType

Gets or sets the value that indicates the source type for a calculated or rollup attribute.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

This class is returned in the RetrieveAttributeResponse.

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
Sample: Dump attribute metadata to a file
Sample: Work with attribute metadata
Sample: Retrieve entity metadata using JavaScript

Return to top

© 2016 Microsoft. All rights reserved. Copyright