IDReferencePropertyAttribute.xml

<Type Name="IDReferencePropertyAttribute" FullName="System.Web.UI.IDReferencePropertyAttribute">
  <TypeSignature Language="C#" Value="public sealed class IDReferencePropertyAttribute : Attribute" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit IDReferencePropertyAttribute extends System.Attribute" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.IDReferencePropertyAttribute" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class IDReferencePropertyAttribute&#xA;Inherits Attribute" />
  <TypeSignature Language="F#" Value="type IDReferencePropertyAttribute = class&#xA;    inherit Attribute" />
  <TypeSignature Language="C++ CLI" Value="public ref class IDReferencePropertyAttribute sealed : Attribute" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Attribute</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Property)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.AttributeUsage(System.AttributeTargets.Property)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Defines an attribute applied to properties that contain ID references. This class cannot be inherited.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.IDReferencePropertyAttribute> class is applied to properties that contain ID references. <xref:System.Web.UI.WebControls.Content.ContentPlaceHolderID%2A> is an example of a property that contains an ID reference. When this attribute is applied, designers can provide additional functionality during design time, such as listing IDs.  
  
   
  
## Examples  
 The following code example demonstrates how the <xref:System.Web.UI.IDReferencePropertyAttribute> attribute is applied to a property that evaluates to a string. In this example, the `DataSourceID` member identifies a data source control and therefore specifies the <xref:System.Web.UI.DataSourceControl> type.  
  
 :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.IDReferencePropertyAttribute/CS/IDReferencePropertyAttribute2.cs" id="Snippet2":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.IDReferencePropertyAttribute/VB/IDReferencePropertyAttribute2.vb" id="Snippet2":::  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Web.UI.WebControls.ControlIDConverter" />
  </Docs>
  <Members>
    <MemberGroup MemberName=".ctor">
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.Web.UI.IDReferencePropertyAttribute" /> class.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public IDReferencePropertyAttribute ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.IDReferencePropertyAttribute.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; IDReferencePropertyAttribute();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.Web.UI.IDReferencePropertyAttribute" /> class.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 When you call this constructor, the <xref:System.Web.UI.IDReferencePropertyAttribute.ReferencedControlType%2A> property is set to <xref:System.Web.UI.Control>, which is its default value.  
  
   
  
## Examples  
 The following code example demonstrates how the <xref:System.Web.UI.IDReferencePropertyAttribute> attribute is applied to a property that evaluates to a string. In this example, the `DataSourceID` member identifies a data source control at run time. By using the parameterless constructor, the <xref:System.Web.UI.IDReferencePropertyAttribute.ReferencedControlType%2A> property is set to the default value, <xref:System.Web.UI.Control>.  
  
 :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.IDReferencePropertyAttribute/CS/IDReferencePropertyAttribute1.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.IDReferencePropertyAttribute/VB/IDReferencePropertyAttribute1.vb" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="P:System.Web.UI.IDReferencePropertyAttribute.ReferencedControlType" />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public IDReferencePropertyAttribute (Type referencedControlType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Type referencedControlType) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.IDReferencePropertyAttribute.#ctor(System.Type)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (referencedControlType As Type)" />
      <MemberSignature Language="F#" Value="new System.Web.UI.IDReferencePropertyAttribute : Type -&gt; System.Web.UI.IDReferencePropertyAttribute" Usage="new System.Web.UI.IDReferencePropertyAttribute referencedControlType" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; IDReferencePropertyAttribute(Type ^ referencedControlType);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</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="referencedControlType" Type="System.Type" />
      </Parameters>
      <Docs>
        <param name="referencedControlType">A <see cref="T:System.Type" /> that specifies the type of the control represented by the property to which the <see cref="T:System.Web.UI.IDReferencePropertyAttribute" /> is applied.</param>
        <summary>Initializes a new instance of the <see cref="T:System.Web.UI.IDReferencePropertyAttribute" /> class using the specified type.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following code example demonstrates how the <xref:System.Web.UI.IDReferencePropertyAttribute> attribute is applied to a property that evaluates to a string. In this example, the `DataSourceID` member identifies a data source control and therefore specifies the <xref:System.Web.UI.DataSourceControl> type.  
  
 :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.IDReferencePropertyAttribute/CS/IDReferencePropertyAttribute2.cs" id="Snippet2":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.IDReferencePropertyAttribute/VB/IDReferencePropertyAttribute2.vb" id="Snippet2":::  
  
 ]]></format>
        </remarks>
        <altmember cref="P:System.Web.UI.IDReferencePropertyAttribute.ReferencedControlType" />
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.IDReferencePropertyAttribute.Equals(System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="iDReferencePropertyAttribute.Equals obj" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override bool Equals(System::Object ^ obj);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">An <see cref="T:System.Object" /> to compare with this instance or a null reference (<see langword="Nothing" /> in Visual Basic).</param>
        <summary>Returns a value that indicates whether this instance is equal to a specified object.</summary>
        <returns>
          <see langword="true" /> if <paramref name="obj" /> equals the type and value of this instance; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
        <altmember cref="M:System.Attribute.Equals(System.Object)" />
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.IDReferencePropertyAttribute.GetHashCode" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="iDReferencePropertyAttribute.GetHashCode " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override int GetHashCode();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the hash code for this instance.</summary>
        <returns>A 32-bit signed integer hash code.</returns>
        <remarks>To be added.</remarks>
        <altmember cref="M:System.Attribute.GetHashCode" />
      </Docs>
    </Member>
    <Member MemberName="ReferencedControlType">
      <MemberSignature Language="C#" Value="public Type ReferencedControlType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Type ReferencedControlType" />
      <MemberSignature Language="DocId" Value="P:System.Web.UI.IDReferencePropertyAttribute.ReferencedControlType" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ReferencedControlType As Type" />
      <MemberSignature Language="F#" Value="member this.ReferencedControlType : Type" Usage="System.Web.UI.IDReferencePropertyAttribute.ReferencedControlType" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Type ^ ReferencedControlType { Type ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</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.Type</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the type of the controls allowed by the property to which the <see cref="T:System.Web.UI.IDReferencePropertyAttribute" /> attribute is applied.</summary>
        <value>A <see cref="T:System.Type" /> that represents the type of control allowed by the property to which the <see cref="T:System.Web.UI.IDReferencePropertyAttribute" /> is applied. The default is <see cref="T:System.Web.UI.Control" />.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>