linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.WebParts/IWebPartParameters.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebPartParameters" FullName="System.Web.UI.WebControls.WebParts.IWebPartParameters">
  <TypeSignature Language="C#" Value="public interface IWebPartParameters" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Data is usually sent from a provider to a consumer in a Web Parts connection. However, in some cases, a provider needs a parameter from the consumer to determine which values it should send back. The <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartParameters" /> interface defines members to implement that facilitate the passing of a parameter from a consumer to a provider. </para>
      <para>The <see cref="T:System.Web.UI.WebControls.WebParts.RowToParametersTransformer" /> class implements the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartParameters" /> interface. Transformers are used to translate data between two Web Parts controls with incompatible connection points. A <see cref="T:System.Web.UI.WebControls.WebParts.RowToParametersTransformer" /> object transforms data from a provider implementing the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartRow" /> interface when the provider needs a parameter from the consumer.</para>
      <para>The <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartParameters.GetParametersData(System.Web.UI.WebControls.WebParts.ParametersCallback)" /> method retrieves the data from the provider and provides a callback method to process the data for the consumer. The callback method can be a customized method within the consumer that sets the return values accordingly.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Defines the contract a Web Parts control implements to pass a parameter value in a Web Parts connection.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName="GetParametersData">
      <MemberSignature Language="C#" Value="public void GetParametersData (System.Web.UI.WebControls.WebParts.ParametersCallback callback);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="callback" Type="System.Web.UI.WebControls.WebParts.ParametersCallback" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartParameters.GetParametersData(System.Web.UI.WebControls.WebParts.ParametersCallback)" /> method is used to retrieve the values from the provider based on a parameter. The method represented by the <paramref name="callback" /> parameter processes the data for use by the consumer.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the value of the data from the connection provider.</para>
        </summary>
        <param name="callback">
          <attribution license="cc4" from="Microsoft" modified="false" />The method to call to process the data from the provider.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Schema">
      <MemberSignature Language="C#" Value="public System.ComponentModel.PropertyDescriptorCollection Schema { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.ComponentModel.PropertyDescriptorCollection</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartParameters.Schema" /> property provides property information for the data passed by the interface. Transformer and consumer controls can query this property to get information about the type, contents, and other details of the field contained in the <see cref="T:System.Web.UI.WebControls.WebParts.IWebPartParameters" /> interface instance.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the property descriptors for the data to be received by the consumer.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="SetConsumerSchema">
      <MemberSignature Language="C#" Value="public void SetConsumerSchema (System.ComponentModel.PropertyDescriptorCollection schema);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="schema" Type="System.ComponentModel.PropertyDescriptorCollection" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Sets the property descriptors for the properties that the consumer receives when calling the <see cref="M:System.Web.UI.WebControls.WebParts.IWebPartParameters.GetParametersData(System.Web.UI.WebControls.WebParts.ParametersCallback)" /> method.</para>
        </summary>
        <param name="schema">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> returned by <see cref="P:System.Web.UI.WebControls.WebParts.IWebPartParameters.Schema" />.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>