EntityMetadata Class

 

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

Contains the metadata for an entity.

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

Syntax

[DataContractAttribute(Name = "EntityMetadata", Namespace = "http://schemas.microsoft.com/xrm/2011/Metadata")]
[MetadataNameAttribute(LogicalName = "EntityMetadata", LogicalCollectionName = "EntityDefinitions")]
public sealed class EntityMetadata : MetadataBase
<DataContractAttribute(Name := "EntityMetadata", Namespace := "http://schemas.microsoft.com/xrm/2011/Metadata")>
<MetadataNameAttribute(LogicalName := "EntityMetadata", LogicalCollectionName := "EntityDefinitions")>
Public NotInheritable Class EntityMetadata
    Inherits MetadataBase

Constructors

Name Description
System_CAPS_pubmethod EntityMetadata()

Initializes a new instance of the EntityMetadata class

Properties

Name Description
System_CAPS_pubproperty ActivityTypeMask

Gets or sets whether a custom activity should appear in the activity menus in the Web application.

System_CAPS_pubproperty Attributes

Gets the array of attribute metadata for the entity.

System_CAPS_pubproperty AutoCreateAccessTeams

Gets or sets whether the entity is enabled for auto created access teams.

System_CAPS_pubproperty AutoRouteToOwnerQueue

Gets or sets whether to automatically move records to the owner’s default queue when a record of this type is created or assigned.

System_CAPS_pubproperty CanBeInManyToMany

Gets the property that determines whether the entity can be in a Many-to-Many entity relationship.

System_CAPS_pubproperty CanBePrimaryEntityInRelationship

Gets the property that determines whether the entity can be the referenced entity in a One-to-Many entity relationship.

System_CAPS_pubproperty CanBeRelatedEntityInRelationship

Gets the property that determines whether the entity can be the referencing entity in a One-to-Many entity relationship.

System_CAPS_pubproperty CanChangeHierarchicalRelationship

Gets or sets whether the hierarchical state of entity relationships included in your managed solutions can be changed.

System_CAPS_pubproperty CanChangeTrackingBeEnabled

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

System_CAPS_pubproperty CanCreateAttributes

Gets or sets the property that determines whether additional attributes can be added to the entity.

System_CAPS_pubproperty CanCreateCharts

Gets or sets the property that determines whether new charts can be created for the entity.

System_CAPS_pubproperty CanCreateForms

Gets or sets the property that determines whether new forms can be created for the entity.

System_CAPS_pubproperty CanCreateViews

Gets or sets the property that determines whether new views can be created for the entity.

System_CAPS_pubproperty CanEnableSyncToExternalSearchIndex

Gets or sets whether this entity can be enabled for relevance search when customizing a managed solution.

System_CAPS_pubproperty CanModifyAdditionalSettings

Gets or sets the property that determines whether any other entity properties not represented by a managed property can be changed.

System_CAPS_pubproperty CanTriggerWorkflow

Gets whether the entity can trigger a workflow process.

System_CAPS_pubproperty ChangeTrackingEnabled

Gets or sets a Boolean value that specifies whether change tracking is enabled for an entity or not.

System_CAPS_pubproperty CollectionSchemaName

Gets or sets the collection schema name of the entity.

System_CAPS_pubproperty DaysSinceRecordLastModified

System_CAPS_pubproperty Description

Gets or sets the label containing the description for the entity.

System_CAPS_pubproperty DisplayCollectionName

Gets or sets the label containing the plural display name for the entity.

System_CAPS_pubproperty DisplayName

Gets or sets the label containing the display name for the entity.

System_CAPS_pubproperty EnforceStateTransitions

Gets whether the entity will enforce custom state transitions.

System_CAPS_pubproperty EntityColor

Gets or sets the hexadecimal code to represent the color to be used for this entity in the application.

System_CAPS_pubproperty EntityHelpUrl

Gets or sets the URL of the resource to display help content for this entity

System_CAPS_pubproperty EntityHelpUrlEnabled

Gets or sets whether the entity supports custom help content.

System_CAPS_pubproperty EntitySetName

Gets or sets the entity set name.

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 IconLargeName

Gets or sets the name of the image web resource for the large icon for the entity.

System_CAPS_pubproperty IconMediumName

Gets or sets the name of the image web resource for the medium icon for the entity.

System_CAPS_pubproperty IconSmallName

Gets or sets the name of the image web resource for the small icon for the entity.

System_CAPS_pubproperty IntroducedVersion

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

System_CAPS_pubproperty IsActivity

Gets or sets whether the entity is an activity.

System_CAPS_pubproperty IsActivityParty

Gets or sets whether the email messages can be sent to an email address stored in a record of this type.

System_CAPS_pubproperty IsAIRUpdated

Gets whether the entity uses the updated user interface.

System_CAPS_pubproperty IsAuditEnabled

Gets or sets the property that determines whether auditing has been enabled for the entity.

System_CAPS_pubproperty IsAvailableOffline

Gets or sets whether the entity is available offline.

System_CAPS_pubproperty IsBPFEntity

System_CAPS_pubproperty IsBusinessProcessEnabled

Gets whether the entity is enabled for business process flows.

System_CAPS_pubproperty IsChildEntity

Gets whether the entity is a child entity.

System_CAPS_pubproperty IsConnectionsEnabled

Gets or sets the property that determines whether connections are enabled for this entity.

System_CAPS_pubproperty IsCustomEntity

Gets whether the entity is a custom entity.

System_CAPS_pubproperty IsCustomizable

Gets or sets the property that determines whether the entity is customizable.

System_CAPS_pubproperty IsDocumentManagementEnabled

Gets or sets the property that determines whether document management is enabled.

System_CAPS_pubproperty IsDocumentRecommendationsEnabled

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets whether the entity is enabled for document recommendations.

System_CAPS_pubproperty IsDuplicateDetectionEnabled

Gets or sets the property that determines whether duplicate detection is enabled.

System_CAPS_pubproperty IsEnabledForCharts

Gets whether charts are enabled.

System_CAPS_pubproperty IsEnabledForExternalChannels

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

System_CAPS_pubproperty IsEnabledForTrace

For internal use only.

System_CAPS_pubproperty IsImportable

Gets whether the entity can be imported using the Import Wizard.

System_CAPS_pubproperty IsInteractionCentricEnabled

Gets or sets whether the entity is enabled for interactive experience.

System_CAPS_pubproperty IsIntersect

Gets whether the entity is an intersection table for two other entities.

System_CAPS_pubproperty IsKnowledgeManagementEnabled

Gets or sets whether Parature knowledge management integration is enabled for the entity.

System_CAPS_pubproperty IsLogicalEntity

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

System_CAPS_pubproperty IsMailMergeEnabled

Gets or sets the property that determines whether mail merge is enabled for this entity.

System_CAPS_pubproperty IsManaged

Gets whether the entity is part of a managed solution.

System_CAPS_pubproperty IsMappable

Gets or sets the property that determines whether entity mapping is available for the entity.

System_CAPS_pubproperty IsOfflineInMobileClient

System_CAPS_pubproperty IsOneNoteIntegrationEnabled

Gets or sets whether OneNote integration is enabled for the.

System_CAPS_pubproperty IsOptimisticConcurrencyEnabled

Gets whether optimistic concurrency is enabled for the entity

System_CAPS_pubproperty IsPrivate

Gets whether the entity is public or private.

System_CAPS_pubproperty IsQuickCreateEnabled

Gets or sets the value indicating if the entity is enabled for quick create forms.

System_CAPS_pubproperty IsReadingPaneEnabled

For internal use only.

System_CAPS_pubproperty IsReadOnlyInMobileClient

Gets or sets the property that determines whether Microsoft Dynamics 365 for tablets users can update data for this entity.

System_CAPS_pubproperty IsRenameable

Gets or sets the property that determines whether the entity DisplayName and DisplayCollectionName can be changed by editing the entity in the application.

System_CAPS_pubproperty IsSLAEnabled

Gets or sets the value indicating if the entity is enabled for service level agreements (SLAs).

System_CAPS_pubproperty IsStateModelAware

Gets whether the entity supports setting custom state transitions.

System_CAPS_pubproperty IsValidForAdvancedFind

Gets or sets whether the entity is will be shown in Advanced Find.

System_CAPS_pubproperty IsValidForQueue

Gets or sets the property that determines whether the entity is enabled for queues.

System_CAPS_pubproperty IsVisibleInMobile

Gets or sets the property that determines whether Microsoft Dynamics 365 for phones users can see data for this entity.

System_CAPS_pubproperty IsVisibleInMobileClient

Gets or sets the property that determines whether Microsoft Dynamics 365 for tablets users can see data for this entity.

System_CAPS_pubproperty Keys

Gets an array of keys for an entity.

System_CAPS_pubproperty LogicalCollectionName

Gets the logical collection name.

System_CAPS_pubproperty LogicalName

Gets or sets the logical name for the entity.

System_CAPS_pubproperty ManyToManyRelationships

Gets the array of many-to-many relationships for the entity.

System_CAPS_pubproperty ManyToOneRelationships

Gets the array of many-to-one relationships for the entity.

System_CAPS_pubproperty MetadataId

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

System_CAPS_pubproperty MobileOfflineFilters

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

System_CAPS_pubproperty ObjectTypeCode

Gets the entity type code.

System_CAPS_pubproperty OneToManyRelationships

Gets the array of one-to-many relationships for the entity.

System_CAPS_pubproperty OwnershipType

Gets or sets the ownership type for the entity.

System_CAPS_pubproperty PrimaryIdAttribute

Gets the name of the attribute that is the primary id for the entity.

System_CAPS_pubproperty PrimaryImageAttribute

Gets the name of the primary image attribute for an entity.

System_CAPS_pubproperty PrimaryNameAttribute

Gets the name of the primary attribute for an entity.

System_CAPS_pubproperty Privileges

Gets the privilege metadata for the entity.

System_CAPS_pubproperty RecurrenceBaseEntityLogicalName

Gets the name of the entity that is recurring.

System_CAPS_pubproperty ReportViewName

Gets the name of the report view for the entity.

System_CAPS_pubproperty SchemaName

Gets or sets the schema name for the entity.

System_CAPS_pubproperty SyncToExternalSearchIndex

Gets or sets whether this entity is searchable in relevance search.

System_CAPS_pubproperty UsesBusinessDataLabelTable

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

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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 metadata
Sample: Create and update entity metadata
Sample: Dump entity metadata to a file

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright