AttributeMetadata Class

Definition

Contains all the metadata for an entity attribute.

public ref class AttributeMetadata : Microsoft::Xrm::Sdk::Metadata::MetadataBase
[Microsoft.Xrm.Sdk.Metadata.MetadataName(LogicalCollectionName="AttributeDefinitions", LogicalName="AttributeMetadata")]
[System.Runtime.Serialization.DataContract(Name="AttributeMetadata", Namespace="http://schemas.microsoft.com/xrm/2011/Metadata")]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.MultiSelectPicklistAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.BooleanAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.DateTimeAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.DecimalAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.DoubleAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.EntityNameAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.ImageAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.IntegerAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.BigIntAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.LookupAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.MemoAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.MoneyAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.PicklistAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StateAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StatusAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StringAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.ManagedPropertyAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.UniqueIdentifierAttributeMetadata))]
[System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.FileAttributeMetadata))]
public class AttributeMetadata : Microsoft.Xrm.Sdk.Metadata.MetadataBase
[<Microsoft.Xrm.Sdk.Metadata.MetadataName(LogicalCollectionName="AttributeDefinitions", LogicalName="AttributeMetadata")>]
[<System.Runtime.Serialization.DataContract(Name="AttributeMetadata", Namespace="http://schemas.microsoft.com/xrm/2011/Metadata")>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.MultiSelectPicklistAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.BooleanAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.DateTimeAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.DecimalAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.DoubleAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.EntityNameAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.ImageAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.IntegerAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.BigIntAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.LookupAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.MemoAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.MoneyAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.PicklistAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StateAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StatusAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.StringAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.ManagedPropertyAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.UniqueIdentifierAttributeMetadata))>]
[<System.Runtime.Serialization.KnownType(typeof(Microsoft.Xrm.Sdk.Metadata.FileAttributeMetadata))>]
type AttributeMetadata = class
    inherit MetadataBase
Public Class AttributeMetadata
Inherits MetadataBase
Inheritance
AttributeMetadata
Derived
Attributes

Remarks

This class is returned in the RetrieveAttributeResponse.

Constructors

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

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.

AutoNumberFormat
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.

CreatedOn
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)
ExternalName
HasChanged

Gets whether the item of metadata has changed.

(Inherited from MetadataBase)
InheritsFrom

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.

IsDataSourceSecret
IsFilterable

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.

IsRequiredForForm

Gets or sets whether the attribute must be included in a form in a model-driven app.

IsRetrievable

Gets whether the data in the attribute can be retrieved.

IsSearchable

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.

IsValidForForm

Gets or sets whether the attribute can be added to a form in a model-driven app.

IsValidForGrid

Gets or sets whether the attribute can be included in a view.

IsValidForRead

Gets whether the value can be retrieved.

IsValidForUpdate

Gets whether the value can be updated.

IsValidODataAttribute

Gets whether the attribute represents a property that is available in the Web API.

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)
ModifiedOn
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.

Settings

Internal use only.

SourceType

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

Applies to