356 lines
19 KiB
XML
356 lines
19 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="PostBackOptions" FullName="System.Web.UI.PostBackOptions">
|
|
<TypeSignature Language="C#" Value="public sealed class PostBackOptions" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Web.UI.PostBackOptions" /> class allows controls to emit client-side script that initiates a postback event. The <see cref="T:System.Web.UI.PostBackOptions" /> class also provides a reference to the control that initiated the postback event through the <see cref="P:System.Web.UI.PostBackOptions.TargetControl" /> property. The postback event is created based on the options specified in the <see cref="T:System.Web.UI.PostBackOptions" /> object passed in to the <see cref="M:System.Web.UI.ClientScriptManager.GetPostBackEventReference(System.Web.UI.PostBackOptions)" /> method.</para>
|
|
<para>Normally, a postback to the server is initiated by elements such as a Submit button or an Image button. However, by emitting client-side JavaScript, different controls can initiate a postback event. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Specifies how client-side JavaScript is generated to initiate a postback event.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public PostBackOptions (System.Web.UI.Control targetControl);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="targetControl" Type="System.Web.UI.Control" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.PostBackOptions" /> class with the specified target control data.</para>
|
|
</summary>
|
|
<param name="targetControl">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> that receives the postback event.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public PostBackOptions (System.Web.UI.Control targetControl, string argument);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="targetControl" Type="System.Web.UI.Control" />
|
|
<Parameter Name="argument" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.PostBackOptions" /> class with the specified target control and argument data.</para>
|
|
</summary>
|
|
<param name="targetControl">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> that receives the postback event.</param>
|
|
<param name="argument">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The optional parameter passed during the postback event.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public PostBackOptions (System.Web.UI.Control targetControl, string argument, string actionUrl, bool autoPostBack, bool requiresJavaScriptProtocol, bool trackFocus, bool clientSubmit, bool performValidation, string validationGroup);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="targetControl" Type="System.Web.UI.Control" />
|
|
<Parameter Name="argument" Type="System.String" />
|
|
<Parameter Name="actionUrl" Type="System.String" />
|
|
<Parameter Name="autoPostBack" Type="System.Boolean" />
|
|
<Parameter Name="requiresJavaScriptProtocol" Type="System.Boolean" />
|
|
<Parameter Name="trackFocus" Type="System.Boolean" />
|
|
<Parameter Name="clientSubmit" Type="System.Boolean" />
|
|
<Parameter Name="performValidation" Type="System.Boolean" />
|
|
<Parameter Name="validationGroup" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.PostBackOptions" /> class with the specified values for the instance's properties.</para>
|
|
</summary>
|
|
<param name="targetControl">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.Control" /> that receives the postback event.</param>
|
|
<param name="argument">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The optional parameter passed during the postback event.</param>
|
|
<param name="actionUrl">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The target of the postback.</param>
|
|
<param name="autoPostBack">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true to automatically post the form back to the server in response to a user action; otherwise, false.</param>
|
|
<param name="requiresJavaScriptProtocol">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true if the javascript: prefix is required; otherwise, false.</param>
|
|
<param name="trackFocus">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true if the postback event should return the page to the current scroll position and return focus to the target control; otherwise, false.</param>
|
|
<param name="clientSubmit">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true if the postback event can be raised by client script; otherwise, false.</param>
|
|
<param name="performValidation">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true if client-side validation is required before the postback event occurs; otherwise, false.</param>
|
|
<param name="validationGroup">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The group of controls for which <see cref="T:System.Web.UI.PostBackOptions" /> causes validation when it posts back to the server.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ActionUrl">
|
|
<MemberSignature Language="C#" Value="public string ActionUrl { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.PostBackOptions.ActionUrl" /> property of the <see cref="T:System.Web.UI.PostBackOptions" /> class specifies the URL for the action attribute of a Web Forms page. The <see cref="P:System.Web.UI.PostBackOptions.ActionUrl" /> property can be used to specify which Web Forms page to post data back to, causing a cross-page post. For more information on cross-page posting, see <format type="text/html"><a href="fedf234e-b7c4-4644-a9e8-c1c0870b043b">Cross-Page Posting in an ASP.NET Web Page</a></format>. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the target URL for the postback of a Web Forms page.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Argument">
|
|
<MemberSignature Language="C#" Value="public string Argument { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.PostBackOptions.Argument" /> property specifies an optional argument that is transferred in a postback event. This property is used to represent the EVENTARGUMENT parameter of the _doPostBack method of the client-side JavaScript.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets an optional argument that is transferred in the postback event.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="AutoPostBack">
|
|
<MemberSignature Language="C#" Value="public bool AutoPostBack { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>You can use the <see cref="P:System.Web.UI.PostBackOptions.AutoPostBack" /> property to indicate that a Web Forms page should automatically post back to the server in response to a user action such as selecting an item from a drop-down list. The JavaScript setTimeout method is used with the _doPostBack method to ensure that the user action completes before the postback occurs.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that indicates whether the form will automatically post back to the server in response to a user action.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ClientSubmit">
|
|
<MemberSignature Language="C#" Value="public bool ClientSubmit { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.PostBackOptions.ClientSubmit" /> property indicates whether the postback event should occur from client-side script. If you set the <see cref="P:System.Web.UI.PostBackOptions.ClientSubmit" /> property to false, then no JavaScript is generated. You might assign false to the <see cref="P:System.Web.UI.PostBackOptions.ClientSubmit" /> property if you want to call the __doPostBack method yourself.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether the postback event should occur from client-side script.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="PerformValidation">
|
|
<MemberSignature Language="C#" Value="public bool PerformValidation { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.PostBackOptions.PerformValidation" /> property is used to specify whether client-side validation is required before the postback event can occur. When the value of the <see cref="P:System.Web.UI.PostBackOptions.PerformValidation" /> property is set to true, you can also use the <see cref="P:System.Web.UI.PostBackOptions.ValidationGroup" /> property to specify the name of the validation group for which validation is required before the postback event occurs.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether client-side validation is required before the postback event occurs.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RequiresJavaScriptProtocol">
|
|
<MemberSignature Language="C#" Value="public bool RequiresJavaScriptProtocol { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The javascript: prefix is needed with some HTML attributes such as the href attribute of the <a> tag to distinguish a JavaScript property from a URL. An attribute like onclick does not need the javascript: prefix because it is automatically associated with JavaScript.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether the javascript: prefix is generated for the client-side script. </para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="TargetControl">
|
|
<MemberSignature Language="C#" Value="public System.Web.UI.Control TargetControl { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.UI.Control</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.PostBackOptions.TargetControl" /> property returns a <see cref="T:System.Web.UI.Control" /> object that represents the control that receives the postback event. This property is passed as the EVENTTARGET parameter to the __doPostBack method of the client-side JavaScript.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the control target that receives the postback event.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="TrackFocus">
|
|
<MemberSignature Language="C#" Value="public bool TrackFocus { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.PostBackOptions.TrackFocus" /> property indicates whether the postback event should return the page to the current scroll position and return focus to the <see cref="P:System.Web.UI.PostBackOptions.TargetControl" /> control after the postback event has occurred.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether the postback event should return the page to the current scroll position and return focus to the current control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ValidationGroup">
|
|
<MemberSignature Language="C#" Value="public string ValidationGroup { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.PostBackOptions.ValidationGroup" /> property to specify the validation group to validate when a postback event is generated. Only the validation controls in the specified validation group are validated.</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.PostBackOptions" /> object causes validation when it posts back to the server. </para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |