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 = "https://schemas.microsoft.com/xrm/2011/Metadata")]
[MetadataNameAttribute(LogicalName = "EntityMetadata", LogicalCollectionName = "EntityDefinitions")]
public sealed class EntityMetadata : MetadataBase
<DataContractAttribute(Name := "EntityMetadata", Namespace := "https://schemas.microsoft.com/xrm/2011/Metadata")>
<MetadataNameAttribute(LogicalName := "EntityMetadata", LogicalCollectionName := "EntityDefinitions")>
Public NotInheritable Class EntityMetadata
Inherits MetadataBase
Constructors
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
EntityMetadata() | Initializes a new instance of the EntityMetadata class |
Properties
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubproperty") |
ActivityTypeMask | Gets or sets whether a custom activity should appear in the activity menus in the Web application. |
|
Attributes | Gets the array of attribute metadata for the entity. |
|
AutoCreateAccessTeams | Gets or sets whether the entity is enabled for auto created access teams. |
|
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. |
|
CanBeInManyToMany | Gets the property that determines whether the entity can be in a Many-to-Many entity relationship. |
|
CanBePrimaryEntityInRelationship | Gets the property that determines whether the entity can be the referenced entity in a One-to-Many entity relationship. |
|
CanBeRelatedEntityInRelationship | Gets the property that determines whether the entity can be the referencing entity in a One-to-Many entity relationship. |
|
CanChangeHierarchicalRelationship | Gets or sets whether the hierarchical state of entity relationships included in your managed solutions can be changed. |
|
CanChangeTrackingBeEnabled | This API supports the product infrastructure and is not intended to be used directly from your code. |
|
CanCreateAttributes | Gets or sets the property that determines whether additional attributes can be added to the entity. |
|
CanCreateCharts | Gets or sets the property that determines whether new charts can be created for the entity. |
|
CanCreateForms | Gets or sets the property that determines whether new forms can be created for the entity. |
|
CanCreateViews | Gets or sets the property that determines whether new views can be created for the entity. |
|
CanEnableSyncToExternalSearchIndex | Gets or sets whether this entity can be enabled for relevance search when customizing a managed solution. |
|
CanModifyAdditionalSettings | Gets or sets the property that determines whether any other entity properties not represented by a managed property can be changed. |
|
CanTriggerWorkflow | Gets whether the entity can trigger a workflow process. |
|
ChangeTrackingEnabled | Gets or sets a Boolean value that specifies whether change tracking is enabled for an entity or not. |
|
CollectionSchemaName | Gets or sets the collection schema name of the entity. |
|
DaysSinceRecordLastModified | |
|
Description | Gets or sets the label containing the description for the entity. |
|
DisplayCollectionName | Gets or sets the label containing the plural display name for the entity. |
|
DisplayName | Gets or sets the label containing the display name for the entity. |
|
EnforceStateTransitions | Gets whether the entity will enforce custom state transitions. |
|
EntityColor | Gets or sets the hexadecimal code to represent the color to be used for this entity in the application. |
|
EntityHelpUrl | Gets or sets the URL of the resource to display help content for this entity |
|
EntityHelpUrlEnabled | Gets or sets whether the entity supports custom help content. |
|
EntitySetName | Gets or sets the entity set name. |
|
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.) |
|
IconLargeName | Gets or sets the name of the image web resource for the large icon for the entity. |
|
IconMediumName | Gets or sets the name of the image web resource for the medium icon for the entity. |
|
IconSmallName | Gets or sets the name of the image web resource for the small icon for the entity. |
|
IntroducedVersion | Gets a string identifying the solution version that the solution component was added in. |
|
IsActivity | Gets or sets whether the entity is an activity. |
|
IsActivityParty | Gets or sets whether the email messages can be sent to an email address stored in a record of this type. |
|
IsAIRUpdated | Gets whether the entity uses the updated user interface. |
|
IsAuditEnabled | Gets or sets the property that determines whether auditing has been enabled for the entity. |
|
IsAvailableOffline | Gets or sets whether the entity is available offline. |
|
IsBPFEntity | |
|
IsBusinessProcessEnabled | Gets whether the entity is enabled for business process flows. |
|
IsChildEntity | Gets whether the entity is a child entity. |
|
IsConnectionsEnabled | Gets or sets the property that determines whether connections are enabled for this entity. |
|
IsCustomEntity | Gets whether the entity is a custom entity. |
|
IsCustomizable | Gets or sets the property that determines whether the entity is customizable. |
|
IsDocumentManagementEnabled | Gets or sets the property that determines whether document management is enabled. |
|
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. |
|
IsDuplicateDetectionEnabled | Gets or sets the property that determines whether duplicate detection is enabled. |
|
IsEnabledForCharts | Gets whether charts are enabled. |
|
IsEnabledForExternalChannels | This API supports the product infrastructure and is not intended to be used directly from your code. |
|
IsEnabledForTrace | For internal use only. |
|
IsImportable | Gets whether the entity can be imported using the Import Wizard. |
|
IsInteractionCentricEnabled | Gets or sets whether the entity is enabled for interactive experience. |
|
IsIntersect | Gets whether the entity is an intersection table for two other entities. |
|
IsKnowledgeManagementEnabled | Gets or sets whether Parature knowledge management integration is enabled for the entity. |
|
IsLogicalEntity | This API supports the product infrastructure and is not intended to be used directly from your code. |
|
IsMailMergeEnabled | Gets or sets the property that determines whether mail merge is enabled for this entity. |
|
IsManaged | Gets whether the entity is part of a managed solution. |
|
IsMappable | Gets or sets the property that determines whether entity mapping is available for the entity. |
|
IsOfflineInMobileClient | |
|
IsOneNoteIntegrationEnabled | Gets or sets whether OneNote integration is enabled for the. |
|
IsOptimisticConcurrencyEnabled | Gets whether optimistic concurrency is enabled for the entity |
|
IsPrivate | Gets whether the entity is public or private. |
|
IsQuickCreateEnabled | Gets or sets the value indicating if the entity is enabled for quick create forms. |
|
IsReadingPaneEnabled | For internal use only. |
|
IsReadOnlyInMobileClient | Gets or sets the property that determines whether Microsoft Dynamics 365 for tablets users can update data for this entity. |
|
IsRenameable | Gets or sets the property that determines whether the entity DisplayName and DisplayCollectionName can be changed by editing the entity in the application. |
|
IsSLAEnabled | Gets or sets the value indicating if the entity is enabled for service level agreements (SLAs). |
|
IsStateModelAware | Gets whether the entity supports setting custom state transitions. |
|
IsValidForAdvancedFind | Gets or sets whether the entity is will be shown in Advanced Find. |
|
IsValidForQueue | Gets or sets the property that determines whether the entity is enabled for queues. |
|
IsVisibleInMobile | Gets or sets the property that determines whether Microsoft Dynamics 365 for phones users can see data for this entity. |
|
IsVisibleInMobileClient | Gets or sets the property that determines whether Microsoft Dynamics 365 for tablets users can see data for this entity. |
|
Keys | Gets an array of keys for an entity. |
|
LogicalCollectionName | Gets the logical collection name. |
|
LogicalName | Gets or sets the logical name for the entity. |
|
ManyToManyRelationships | Gets the array of many-to-many relationships for the entity. |
|
ManyToOneRelationships | Gets the array of many-to-one relationships for the entity. |
|
MetadataId | Gets or sets a unique identifier for the metadata item.(Inherited from MetadataBase.) |
|
MobileOfflineFilters | This API supports the product infrastructure and is not intended to be used directly from your code. |
|
ObjectTypeCode | Gets the entity type code. |
|
OneToManyRelationships | Gets the array of one-to-many relationships for the entity. |
|
OwnershipType | Gets or sets the ownership type for the entity. |
|
PrimaryIdAttribute | Gets the name of the attribute that is the primary id for the entity. |
|
PrimaryImageAttribute | Gets the name of the primary image attribute for an entity. |
|
PrimaryNameAttribute | Gets the name of the primary attribute for an entity. |
|
Privileges | Gets the privilege metadata for the entity. |
|
RecurrenceBaseEntityLogicalName | Gets the name of the entity that is recurring. |
|
ReportViewName | Gets the name of the report view for the entity. |
|
SchemaName | Gets or sets the schema name for the entity. |
|
SyncToExternalSearchIndex | Gets or sets whether this entity is searchable in relevance search. |
|
UsesBusinessDataLabelTable | This API supports the product infrastructure and is not intended to be used directly from your code. |
Methods
| Name | Description | |
|---|---|---|
|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
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