mcs/class/System.Data/Documentation/en/System.Data.Common/DbProviderSpecificTypePropertyAttribute.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DbProviderSpecificTypePropertyAttribute" FullName="System.Data.Common.DbProviderSpecificTypePropertyAttribute">
   3   <TypeSignature Language="C#" Value="public sealed class DbProviderSpecificTypePropertyAttribute : Attribute" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Data</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Attribute</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Attributes>
  13     <Attribute>
  14       <AttributeName>System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)</AttributeName>
  15     </Attribute>
  16   </Attributes>
  17   <Docs>
  18     <since version=".NET 2.0" />
  19     <remarks>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>The <see cref="T:System.Data.Common.DbProviderSpecificTypePropertyAttribute" /> is used by a provider writer to designate a provider-specific type parameter property which is not inherited from the <see cref="T:System.Data.Common.DbParameter" /> base class. The <see cref="P:System.Data.SqlClient.SqlParameter.SqlDbType" /> property of a <see cref="T:System.Data.SqlClient.SqlParameter" /> is an example of a provider-specific type property not found in DbParameter.</para>
  22       <para>A provider writer can apply DbProviderSpecificTypePropertyAttribute(true) to indicate a provider-specific data type parameter property. This allows for its discovery using reflection, which enables code generation tools, such as those used in Visual Studio, to generate code geared to a specific provider. The <see cref="P:System.Data.Common.DbProviderSpecificTypePropertyAttribute.IsProviderSpecificTypeProperty" /> property returns true if the property has been set, otherwise false. </para>
  23     </remarks>
  24     <summary>
  25       <attribution license="cc4" from="Microsoft" modified="false" />
  26       <para>Identifies which provider-specific property in the strongly typed parameter classes is to be used when setting a provider-specific type.</para>
  27     </summary>
  28   </Docs>
  29   <Members>
  30     <Member MemberName=".ctor">
  31       <MemberSignature Language="C#" Value="public DbProviderSpecificTypePropertyAttribute (bool isProviderSpecificTypeProperty);" />
  32       <MemberType>Constructor</MemberType>
  33       <Parameters>
  34         <Parameter Name="isProviderSpecificTypeProperty" Type="System.Boolean" />
  35       </Parameters>
  36       <Docs>
  37         <remarks>To be added.</remarks>
  38         <since version=".NET 2.0" />
  39         <summary>
  40           <attribution license="cc4" from="Microsoft" modified="false" />
  41           <para>Initializes a new instance of a <see cref="T:System.Data.Common.DbProviderSpecificTypePropertyAttribute" /> class.</para>
  42         </summary>
  43         <param name="isProviderSpecificTypeProperty">
  44           <attribution license="cc4" from="Microsoft" modified="false" />Specifies whether this property is a provider-specific property.</param>
  45       </Docs>
  46       <AssemblyInfo>
  47         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  48       </AssemblyInfo>
  49     </Member>
  50     <Member MemberName="IsProviderSpecificTypeProperty">
  51       <MemberSignature Language="C#" Value="public bool IsProviderSpecificTypeProperty { get; }" />
  52       <MemberType>Property</MemberType>
  53       <ReturnValue>
  54         <ReturnType>System.Boolean</ReturnType>
  55       </ReturnValue>
  56       <Docs>
  57         <value>To be added.</value>
  58         <remarks>To be added.</remarks>
  59         <since version=".NET 2.0" />
  60         <summary>
  61           <attribution license="cc4" from="Microsoft" modified="false" />
  62           <para>Indicates whether the attributed property is a provider-specific type.</para>
  63         </summary>
  64       </Docs>
  65       <AssemblyInfo>
  66         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  67       </AssemblyInfo>
  68     </Member>
  69   </Members>
  70 </Type>