304 lines
19 KiB
XML
304 lines
19 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="HtmlButton" FullName="System.Web.UI.HtmlControls.HtmlButton">
|
|
<TypeSignature Language="C#" Maintainer="auto" Value="public class HtmlButton : System.Web.UI.HtmlControls.HtmlContainerControl, System.Web.UI.IPostBackEventHandler" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
|
<Base>
|
|
<BaseTypeName>System.Web.UI.HtmlControls.HtmlContainerControl</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.Web.UI.IPostBackEventHandler</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Web.UI.SupportsEventValidation</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultEvent("ServerClick")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <button> element allows Web developers to create user interface (UI) form buttons that can be composed of embedded HTML elements, including other server controls.</para>
|
|
<block subset="none" type="note">
|
|
<para>The <button> element is defined in the HTML 4.0 specification and is supported only in Microsoft Internet Explorer version 4.0 and later. To create UI form buttons for use in other browsers, consider using the <see cref="T:System.Web.UI.HtmlControls.HtmlInputImage" /> class.</para>
|
|
</block>
|
|
<para>To perform a set of custom instructions when the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control is clicked, provide a custom event handler for the <see cref="E:System.Web.UI.HtmlControls.HtmlButton.ServerClick" /> event.</para>
|
|
<block subset="none" type="note">
|
|
<para>The <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control renders ECMAScript to the client browser. The client browser must have ECMAScript enabled for this control to function properly. For more information on client script, see <format type="text/html"><a href="13edb6b9-2dea-43c6-b8c1-a47207de19aa">Client Script in ASP.NET Web Pages</a></format>. </para>
|
|
</block>
|
|
<para>For a list of initial property values for an instance of <see cref="T:System.Web.UI.HtmlControls.HtmlButton" />, see the <see cref="M:System.Web.UI.HtmlControls.HtmlButton.#ctor" /> constructor.</para>
|
|
<block subset="none" type="note">
|
|
<para>This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. ASP.NET provides an input request validation feature to block script and HTML in user input. Validation server controls are also provided to assess user input. For more information, see <format type="text/html"><a href="96D2C59E-693C-4079-9B53-B3FF0D9E9133">Validation Server Controls</a></format>.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Allows programmatic access to the HTML <button> tag on the server.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public HtmlButton ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control.</para>
|
|
<para>The following table shows the initial property value for an instance of <see cref="T:System.Web.UI.HtmlControls.HtmlButton" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Property </para>
|
|
</term>
|
|
<description>
|
|
<para>Initial value </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.HtmlControls.HtmlControl.TagName" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>The "button" literal string. </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CausesValidation">
|
|
<MemberSignature Language="C#" Value="public virtual bool CausesValidation { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'bool'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>By default, page validation is performed when an <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control is clicked. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control.</para>
|
|
<para>You can specify or determine whether validation is performed on both the client and the server when an <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control is clicked by using the <see cref="P:System.Web.UI.HtmlControls.HtmlButton.CausesValidation" /> property. To prevent validation from being performed, set the <see cref="P:System.Web.UI.HtmlControls.HtmlButton.CausesValidation" /> property to false.</para>
|
|
<para>This property is commonly used in the event handler for the <see cref="E:System.Web.UI.HtmlControls.HtmlButton.ServerClick" /> event to prevent page validation from occurring when a Cancel or Reset button is clicked.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether validation is performed when the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control is clicked.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="OnPreRender">
|
|
<MemberSignature Language="C#" Value="protected override void OnPreRender (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlButton.OnPreRender(System.EventArgs)" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Web.UI.Control.PreRender" /> event and registers client script for generating a postback.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains event data.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnServerClick">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnServerClick (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="E:System.Web.UI.HtmlControls.HtmlButton.ServerClick" /> event is raised when the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control is clicked. This event causes a round trip to occur from the client to the server and back. It is deliberately different from the client-side OnClick event. If a conflict exists between code run with a <see cref="E:System.Web.UI.HtmlControls.HtmlButton.ServerClick" /> event and code run by a client-side OnClick event, the server-side event instructions will override the client-side code.</para>
|
|
<para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="F2ADAF01-1ED1-42E1-8C31-8D467E7E0EE2">Raising an Event</a></format>.</para>
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlButton.OnServerClick(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Web.UI.HtmlControls.HtmlButton.ServerClick" /> event. This allows you to provide a custom handler for the event.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RaisePostBackEvent">
|
|
<MemberSignature Language="C#" Value="protected virtual void RaisePostBackEvent (string eventArgument);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="eventArgument" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlButton.RaisePostBackEvent(System.String)" /> method is used by the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control, when it is clicked, to raise a <see cref="E:System.Web.UI.HtmlControls.HtmlButton.ServerClick" /> event. </para>
|
|
<para>If the <see cref="P:System.Web.UI.HtmlControls.HtmlButton.CausesValidation" /> property is true, the <see cref="M:System.Web.UI.Page.Validate(System.String)" /> method is called using the group of controls specified in the <see cref="P:System.Web.UI.HtmlControls.HtmlButton.ValidationGroup" /> property.</para>
|
|
<para>This method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises events for the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control when it posts back to the server. </para>
|
|
</summary>
|
|
<param name="eventArgument">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The argument for the event.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RenderAttributes">
|
|
<MemberSignature Language="C#" Value="protected override void RenderAttributes (System.Web.UI.HtmlTextWriter writer);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlButton.RenderAttributes(System.Web.UI.HtmlTextWriter)" /> method writes the onclick attribute of the rendered <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control, and then calls the base <see cref="M:System.Web.UI.HtmlControls.HtmlControl.RenderAttributes(System.Web.UI.HtmlTextWriter)" /> method.</para>
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlButton.RenderAttributes(System.Web.UI.HtmlTextWriter)" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Renders the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control's attributes to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object.</para>
|
|
</summary>
|
|
<param name="writer">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> that contains the output stream to render on the client.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ServerClick">
|
|
<MemberSignature Language="C#" Value="public event EventHandler ServerClick;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="E:System.Web.UI.HtmlControls.HtmlButton.ServerClick" /> event is raised when the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control is clicked. This server event causes a round trip to occur from the client to the server and back. It is deliberately different from the client-side OnClick event. If a conflict exists between code run with a <see cref="E:System.Web.UI.HtmlControls.HtmlButton.ServerClick" /> event and code run by a client-side OnClick event, the server-side event instructions will override the client-side code.</para>
|
|
<para>For more information about handling events, see <format type="text/html"><a href="01E4F1BC-E55E-413F-98C7-6588493E5F67">Consuming Events</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs when the user clicks an <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control on the client Web page.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="System.Web.UI.IPostBackEventHandler.RaisePostBackEvent">
|
|
<MemberSignature Language="C#" Value="void IPostBackEventHandler.RaisePostBackEvent (string eventArgument);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="eventArgument" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises events for the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control when it posts back to the server.</para>
|
|
</summary>
|
|
<param name="eventArgument">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The event arguments.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ValidationGroup">
|
|
<MemberSignature Language="C#" Value="public virtual string ValidationGroup { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Validation groups allow you to assign validation controls on a page to a specific category. Each validation group can be validated independently from other validation groups on the page. Use the <see cref="P:System.Web.UI.HtmlControls.HtmlButton.ValidationGroup" /> property to specify the name of the validation group for which the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control causes validation when it posts back to the server. </para>
|
|
<para>This property has an effect only when the value of the <see cref="P:System.Web.UI.HtmlControls.HtmlButton.CausesValidation" /> property is set to true. When you specify a value for the <see cref="P:System.Web.UI.HtmlControls.HtmlButton.ValidationGroup" /> property, only the validation controls that are part of the specified group are validated when the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> control posts back to the server. If you do not specify a value for this property and the <see cref="P:System.Web.UI.HtmlControls.HtmlButton.CausesValidation" /> property is set to true, all validation controls on the page that are not assigned to a validation group are validated when the control posts back to the server.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the group of controls for which the <see cref="T:System.Web.UI.HtmlControls.HtmlButton" /> causes validation when it posts back to the server.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |