Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
288 lines (257 sloc) 16.2 KB
<Type Name="DataBindingHandlerAttribute" FullName="System.Web.UI.DataBindingHandlerAttribute">
<TypeSignature Language="C#" Value="public sealed class DataBindingHandlerAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DataBindingHandlerAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.DataBindingHandlerAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class DataBindingHandlerAttribute&#xA;Inherits Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class DataBindingHandlerAttribute sealed : Attribute" />
<TypeSignature Language="F#" Value="type DataBindingHandlerAttribute = class&#xA; inherit Attribute" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.AttributeUsage(System.AttributeTargets.Class)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Specifies a design-time class that performs data binding of controls within a designer. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information about using attributes, see [Attributes](~/docs/standard/attributes/index.md).
## Examples
The following code example defines a data-binding handler, named `MyDataBindingHandler`, to be used by the designer in editing mode. On exiting the editing mode, the `Text` property value is displayed.
[!code-csharp[SystemWebUI_DataBindingHandlerAttribute#1](~/samples/snippets/csharp/VS_Snippets_WebNet/SystemWebUI_DataBindingHandlerAttribute/CS/databindinghandlerattribute.cs#1)]
[!code-vb[SystemWebUI_DataBindingHandlerAttribute#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/SystemWebUI_DataBindingHandlerAttribute/VB/databindinghandlerattribute.vb#1)]
]]></format>
</remarks>
<altmember cref="T:System.Attribute" />
</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.DataBindingHandlerAttribute" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataBindingHandlerAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.DataBindingHandlerAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; DataBindingHandlerAttribute();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<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.DataBindingHandlerAttribute" /> class using no parameters. This is the parameterless constructor.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example uses the <xref:System.Web.UI.DataBindingHandlerAttribute.%23ctor%2A> constructor.
[!code-csharp[DataBindingHandlerAttribute_Samp2#1](~/samples/snippets/csharp/VS_Snippets_WebNet/DataBindingHandlerAttribute_Samp2/CS/databindinghandlerattribute_samp2.cs#1)]
[!code-vb[DataBindingHandlerAttribute_Samp2#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/DataBindingHandlerAttribute_Samp2/VB/databindinghandlerattribute_samp2.vb#1)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataBindingHandlerAttribute (string typeName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string typeName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.DataBindingHandlerAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (typeName As String)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; DataBindingHandlerAttribute(System::String ^ typeName);" />
<MemberSignature Language="F#" Value="new System.Web.UI.DataBindingHandlerAttribute : string -&gt; System.Web.UI.DataBindingHandlerAttribute" Usage="new System.Web.UI.DataBindingHandlerAttribute typeName" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="typeName" Type="System.String" />
</Parameters>
<Docs>
<param name="typeName">The fully qualified name of the data-binding handler <see cref="T:System.Type" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> class with the specified type name.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The type name for this constructor is the fully qualified name of the type, including its assembly name.
## Examples
The following code example uses the <xref:System.Web.UI.DataBindingHandlerAttribute.%23ctor%2A> constructor to designate a custom <xref:System.Web.UI.Design.DataBindingHandler> class for the Web control.
[!code-csharp[DataBindingHandlerAttribute_Samp1#1](~/samples/snippets/csharp/VS_Snippets_WebNet/DataBindingHandlerAttribute_Samp1/CS/databindinghandlerattribute_samp1.cs#1)]
[!code-vb[DataBindingHandlerAttribute_Samp1#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/DataBindingHandlerAttribute_Samp1/VB/databindinghandlerattribute_samp1.vb#1)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataBindingHandlerAttribute (Type type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Type type) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.DataBindingHandlerAttribute.#ctor(System.Type)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; DataBindingHandlerAttribute(Type ^ type);" />
<MemberSignature Language="F#" Value="new System.Web.UI.DataBindingHandlerAttribute : Type -&gt; System.Web.UI.DataBindingHandlerAttribute" Usage="new System.Web.UI.DataBindingHandlerAttribute type" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<param name="type">The <see cref="T:System.Type" /> for the data-binding handler.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> class of the specified <see cref="T:System.Type" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The syntax for this attribute is:
```
[DataBindingHandlerAttribute
(typeof(dataBindingHandlerType))]
```
## Examples
The following code example defines a data-binding handler, named `MyDataBindingHandler`, to be used by the designer in editing mode. On exiting the editing mode, the `Text` property value is displayed.
[!code-csharp[SystemWebUI_DataBindingHandlerAttribute#1](~/samples/snippets/csharp/VS_Snippets_WebNet/SystemWebUI_DataBindingHandlerAttribute/CS/databindinghandlerattribute.cs#1)]
[!code-vb[SystemWebUI_DataBindingHandlerAttribute#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/SystemWebUI_DataBindingHandlerAttribute/VB/databindinghandlerattribute.vb#1)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="public static readonly System.Web.UI.DataBindingHandlerAttribute Default;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Web.UI.DataBindingHandlerAttribute Default" />
<MemberSignature Language="DocId" Value="F:System.Web.UI.DataBindingHandlerAttribute.Default" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Default As DataBindingHandlerAttribute " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Web::UI::DataBindingHandlerAttribute ^ Default;" />
<MemberSignature Language="F#" Value=" staticval mutable Default : System.Web.UI.DataBindingHandlerAttribute" Usage="System.Web.UI.DataBindingHandlerAttribute.Default" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.DataBindingHandlerAttribute</ReturnType>
</ReturnValue>
<Docs>
<summary>Defines the default attribute for the <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This is the default attribute used when the attribute is not specified. This field is read-only.
## Examples
The following code example creates an instance of the <xref:System.Web.UI.DataBindingHandlerAttribute> class that is set to <xref:System.Web.UI.DataBindingHandlerAttribute.Default>.
[!code-csharp[DataBindingHandlerAttribute_Default#1](~/samples/snippets/csharp/VS_Snippets_WebNet/DataBindingHandlerAttribute_Default/CS/databindinghandlerattribute_default.cs#1)]
[!code-vb[DataBindingHandlerAttribute_Default#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/DataBindingHandlerAttribute_Default/VB/databindinghandlerattribute_default.vb#1)]
]]></format>
</remarks>
</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.DataBindingHandlerAttribute.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override bool Equals(System::Object ^ obj);" />
<MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="dataBindingHandlerAttribute.Equals 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" Index="0" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
</Parameters>
<Docs>
<param name="obj">The object to compare to the current <see cref="T:System.Web.UI.DataBindingHandlerAttribute" />.</param>
<summary>Determines whether two object instances are equal.</summary>
<returns>
<see langword="true" /> if the <paramref name="obj" /> parameter equals the <see cref="T:System.Web.UI.DataBindingHandlerAttribute" /> object; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</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.DataBindingHandlerAttribute.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override int GetHashCode();" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="dataBindingHandlerAttribute.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>
</Docs>
</Member>
<Member MemberName="HandlerTypeName">
<MemberSignature Language="C#" Value="public string HandlerTypeName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HandlerTypeName" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.DataBindingHandlerAttribute.HandlerTypeName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HandlerTypeName As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ HandlerTypeName { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.HandlerTypeName : string" Usage="System.Web.UI.DataBindingHandlerAttribute.HandlerTypeName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the type name of the data-binding handler.</summary>
<value>The type name of the handler. If the type name is <see langword="null" />, this property returns an empty string ("").</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example retrieves the <xref:System.Web.UI.DataBindingHandlerAttribute.HandlerTypeName%2A> property from an instance of the <xref:System.Web.UI.DataBindingHandlerAttribute> class.
[!code-csharp[DataBindingHandlerAttribute_HandlerTypeName#1](~/samples/snippets/csharp/VS_Snippets_WebNet/DataBindingHandlerAttribute_HandlerTypeName/CS/databindinghandlerattribute_handlertypename.cs#1)]
[!code-vb[DataBindingHandlerAttribute_HandlerTypeName#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/DataBindingHandlerAttribute_HandlerTypeName/VB/databindinghandlerattribute_handlertypename.vb#1)]
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.