AttributeMetadata Class

 

Updated: November 29, 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)


[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 = "http://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

NameDescription
System_CAPS_pubmethodAttributeMetadata()

Initializes a new instance of the AttributeMetadata class.

System_CAPS_protmethodAttributeMetadata(AttributeTypeCode)

Initializes a new instance of the AttributeMetadata class.

System_CAPS_protmethodAttributeMetadata(AttributeTypeCode, String)

Initializes a new instance of the AttributeMetadata class.

NameDescription
System_CAPS_pubpropertyAttributeOf

Gets the name of the attribute that this attribute extends.

System_CAPS_pubpropertyAttributeType

Gets the type for the attribute.

System_CAPS_pubpropertyAttributeTypeName

Gets the name of the type for the attribute.

System_CAPS_pubpropertyCanBeSecuredForCreate

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

System_CAPS_pubpropertyCanBeSecuredForRead

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

System_CAPS_pubpropertyCanBeSecuredForUpdate

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

System_CAPS_pubpropertyCanModifyAdditionalSettings

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

System_CAPS_pubpropertyColumnNumber

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

System_CAPS_pubpropertyDeprecatedVersion

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

System_CAPS_pubpropertyDescription

Gets or sets the description of the attribute.

System_CAPS_pubpropertyDisplayName

Gets or sets the display name for the attribute.

System_CAPS_pubpropertyEntityLogicalName

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

System_CAPS_pubpropertyExtensionData

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

System_CAPS_pubpropertyHasChanged

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

System_CAPS_pubpropertyInheritsFrom

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyIntroducedVersion

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

System_CAPS_pubpropertyIsAuditEnabled

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

System_CAPS_pubpropertyIsCustomAttribute

Gets whether the attribute is a custom attribute.

System_CAPS_pubpropertyIsCustomizable

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

System_CAPS_pubpropertyIsFilterable

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyIsGlobalFilterEnabled

System_CAPS_pubpropertyIsLogical

Gets whether the attribute is a logical attribute.

System_CAPS_pubpropertyIsManaged

Gets whether the attribute is part of a managed solution.

System_CAPS_pubpropertyIsPrimaryId

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

System_CAPS_pubpropertyIsPrimaryName

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

System_CAPS_pubpropertyIsRenameable

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

System_CAPS_pubpropertyIsRetrievable

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyIsSearchable

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyIsSecured

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

System_CAPS_pubpropertyIsSortableEnabled

System_CAPS_pubpropertyIsValidForAdvancedFind

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

System_CAPS_pubpropertyIsValidForCreate

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

System_CAPS_pubpropertyIsValidForRead

Gets whether the value can be retrieved.

System_CAPS_pubpropertyIsValidForUpdate

Gets whether the value can be updated.

System_CAPS_pubpropertyLinkedAttributeId

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

System_CAPS_pubpropertyLogicalName

Gets or sets the logical name for the attribute.

System_CAPS_pubpropertyMetadataId

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

System_CAPS_pubpropertyRequiredLevel

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

System_CAPS_pubpropertySchemaName

Gets or sets the schema name for the attribute.

System_CAPS_pubpropertySourceType

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

This class is returned in the RetrieveAttributeResponse.

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

Show: