EntitySetAttribute.xml

<Type Name="EntitySetAttribute" FullName="System.Data.Services.Common.EntitySetAttribute">
  <TypeSignature Language="C#" Value="public sealed class EntitySetAttribute : Attribute" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit EntitySetAttribute extends System.Attribute" />
  <TypeSignature Language="DocId" Value="T:System.Data.Services.Common.EntitySetAttribute" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class EntitySetAttribute&#xA;Inherits Attribute" />
  <TypeSignature Language="F#" Value="type EntitySetAttribute = class&#xA;    inherit Attribute" />
  <TypeSignature Language="C++ CLI" Value="public ref class EntitySetAttribute sealed : Attribute" />
  <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.Attribute</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Indicates the entity set to which a client data service class belongs.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Data.Services.Common.EntitySetAttribute> class is used by the client during data binding to determine the name of the entity set to which a class belongs. This attribute is generated by the `Add Service Reference` dialog box when the Binding option is used and by the [DataSvcUtil.exe](/dotnet/framework/data/wcf/wcf-data-service-client-utility-datasvcutil-exe) tool when the `/binding` option is supplied.  
  
 You must apply the <xref:System.Data.Services.Common.EntitySetAttribute> to any user-supplied client data service classes that are used with data binding.  
  
 <xref:System.Data.Services.Common.EntitySetAttribute> is only supported when there is one entity set associated with the type.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public EntitySetAttribute (string entitySet);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string entitySet) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Data.Services.Common.EntitySetAttribute.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (entitySet As String)" />
      <MemberSignature Language="F#" Value="new System.Data.Services.Common.EntitySetAttribute : string -&gt; System.Data.Services.Common.EntitySetAttribute" Usage="new System.Data.Services.Common.EntitySetAttribute entitySet" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; EntitySetAttribute(System::String ^ entitySet);" />
      <MemberType>Constructor</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#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters>
        <Parameter Name="entitySet" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="entitySet">The entity set to which the class belongs.</param>
        <summary>Creates a new instance of the <see cref="T:System.Data.Services.Common.EntitySetAttribute" />.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EntitySet">
      <MemberSignature Language="C#" Value="public string EntitySet { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string EntitySet" />
      <MemberSignature Language="DocId" Value="P:System.Data.Services.Common.EntitySetAttribute.EntitySet" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property EntitySet As String" />
      <MemberSignature Language="F#" Value="member this.EntitySet : string" Usage="System.Data.Services.Common.EntitySetAttribute.EntitySet" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ EntitySet { 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>Gets the entity set to which the class belongs.</summary>
        <value>The entity set as string value.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>