DesignerDataStoredProcedure.xml

<Type Name="DesignerDataStoredProcedure" FullName="System.ComponentModel.Design.Data.DesignerDataStoredProcedure">
  <TypeSignature Language="C#" Value="public abstract class DesignerDataStoredProcedure" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit DesignerDataStoredProcedure extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class DesignerDataStoredProcedure" />
  <TypeSignature Language="F#" Value="type DesignerDataStoredProcedure = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class DesignerDataStoredProcedure abstract" />
  <AssemblyInfo>
    <AssemblyName>System.Design</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Represents a stored procedure in the data store.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.ComponentModel.Design.Data.DesignerDataStoredProcedure> class is one of several types that represent the schema of a data store at design-time. These schema items are made available to controls by designers implementing the <xref:System.ComponentModel.Design.Data.IDataEnvironment> interface. Controls access schema objects by calling the <xref:System.ComponentModel.Design.Data.IDataEnvironment.GetConnectionSchema%2A> method of the interface.  
  
 The <xref:System.ComponentModel.Design.Data.DesignerDataStoredProcedure> class represents a single table in the data store. A collection of <xref:System.ComponentModel.Design.Data.DesignerDataStoredProcedure> objects is returned when you call the <xref:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems%2A> method with the `schemaClass` parameter set to <xref:System.ComponentModel.Design.Data.DesignerDataSchemaClass.StoredProcedures?displayProperty=nameWithType>.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <MemberGroup MemberName=".ctor">
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" /> class.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected DesignerDataStoredProcedure (string name);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New (name As String)" />
      <MemberSignature Language="F#" Value="new System.ComponentModel.Design.Data.DesignerDataStoredProcedure : string -&gt; System.ComponentModel.Design.Data.DesignerDataStoredProcedure" Usage="new System.ComponentModel.Design.Data.DesignerDataStoredProcedure name" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; DesignerDataStoredProcedure(System::String ^ name);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.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="name" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="name">The name of the stored procedure.</param>
        <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" /> class with the specified name.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected DesignerDataStoredProcedure (string name, string owner);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(string name, string owner) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.#ctor(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New (name As String, owner As String)" />
      <MemberSignature Language="F#" Value="new System.ComponentModel.Design.Data.DesignerDataStoredProcedure : string * string -&gt; System.ComponentModel.Design.Data.DesignerDataStoredProcedure" Usage="new System.ComponentModel.Design.Data.DesignerDataStoredProcedure (name, owner)" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; DesignerDataStoredProcedure(System::String ^ name, System::String ^ owner);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.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="name" Type="System.String" />
        <Parameter Name="owner" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="name">The name of the stored procedure.</param>
        <param name="owner">The data store owner of the stored procedure.</param>
        <summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataStoredProcedure" /> class with the specified name and owner.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateParameters">
      <MemberSignature Language="C#" Value="protected abstract System.Collections.ICollection CreateParameters ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Collections.ICollection CreateParameters() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.CreateParameters" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride Function CreateParameters () As ICollection" />
      <MemberSignature Language="F#" Value="abstract member CreateParameters : unit -&gt; System.Collections.ICollection" Usage="designerDataStoredProcedure.CreateParameters " />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; abstract System::Collections::ICollection ^ CreateParameters();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.ICollection</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>When overridden in a derived class, returns a collection of parameters for the stored procedure.</summary>
        <returns>A collection of <see cref="T:System.ComponentModel.Design.Data.DesignerDataParameter" /> objects.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.CreateParameters%2A> method is called the first time the <xref:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters%2A> property is accessed to populate the collection of stored-procedure parameters.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Name" />
      <MemberSignature Language="DocId" Value="P:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Name" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
      <MemberSignature Language="F#" Value="member this.Name : string" Usage="System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Name" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Name { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.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 name of the stored procedure.</summary>
        <value>The name of the stored procedure.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Owner">
      <MemberSignature Language="C#" Value="public string Owner { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Owner" />
      <MemberSignature Language="DocId" Value="P:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Owner" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Owner As String" />
      <MemberSignature Language="F#" Value="member this.Owner : string" Usage="System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Owner" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Owner { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.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 owner of the stored procedure.</summary>
        <value>The owner of the stored procedure.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Parameters">
      <MemberSignature Language="C#" Value="public System.Collections.ICollection Parameters { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ICollection Parameters" />
      <MemberSignature Language="DocId" Value="P:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parameters As ICollection" />
      <MemberSignature Language="F#" Value="member this.Parameters : System.Collections.ICollection" Usage="System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::ICollection ^ Parameters { System::Collections::ICollection ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.ICollection</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a collection of parameters required for a stored procedure.</summary>
        <value>A collection of parameters for the stored procedure.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters%2A> property is populated by the <xref:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.CreateParameters%2A> method the first time the <xref:System.ComponentModel.Design.Data.DesignerDataStoredProcedure.Parameters%2A> property is accessed.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>