RelatedEntityCollection Class

Reference

Definition

Namespace:: Microsoft.Xrm.Sdk

Assembly:: Microsoft.Xrm.Sdk.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains a collection of related entities.

public ref class RelatedEntityCollection sealed : Microsoft::Xrm::Sdk::DataCollection<Microsoft::Xrm::Sdk::Relationship ^, Microsoft::Xrm::Sdk::EntityCollection ^>

[System.Runtime.Serialization.CollectionDataContract(Name="RelatedEntityCollection", Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RelatedEntityCollection : Microsoft.Xrm.Sdk.DataCollection<Microsoft.Xrm.Sdk.Relationship,Microsoft.Xrm.Sdk.EntityCollection>

[<System.Runtime.Serialization.CollectionDataContract(Name="RelatedEntityCollection", Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type RelatedEntityCollection = class
    inherit DataCollection<Relationship, EntityCollection>

Public NotInheritable Class RelatedEntityCollection
Inherits DataCollection(Of Relationship, EntityCollection)

Inheritance: Object

DataCollection<Relationship,EntityCollection>
RelatedEntityCollection

Attributes: CollectionDataContractAttribute

Remarks

For each related entity in the collection there is a key/value pair.

Constructors

RelatedEntityCollection()

Initializes a new instance of the RelatedEntityCollection class.

Properties

Count	Gets the number of elements in the collection. (Inherited from DataCollection<TKey,TValue>)
IsReadOnly	Gets a value indicating whether the RelatedEntityCollection is read-only.
Item[TKey]	Gets or sets the value associated with the specified key. (Inherited from DataCollection<TKey,TValue>)
Keys	Gets a collection containing the keys in the DataCollection<TKey,TValue>. (Inherited from DataCollection<TKey,TValue>)
Values	Gets a collection containing the values in the DataCollection<TKey,TValue>. (Inherited from DataCollection<TKey,TValue>)

Methods

Add(KeyValuePair<TKey,TValue>)	Adds the specified key and value to the dictionary. (Inherited from DataCollection<TKey,TValue>)
Add(TKey, TValue)	Adds the specified key and value to the dictionary. (Inherited from DataCollection<TKey,TValue>)
AddRange(IEnumerable<KeyValuePair<TKey,TValue>>)	Adds the elements of the specified collection to the end of the DataCollection<TKey,TValue>. (Inherited from DataCollection<TKey,TValue>)
AddRange(KeyValuePair<TKey,TValue>[])	Adds the elements of the specified collection to the end of the DataCollection<TKey,TValue>. (Inherited from DataCollection<TKey,TValue>)
Clear()	Removes all items from the DataCollection<TKey,TValue>. (Inherited from DataCollection<TKey,TValue>)
Contains(KeyValuePair<TKey,TValue>)	Determines whether the DataCollection<TKey,TValue> contains a specific value. (Inherited from DataCollection<TKey,TValue>)
Contains(TKey)	Determines whether the DataCollection<TKey,TValue> contains a specific value. (Inherited from DataCollection<TKey,TValue>)
ContainsKey(TKey)	Determines whether the DataCollection<TKey,TValue> contains a specific key value. (Inherited from DataCollection<TKey,TValue>)
CopyTo(KeyValuePair<TKey,TValue>[], Int32)	(Inherited from DataCollection<TKey,TValue>)
GetEnumerator()	Returns an enumerator that iterates through a collection. (Inherited from DataCollection<TKey,TValue>)
Remove(KeyValuePair<TKey,TValue>)	Removes the first occurrence of a specific object from the DataCollection<TKey,TValue>. (Inherited from DataCollection<TKey,TValue>)
Remove(TKey)	Removes the first occurrence of a specific object from the DataCollection<TKey,TValue>. (Inherited from DataCollection<TKey,TValue>)
TryGetValue(TKey, TValue)	Gets the value associated with the specified key. (Inherited from DataCollection<TKey,TValue>)

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through the collection.

(Inherited from DataCollection<TKey,TValue>)

Applies to

Jaa