CrmEntity Class

Dynamics CRM 2015

Other Versions

Applies To: Dynamics CRM 2015

Extensions to the core Microsoft.Xrm.Sdk.Entity class. (Developer Extensions)

Namespace: Microsoft.Xrm.Client
Assembly: Microsoft.Xrm.Client (in Microsoft.Xrm.Client.dll)

Inheritance Hierarchy

System::Object
Microsoft.Xrm.Sdk::Entity
Microsoft.Xrm.Client::CrmEntity

Syntax

C++

[IgnorePropertiesAttribute(new array<String^>^ { ... })]
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts")]
[DataServiceKeyAttribute("Id")]
public ref class CrmEntity : Entity, INotifyPropertyChanging, 
	INotifyPropertyChanged

Constructors

	Name	Description
	CrmEntity(String^)	Initializes a new instance of the CrmEntity class.

Properties

	Name	Description
	Attributes	(Inherited from Entity.)
	EntityState	(Inherited from Entity.)
	ExtensionData	(Inherited from Entity.)
	FormattedValues	(Inherited from Entity.)
	Id	(Inherited from Entity.)
	Item[String^]	(Inherited from Entity.)
	LogicalName	(Inherited from Entity.)
	RelatedEntities	(Inherited from Entity.)

Methods

	Name	Description
	Contains(String^)	(Inherited from Entity.)
	Equals(Object^)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetAttributeCollectionValue<T>(String^)	Retrieves the value of a sequence attribute.
	GetAttributeValue<T>(String^)	Retrieves the value of an attribute.(Overrides Entity::GetAttributeValue<T>(String^).)
	GetFormattedAttributeValue(String^)	(Inherited from Entity.)
	GetHashCode()	(Inherited from Object.)
	GetRelatedEntities<TEntity>(String^, Nullable<EntityRole>)	Gets the collection of related entity instances for the specified relationship.(Overrides Entity::GetRelatedEntities<TEntity>(String^, Nullable<EntityRole>).)
	GetRelatedEntity<TEntity>(String^, Nullable<EntityRole>)	Gets the related entity instance for the specified relationship.(Overrides Entity::GetRelatedEntity<TEntity>(String^, Nullable<EntityRole>).)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	SetAttributeCollectionValue<T>(String^, String^, IEnumerable<T>^)	Modifies the value of a sequence attribute.
	SetAttributeValue(String^, Object^)	(Inherited from Entity.)
	SetAttributeValue<T>(String^, String^, Object^)	Modifies the value of an attribute.
	SetAttributeValue<T>(String^, String^, String^, Object^)	Modifies the value of an attribute.
	SetPrimaryIdAttributeValue<T>(String^, String^, Object^)	Modifies the value of a primary key attribute.
	SetRelatedEntities<TEntity>(String^, Nullable<EntityRole>, IEnumerable<TEntity>^)	(Inherited from Entity.)
	SetRelatedEntities<TEntity>(String^, String^, IEnumerable<TEntity>^)	Sets the collection of related entity instances for the specified relationship.
	SetRelatedEntities<TEntity>(String^, String^, Nullable<EntityRole>, IEnumerable<TEntity>^)	Sets the collection of related entity instances for the specified relationship.
	SetRelatedEntity<TEntity>(String^, Nullable<EntityRole>, TEntity)	(Inherited from Entity.)
	SetRelatedEntity<TEntity>(String^, String^, TEntity)	Sets the related entity for a specific relationship.
	SetRelatedEntity<TEntity>(String^, String^, Nullable<EntityRole>, TEntity)	Sets the related entity for a specific relationship.
	ToEntity<T>()	(Inherited from Entity.)
	ToEntityReference()	(Inherited from Entity.)
	ToString()	(Inherited from Object.)

Events

	Name	Description
	PropertyChanged	Occurs when an attribute or relationship is set.
	PropertyChanging	Occurs when an attribute or relationship is set.

Extension Methods

	Name	Description
	AssertEntityName(array<String^>^)	Verifies that the logical name of an entity is the expected name.(Defined by EntityExtensions.)
	Clone(Boolean)	Overloaded. Deep clones an instance of the Entity class.(Defined by EntityExtensions.)
	GetAttributeValue(String^)	Overloaded. Retrieves the value of the attribute.(Defined by EntityExtensions.)
	GetEntityReferenceValue<T>(String^)	Retrieves attribute values for EntityReference attributes.(Defined by EntityExtensions.)
	GetRelatedEntities(OrganizationServiceContext^, Relationship^)	Overloaded. Retrieves the collection of related entities for a specific relationship.(Defined by EntityExtensions.)
	GetRelatedEntities(OrganizationServiceContext^, String^, Nullable<EntityRole>)	Overloaded. Retrieves the collection of related entities for a specific relationship.(Defined by EntityExtensions.)
	GetRelatedEntities<TEntity>(Relationship^)	Overloaded. Retrieves the collection of related entities for a specific relationship.(Defined by EntityExtensions.)
	GetRelatedEntities<TEntity, TResult>(Expression<Func<TEntity, IEnumerable<TResult>^>^>^)	Overloaded. Retrieves the collection of related entities for a specific relationship.(Defined by EntityExtensions.)
	GetRelatedEntity(OrganizationServiceContext^, Relationship^)	Overloaded. Retrieves the related entity for a specific relationship.(Defined by EntityExtensions.)
	GetRelatedEntity(OrganizationServiceContext^, String^, Nullable<EntityRole>)	Overloaded. Retrieves the related entity for a specific relationship.(Defined by EntityExtensions.)
	GetRelatedEntity<TEntity>(Relationship^)	Overloaded. Retrieves the related entity for a specific relationship.(Defined by EntityExtensions.)
	SerializeByJson(IEnumerable<Type^>^)	Serialize an object using the DataContractJsonSerializer.(Defined by ObjectExtensions.)
	SetAttributeCollectionValue<T>(String^, IEnumerable<T>^)	Modifies the value of a sequence attribute.(Defined by EntityExtensions.)
	SetAttributeValue(String^, String^, Object^)	Overloaded. Modifies the value of an attribute.(Defined by EntityExtensions.)
	SetAttributeValue<T>(String^, Object^)	Overloaded. Modifies the value of an attribute.(Defined by EntityExtensions.)
	SetRelatedEntities<TEntity>(Relationship^, IEnumerable<TEntity>^)	Overloaded. Modifies the collection of related entities for a specific relationship.(Defined by EntityExtensions.)
	SetRelatedEntities<TEntity>(String^, IEnumerable<TEntity>^)	Overloaded. Modifies the collection of related entities for a specific relationship.(Defined by EntityExtensions.)
	SetRelatedEntity<TEntity>(Relationship^, TEntity)	Overloaded. Modifies a related entity for a specific relationship.(Defined by EntityExtensions.)
	SetRelatedEntity<TEntity>(String^, TEntity)	Overloaded. Modifies a related entity for a specific relationship.(Defined by EntityExtensions.)

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.