EntityCollectionChangedParams.xml

<Type Name="EntityCollectionChangedParams" FullName="System.Data.Services.Client.EntityCollectionChangedParams">
  <TypeSignature Language="C#" Value="public sealed class EntityCollectionChangedParams" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit EntityCollectionChangedParams extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Data.Services.Client.EntityCollectionChangedParams" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class EntityCollectionChangedParams" />
  <TypeSignature Language="F#" Value="type EntityCollectionChangedParams = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class EntityCollectionChangedParams sealed" />
  <AssemblyInfo>
    <AssemblyName>System.Data.Services.Client</AssemblyName>
    <AssemblyVersion>2.0.5.0</AssemblyVersion>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Encapsulates the arguments of a <see cref="E:System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged" /> delegate.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following code-behind page for the XAML file creates a <xref:System.Data.Services.Client.DataServiceCollection%601> with custom methods that are called when changes occur to data that is bound to the binding collection. When the <xref:System.Collections.ObjectModel.ObservableCollection%601.CollectionChanged> event occurs, the supplied method prevents an item that has been removed from the binding collection from being deleted from the data service. When the <xref:System.Collections.ObjectModel.ObservableCollection%601.PropertyChanged> event occurs, the `ShipDate` value is validated to ensure that changes are not made to orders that have already shipped.  
  
 :::code language="csharp" source="~/snippets/csharp/System.Data.Services.Client/DataServiceCollectionT/Overview/customerorderscustom.xaml.cs" id="Snippetwpfdatabindingcustom":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/astoria_northwind_client/vb/customerorderscustom.xaml.vb" id="Snippetwpfdatabindingcustom":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/astoria_northwind_client/vb/customerorderscustom2.xaml.vb" id="Snippetwpfdatabindingcustom":::  
  
 The following XAML code defines the window for the previous example.  
  
 :::code language="xaml" source="~/snippets/visualbasic/VS_Snippets_Misc/astoria_northwind_client/vb/customerorderscustom.xaml" id="Snippetwpfdatabindingcustomxaml":::  
  
 ]]></format>
    </remarks>
    <related type="Article" href="/dotnet/framework/data/wcf/binding-data-to-controls-wcf-data-services">Binding Data to Controls (WCF Data Services)</related>
    <related type="Article" href="/dotnet/framework/data/wcf/how-to-customize-data-binding-behaviors-wcf-data-services">How to: Customize Data Binding Behaviors (WCF Data Services)</related>
  </Docs>
  <Members>
    <Member MemberName="Action">
      <MemberSignature Language="C#" Value="public System.Collections.Specialized.NotifyCollectionChangedAction Action { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Collections.Specialized.NotifyCollectionChangedAction Action" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Client.EntityCollectionChangedParams.Action" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Action As NotifyCollectionChangedAction" />
      <MemberSignature Language="F#" Value="member this.Action : System.Collections.Specialized.NotifyCollectionChangedAction" Usage="System.Data.Services.Client.EntityCollectionChangedParams.Action" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::Specialized::NotifyCollectionChangedAction Action { System::Collections::Specialized::NotifyCollectionChangedAction get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Services.Client</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Specialized.NotifyCollectionChangedAction</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>A <see cref="T:System.Collections.Specialized.NotifyCollectionChangedAction" /> value that indicates how the collection was changed.</summary>
        <value>A value that indicates how the collection was changed.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Only the values <xref:System.Collections.Specialized.NotifyCollectionChangedAction.Add> and <xref:System.Collections.Specialized.NotifyCollectionChangedAction.Remove> are supported.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Collection">
      <MemberSignature Language="C#" Value="public System.Collections.ICollection Collection { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ICollection Collection" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Client.EntityCollectionChangedParams.Collection" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Collection As ICollection" />
      <MemberSignature Language="F#" Value="member this.Collection : System.Collections.ICollection" Usage="System.Data.Services.Client.EntityCollectionChangedParams.Collection" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::ICollection ^ Collection { System::Collections::ICollection ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Services.Client</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.ICollection</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The <see cref="T:System.Data.Services.Client.DataServiceCollection`1" /> that has changed.</summary>
        <value>A reference to the collection that has changed.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Context">
      <MemberSignature Language="C#" Value="public System.Data.Services.Client.DataServiceContext Context { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Data.Services.Client.DataServiceContext Context" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Client.EntityCollectionChangedParams.Context" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Context As DataServiceContext" />
      <MemberSignature Language="F#" Value="member this.Context : System.Data.Services.Client.DataServiceContext" Usage="System.Data.Services.Client.EntityCollectionChangedParams.Context" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Data::Services::Client::DataServiceContext ^ Context { System::Data::Services::Client::DataServiceContext ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Services.Client</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Data.Services.Client.DataServiceContext</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The <see cref="T:System.Data.Services.Client.DataServiceContext" /> associated with the <see cref="T:System.Data.Services.Client.DataServiceCollection`1" /> that has changed.</summary>
        <value>The context associated with the collection that has changed.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PropertyName">
      <MemberSignature Language="C#" Value="public string PropertyName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string PropertyName" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Client.EntityCollectionChangedParams.PropertyName" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property PropertyName As String" />
      <MemberSignature Language="F#" Value="member this.PropertyName : string" Usage="System.Data.Services.Client.EntityCollectionChangedParams.PropertyName" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ PropertyName { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Services.Client</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The navigation property on the source object that references the collection that has changed.</summary>
        <value>The navigation property name.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SourceEntity">
      <MemberSignature Language="C#" Value="public object SourceEntity { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object SourceEntity" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Client.EntityCollectionChangedParams.SourceEntity" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SourceEntity As Object" />
      <MemberSignature Language="F#" Value="member this.SourceEntity : obj" Usage="System.Data.Services.Client.EntityCollectionChangedParams.SourceEntity" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ SourceEntity { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Services.Client</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The source object that references the target object in the collection by using a navigation property.</summary>
        <value>The source object.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SourceEntitySet">
      <MemberSignature Language="C#" Value="public string SourceEntitySet { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string SourceEntitySet" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Client.EntityCollectionChangedParams.SourceEntitySet" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SourceEntitySet As String" />
      <MemberSignature Language="F#" Value="member this.SourceEntitySet : string" Usage="System.Data.Services.Client.EntityCollectionChangedParams.SourceEntitySet" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ SourceEntitySet { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Services.Client</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The entity set of the source object.</summary>
        <value>An entity set name.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TargetEntity">
      <MemberSignature Language="C#" Value="public object TargetEntity { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object TargetEntity" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Client.EntityCollectionChangedParams.TargetEntity" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TargetEntity As Object" />
      <MemberSignature Language="F#" Value="member this.TargetEntity : obj" Usage="System.Data.Services.Client.EntityCollectionChangedParams.TargetEntity" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ TargetEntity { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Services.Client</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The entity object in the collection that has changed.</summary>
        <value>The changed entity object in the collection.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TargetEntitySet">
      <MemberSignature Language="C#" Value="public string TargetEntitySet { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TargetEntitySet" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Client.EntityCollectionChangedParams.TargetEntitySet" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TargetEntitySet As String" />
      <MemberSignature Language="F#" Value="member this.TargetEntitySet : string" Usage="System.Data.Services.Client.EntityCollectionChangedParams.TargetEntitySet" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ TargetEntitySet { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Data.Services.Client</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The entity set name of the object in the collection.</summary>
        <value>An entity set name.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>