AttributeMetadata AttributeMetadata AttributeMetadata 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))]
public class AttributeMetadata : Microsoft.Xrm.Sdk.Metadata.MetadataBase
type AttributeMetadata = class
    inherit MetadataBase
Public Class AttributeMetadata
Inherits MetadataBase
Inheritance
AttributeMetadataAttributeMetadataAttributeMetadataAttributeMetadata
Derived
Attributes

Remarks

This class is returned in the RetrieveAttributeResponse.

Constructors

AttributeMetadata() AttributeMetadata() AttributeMetadata() AttributeMetadata()

Initializes a new instance of the AttributeMetadata class.

AttributeMetadata(AttributeTypeCode) AttributeMetadata(AttributeTypeCode) AttributeMetadata(AttributeTypeCode) AttributeMetadata(AttributeTypeCode)

Initializes a new instance of the AttributeMetadata class.

AttributeMetadata(AttributeTypeCode, String) AttributeMetadata(AttributeTypeCode, String) AttributeMetadata(AttributeTypeCode, String) AttributeMetadata(AttributeTypeCode, String)

Initializes a new instance of the AttributeMetadata class.

Properties

AttributeOf AttributeOf AttributeOf AttributeOf

Gets the name of the attribute that this attribute extends.

AttributeType AttributeType AttributeType AttributeType

Gets the type for the attribute.

AttributeTypeName AttributeTypeName AttributeTypeName AttributeTypeName

Gets the name of the type for the attribute.

AutoNumberFormat AutoNumberFormat AutoNumberFormat AutoNumberFormat
CanBeSecuredForCreate CanBeSecuredForCreate CanBeSecuredForCreate CanBeSecuredForCreate

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

CanBeSecuredForRead CanBeSecuredForRead CanBeSecuredForRead CanBeSecuredForRead

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

CanBeSecuredForUpdate CanBeSecuredForUpdate CanBeSecuredForUpdate CanBeSecuredForUpdate

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

CanModifyAdditionalSettings CanModifyAdditionalSettings CanModifyAdditionalSettings CanModifyAdditionalSettings

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

ColumnNumber ColumnNumber ColumnNumber ColumnNumber

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

DeprecatedVersion DeprecatedVersion DeprecatedVersion DeprecatedVersion

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

Description Description Description Description

Gets or sets the description of the attribute.

DisplayName DisplayName DisplayName DisplayName

Gets or sets the display name for the attribute.

EntityLogicalName EntityLogicalName EntityLogicalName EntityLogicalName

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

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data.

(Inherited from MetadataBase)
ExternalName ExternalName ExternalName ExternalName
HasChanged HasChanged HasChanged HasChanged

Gets whether the item of metadata has changed.

(Inherited from MetadataBase)
InheritsFrom InheritsFrom InheritsFrom InheritsFrom

IntroducedVersion IntroducedVersion IntroducedVersion IntroducedVersion

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

IsAuditEnabled IsAuditEnabled IsAuditEnabled IsAuditEnabled

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

IsCustomAttribute IsCustomAttribute IsCustomAttribute IsCustomAttribute

Gets whether the attribute is a custom attribute.

IsCustomizable IsCustomizable IsCustomizable IsCustomizable

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

IsDataSourceSecret IsDataSourceSecret IsDataSourceSecret IsDataSourceSecret
IsFilterable IsFilterable IsFilterable IsFilterable

IsGlobalFilterEnabled IsGlobalFilterEnabled IsGlobalFilterEnabled IsGlobalFilterEnabled

IsLogical IsLogical IsLogical IsLogical

Gets whether the attribute is a logical attribute.

IsManaged IsManaged IsManaged IsManaged

Gets whether the attribute is part of a managed solution.

IsPrimaryId IsPrimaryId IsPrimaryId IsPrimaryId

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

IsPrimaryName IsPrimaryName IsPrimaryName IsPrimaryName

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

IsRenameable IsRenameable IsRenameable IsRenameable

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

IsRequiredForForm IsRequiredForForm IsRequiredForForm IsRequiredForForm
IsRetrievable IsRetrievable IsRetrievable IsRetrievable

IsSearchable IsSearchable IsSearchable IsSearchable

IsSecured IsSecured IsSecured IsSecured

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

IsSortableEnabled IsSortableEnabled IsSortableEnabled IsSortableEnabled

IsValidForAdvancedFind IsValidForAdvancedFind IsValidForAdvancedFind IsValidForAdvancedFind

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

IsValidForCreate IsValidForCreate IsValidForCreate IsValidForCreate

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

IsValidForForm IsValidForForm IsValidForForm IsValidForForm
IsValidForGrid IsValidForGrid IsValidForGrid IsValidForGrid
IsValidForRead IsValidForRead IsValidForRead IsValidForRead

Gets whether the value can be retrieved.

IsValidForUpdate IsValidForUpdate IsValidForUpdate IsValidForUpdate

Gets whether the value can be updated.

LinkedAttributeId LinkedAttributeId LinkedAttributeId LinkedAttributeId

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

LogicalName LogicalName LogicalName LogicalName

Gets or sets the logical name for the attribute.

MetadataId MetadataId MetadataId MetadataId

Gets or sets a unique identifier for the metadata item.

(Inherited from MetadataBase)
RequiredLevel RequiredLevel RequiredLevel RequiredLevel

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

SchemaName SchemaName SchemaName SchemaName

Gets or sets the schema name for the attribute.

SourceType SourceType SourceType SourceType

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

Applies to