linux-packaging-mono/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ConnectionStringEditor.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="ConnectionStringEditor" FullName="System.Web.UI.Design.ConnectionStringEditor">
  <TypeSignature Language="C#" Value="public class ConnectionStringEditor : System.Drawing.Design.UITypeEditor" />
  <AssemblyInfo>
    <AssemblyName>System.Design</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Drawing.Design.UITypeEditor</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>An instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class is a <see cref="T:System.Drawing.Design.UITypeEditor" /> object that can be used at design time to select and edit a connection string expression and to assign the expression to a control property. For example, the <see cref="T:System.Web.UI.WebControls.SqlDataSource" /> control uses the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class at design time to set the value of the <see cref="P:System.Web.UI.WebControls.SqlDataSource.ConnectionString" /> property.</para>
      <para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> with a property. When the associated property is edited on the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method displays a user interface for building the connection string expression and returns the connection string that is selected by the user. The <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method indicates the display style of the user interface.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides a base class for a user interface to select and edit a connection string property at design time.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ConnectionStringEditor ();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="EditValue">
      <MemberSignature Language="C#" Value="public virtual object EditValue (System.ComponentModel.ITypeDescriptorContext context, IServiceProvider provider, object value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
        <Parameter Name="provider" Type="System.IServiceProvider" />
        <Parameter Name="value" Type="System.Object" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method starts the user interface for editing the <paramref name="value" /> object. The designer host calls the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method when you edit the value of a property that the connection string editor is associated with. The input service provider is used to obtain any editing services that are required within the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method.</para>
          <para>If an <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> service implementation is supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method initializes a <see cref="T:System.Web.UI.WebControls.ListBox" /> control, which prompts you to select an existing connection expression or build a new connection expression. If an <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> service implementation is not supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.EditValue" /> method displays a simple instance of the <see cref="T:System.Windows.Forms.Form" /> class, which prompts you to enter the connection expression string. </para>
          <para>If you cancel without selecting a connection expression string, the returned object is the same as the <paramref name="value" /> parameter.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Edits the value of the specified object by using the specified service provider and context.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The selected connection expression, as a string object; otherwise, if a connection expression was not selected, the same <paramref name="value" /> that was passed in.</para>
        </returns>
        <param name="context">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> to use to gain additional context information.</param>
        <param name="provider">
          <attribution license="cc4" from="Microsoft" modified="false" />A service provider object through which to obtain editing services.</param>
        <param name="value">
          <attribution license="cc4" from="Microsoft" modified="false" />An instance of the object being edited.</param>
      </Docs>
    </Member>
    <Member MemberName="GetEditStyle">
      <MemberSignature Language="C#" Value="public virtual System.Drawing.Design.UITypeEditorEditStyle GetEditStyle (System.ComponentModel.ITypeDescriptorContext context);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Drawing.Design.UITypeEditorEditStyle</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>By default, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class returns the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.Modal" /> value. If an <see cref="T:System.ComponentModel.Design.Data.IDataEnvironment" /> service implementation is supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method returns the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.DropDown" /> value.</para>
          <para>If the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method is not supported in the specified context, the <see cref="Overload:System.Web.UI.Design.ConnectionStringEditor.GetEditStyle" /> method returns the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" /> value.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns the editing style that is associated with the connection string editor for the specified context.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> enumeration value that indicates the editing style for the provided user interface.</para>
        </returns>
        <param name="context">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> to use to gain additional context information.</param>
      </Docs>
    </Member>
    <Member MemberName="GetProviderName">
      <MemberSignature Language="C#" Value="protected virtual string GetProviderName (object instance);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="instance" Type="System.Object" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.Design.ConnectionStringEditor.GetProviderName(System.Object)" /> method gets the provider name for the current instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class. For example, in the <see cref="T:System.Web.UI.Design.WebControls.SqlDataSourceConnectionStringEditor" /> class, which is derived from <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class, the <see cref="M:System.Web.UI.Design.ConnectionStringEditor.GetProviderName(System.Object)" /> method returns the provider name.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns the provider name for the provided instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Always an empty string ("").</para>
        </returns>
        <param name="instance">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> or an instance of a derived class.</param>
      </Docs>
    </Member>
    <Member MemberName="SetProviderName">
      <MemberSignature Language="C#" Value="protected virtual void SetProviderName (object instance, System.ComponentModel.Design.Data.DesignerDataConnection connection);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="instance" Type="System.Object" />
        <Parameter Name="connection" Type="System.ComponentModel.Design.Data.DesignerDataConnection" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.Design.ConnectionStringEditor.SetProviderName(System.Object,System.ComponentModel.Design.Data.DesignerDataConnection)" /> method sets the provider name on the <paramref name="instance" /> parameter. For example, in the SqlDataSourceConnectionStringEditor, which derives from the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class, this either sets the provider name or adds an <see cref="T:System.Web.UI.ExpressionBinding" /> object, if the connection is a configured connection. In this implementation, the <see cref="M:System.Web.UI.Design.ConnectionStringEditor.SetProviderName(System.Object,System.ComponentModel.Design.Data.DesignerDataConnection)" /> method does nothing.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Puts the provider name on the specified instance of the <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> class.</para>
        </summary>
        <param name="instance">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Design.ConnectionStringEditor" /> or an instance of a derived class.</param>
        <param name="connection">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" />.</param>
      </Docs>
    </Member>
  </Members>
</Type>