165 lines
11 KiB
XML
165 lines
11 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="DesignerDataConnection" FullName="System.ComponentModel.Design.Data.DesignerDataConnection">
|
||
|
|
<TypeSignature Language="C#" Value="public sealed class DesignerDataConnection" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>System.Design</AssemblyName>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object represents a connection to a data store in the design tool. Typically a <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object is returned as part of the <see cref="P:System.ComponentModel.Design.Data.IDataEnvironment.Connections" /> property, and is created either by reading the application's configuration file or by calling the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.BuildConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection)" /> method.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Represents a connection to a data store in a design tool. This class cannot be inherited. </para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public DesignerDataConnection (string name, string providerName, string connectionString);" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="name" Type="System.String" />
|
||
|
|
<Parameter Name="providerName" Type="System.String" />
|
||
|
|
<Parameter Name="connectionString" Type="System.String" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Use this constructor to create <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> objects that are not created from the application's configuration file. When you use this constructor, the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property is set to false.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> class with the specified name, data provider, and connection string. </para>
|
||
|
|
</summary>
|
||
|
|
<param name="name">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name associated with this connection.</param>
|
||
|
|
<param name="providerName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the provider object used to access the underlying data store</param>
|
||
|
|
<param name="connectionString">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The string that specifies how to connect to the data store.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public DesignerDataConnection (string name, string providerName, string connectionString, bool isConfigured);" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="name" Type="System.String" />
|
||
|
|
<Parameter Name="providerName" Type="System.String" />
|
||
|
|
<Parameter Name="connectionString" Type="System.String" />
|
||
|
|
<Parameter Name="isConfigured" Type="System.Boolean" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Use this constructor when you need to specify the value of the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property, such as when you are creating a <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object from information stored in the application's configuration file. The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property is set to the value of the <paramref name="isConfigured" /> parameter.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> class with the specified name, data provider, and connection string, and indicates whether the connection was loaded from a configuration file. </para>
|
||
|
|
</summary>
|
||
|
|
<param name="name">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name associated with this connection.</param>
|
||
|
|
<param name="providerName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the provider object used to access the underlying data store.</param>
|
||
|
|
<param name="connectionString">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The string that specifies how to connect to the data store.</param>
|
||
|
|
<param name="isConfigured">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true to indicate the connection was created from information stored in the application's configuration file; otherwise, false.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="ConnectionString">
|
||
|
|
<MemberSignature Language="C#" Value="public string ConnectionString { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.ConnectionString" /> property contains the connection string used by the application for connecting to the data store. You must use the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.GetDesignTimeConnection(System.ComponentModel.Design.Data.DesignerDataConnection)" /> method to return a connection string suitable for use in the design environment.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the application connection string defined for the connection.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="IsConfigured">
|
||
|
|
<MemberSignature Language="C#" Value="public bool IsConfigured { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property will be true if the <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object was read from the application's configuration file, or if the <see cref="T:System.ComponentModel.Design.Data.DesignerDataConnection" /> object was written to the application's configuration file by the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.ConfigureConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.String)" /> method.</para>
|
||
|
|
<para>When the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> is true, the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.Name" /> property is set to the name of the connection as defined in the <format type="text/html"><a href="b6ffbb2e-a4d1-410e-8f7e-9755e92c65de">connectionStrings Element (ASP.NET Settings Schema)</a></format> of the configuration file.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets a value indicating whether the connection information is in the application's configuration file.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Name">
|
||
|
|
<MemberSignature Language="C#" Value="public string Name { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.Name" /> property contains the name that identifies a specific connection in an application configuration file or a list of data connections. When the <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.IsConfigured" /> property is true, <see cref="P:System.ComponentModel.Design.Data.DesignerDataConnection.Name" /> property is used as the name attribute in the <format type="text/html"><a href="b6ffbb2e-a4d1-410e-8f7e-9755e92c65de">connectionStrings</a></format> configuration element, or is returned from the <see cref="M:System.ComponentModel.Design.Data.IDataEnvironment.ConfigureConnection(System.Windows.Forms.IWin32Window,System.ComponentModel.Design.Data.DesignerDataConnection,System.String)" /> method.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the name of the data connection.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="ProviderName">
|
||
|
|
<MemberSignature Language="C#" Value="public string ProviderName { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the name of the provider used to access the underlying data store.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|