AttributeMetadata Class

Article
11/28/2016

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

Contains all the metadata for an entity attribute.

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

Inheritance Hierarchy

Syntax

[KnownTypeAttribute(typeof(MemoAttributeMetadata))]
[KnownTypeAttribute(typeof(StatusAttributeMetadata))]
[KnownTypeAttribute(typeof(StringAttributeMetadata))]
[KnownTypeAttribute(typeof(ManagedPropertyAttributeMetadata))]
[KnownTypeAttribute(typeof(UniqueIdentifierAttributeMetadata))]
[MetadataNameAttribute(LogicalName = "AttributeMetadata", LogicalCollectionName = "AttributeDefinitions")]
[KnownTypeAttribute(typeof(DoubleAttributeMetadata))]
[KnownTypeAttribute(typeof(StateAttributeMetadata))]
[KnownTypeAttribute(typeof(EntityNameAttributeMetadata))]
[DataContractAttribute(Name = "AttributeMetadata", Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata")]
[KnownTypeAttribute(typeof(BooleanAttributeMetadata))]
[KnownTypeAttribute(typeof(DateTimeAttributeMetadata))]
[KnownTypeAttribute(typeof(DecimalAttributeMetadata))]
[KnownTypeAttribute(typeof(BigIntAttributeMetadata))]
[KnownTypeAttribute(typeof(PicklistAttributeMetadata))]
[KnownTypeAttribute(typeof(IntegerAttributeMetadata))]
[KnownTypeAttribute(typeof(ImageAttributeMetadata))]
[KnownTypeAttribute(typeof(LookupAttributeMetadata))]
[KnownTypeAttribute(typeof(MoneyAttributeMetadata))]
public class AttributeMetadata : MetadataBase

<KnownTypeAttribute(GetType(MemoAttributeMetadata))>
<KnownTypeAttribute(GetType(StatusAttributeMetadata))>
<KnownTypeAttribute(GetType(StringAttributeMetadata))>
<KnownTypeAttribute(GetType(ManagedPropertyAttributeMetadata))>
<KnownTypeAttribute(GetType(UniqueIdentifierAttributeMetadata))>
<MetadataNameAttribute(LogicalName := "AttributeMetadata", LogicalCollectionName := "AttributeDefinitions")>
<KnownTypeAttribute(GetType(DoubleAttributeMetadata))>
<KnownTypeAttribute(GetType(StateAttributeMetadata))>
<KnownTypeAttribute(GetType(EntityNameAttributeMetadata))>
<DataContractAttribute(Name := "AttributeMetadata", Namespace := "https://schemas.microsoft.com/xrm/2011/Metadata")>
<KnownTypeAttribute(GetType(BooleanAttributeMetadata))>
<KnownTypeAttribute(GetType(DateTimeAttributeMetadata))>
<KnownTypeAttribute(GetType(DecimalAttributeMetadata))>
<KnownTypeAttribute(GetType(BigIntAttributeMetadata))>
<KnownTypeAttribute(GetType(PicklistAttributeMetadata))>
<KnownTypeAttribute(GetType(IntegerAttributeMetadata))>
<KnownTypeAttribute(GetType(ImageAttributeMetadata))>
<KnownTypeAttribute(GetType(LookupAttributeMetadata))>
<KnownTypeAttribute(GetType(MoneyAttributeMetadata))>
Public Class AttributeMetadata
    Inherits MetadataBase

Constructors

	Name	Description
	AttributeMetadata()	Initializes a new instance of the AttributeMetadata class.
	AttributeMetadata(AttributeTypeCode)	Initializes a new instance of the AttributeMetadata class.
	AttributeMetadata(AttributeTypeCode, String)	Initializes a new instance of the AttributeMetadata class.

Properties

	Name	Description
	AttributeOf	Gets the name of the attribute that this attribute extends.
	AttributeType	Gets the type for the attribute.
	AttributeTypeName	Gets the name of the type for the attribute.
	CanBeSecuredForCreate	Gets whether field-level security can be applied to prevent a user from adding data to this attribute.
	CanBeSecuredForRead	Gets whether field-level security can be applied to prevent a user from viewing data from this attribute.
	CanBeSecuredForUpdate	Gets whether field-level security can be applied to prevent a user from updating data for this attribute.
	CanModifyAdditionalSettings	Gets or sets the property that determines whether any settings not controlled by managed properties can be changed.
	ColumnNumber	Gets an organization-specific ID for the attribute used for auditing.
	DeprecatedVersion	Gets the Microsoft Dynamics 365 version that the attribute was deprecated in.
	Description	Gets or sets the description of the attribute.
	DisplayName	Gets or sets the display name for the attribute.
	EntityLogicalName	Gets the logical name of the entity that contains the attribute.
	ExtensionData	Gets or sets the structure that contains extra data.(Inherited from MetadataBase.)
	HasChanged	Gets whether the item of metadata has changed.(Inherited from MetadataBase.)
	InheritsFrom	This API supports the product infrastructure and is not intended to be used directly from your code.
	IntroducedVersion	Gets a string identifying the solution version that the solution component was added in.
	IsAuditEnabled	Gets or sets the property that determines whether the attribute is enabled for auditing.
	IsCustomAttribute	Gets whether the attribute is a custom attribute.
	IsCustomizable	Gets or sets the property that determines whether the attribute allows customization.
	IsFilterable	This API supports the product infrastructure and is not intended to be used directly from your code.
	IsGlobalFilterEnabled
	IsLogical	Gets whether the attribute is a logical attribute.
	IsManaged	Gets whether the attribute is part of a managed solution.
	IsPrimaryId	Gets whether the attribute represents the unique identifier for the record.
	IsPrimaryName	Gets or sets whether the attribute represents the primary attribute for the entity.
	IsRenameable	Gets or sets the property that determines whether the attribute display name can be changed.
	IsRetrievable	This API supports the product infrastructure and is not intended to be used directly from your code.
	IsSearchable	This API supports the product infrastructure and is not intended to be used directly from your code.
	IsSecured	Gets or sets whether the attribute is secured for field-level security.
	IsSortableEnabled
	IsValidForAdvancedFind	Gets or sets the property that determines whether the attribute appears in Advanced Find.
	IsValidForCreate	Gets whether the value can be set when a record is created.
	IsValidForRead	Gets whether the value can be retrieved.
	IsValidForUpdate	Gets whether the value can be updated.
	LinkedAttributeId	Gets or sets an attribute that is linked between appointments and recurring appointments.
	LogicalName	Gets or sets the logical name for the attribute.
	MetadataId	Gets or sets a unique identifier for the metadata item.(Inherited from MetadataBase.)
	RequiredLevel	Gets or sets the property that determines the data entry requirement level enforced for the attribute.
	SchemaName	Gets or sets the schema name for the attribute.
	SourceType	Gets or sets the value that indicates the source type for a calculated or rollup attribute.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	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.

Share via