HtmlForm.SubmitDisabledControls Property

Reference

Definition

Namespace:: System.Web.UI.HtmlControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a Boolean value indicating whether to force controls disabled on the client to submit their values, allowing them to preserve their values after the page posts back to the server.

public:
 virtual property bool SubmitDisabledControls { bool get(); void set(bool value); };

public virtual bool SubmitDisabledControls { get; set; }

member this.SubmitDisabledControls : bool with get, set

Public Overridable Property SubmitDisabledControls As Boolean

Property Value

Boolean

true if controls disabled on the client are forced to submit their values; otherwise, false. The default value is false.

Examples

The following code example demonstrates how to set the SubmitDisabledControls property on a form to true to cause controls disabled by client script to maintain their values after the page posts back to the server. In this example, if you set the SubmitDisabledControls property to false and then click the Post back button, the text in the HTML text box is lost and the HTML check box is no longer selected.

<%@ page language="C#"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void Page_Load(Object sender, EventArgs e)
  {
    
    // The first time the page loads, set the values
    // of the HtmlInputText and HtmlInputCheckBox controls.
    if (!IsPostBack)
    {
      InputText1.Value = "Test";
      InputCheckBox1.Checked = true;
    }
  }
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >

<head id="Head1" 
      runat="server">

    <title>HtmlForm SubmitDisabledControls Property Example</title>

</head>

<body>

  <form id="form1" 
        submitdisabledcontrols="true" 
        runat="server">
    
      <h3>HtmlForm SubmitDisabledControls Property Example</h3>
    
      <input id="InputText1" 
             name="InputText1" 
             type="text" 
             runat="server" />
    
      <input id="InputCheckBox1" 
             name="InputCheckBox1" 
             type="Checkbox" 
             runat="server" />
    
      <asp:button id="PostBackButton"
                  text="Post back"
                  runat="server" />

  </form>    
    
</body>

</html>

<script type="text/javascript">

    // Disable the HTML controls on the form.
    document.all('InputText1').disabled = true;
    document.all('InputCheckBox1').disabled = true;

</script>

<%@ page language="VB"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
    
    ' The first time the page loads, set the values
    ' of the HtmlInputText and HtmlInputCheckBox controls.
    If Not IsPostBack Then
      InputText1.Value = "Test"
      InputCheckBox1.Checked = True
    End If
    
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >

<head id="Head1" 
      runat="server">

    <title>HtmlForm SubmitDisabledControls Property Example</title>

</head>

<body>

  <form id="form1" 
        submitdisabledcontrols="true" 
        runat="server">
    
      <h3>HtmlForm SubmitDisabledControls Property Example</h3>
    
      <input id="InputText1" 
             name="InputText1" 
             type="text" 
             runat="server" />
    
      <input id="InputCheckBox1" 
             name="InputCheckBox1" 
             type="Checkbox" 
             runat="server" />
    
      <asp:button id="PostBackButton"
                  text="Post back"
                  runat="server" />

  </form>    
    
</body>

</html>

<script type="text/javascript">

    // Disable the HTML controls on the form.
    document.all('InputText1').disabled = true;
    document.all('InputCheckBox1').disabled = true;

</script>

Remarks

Use the SubmitDisabledControls property to specify whether to force controls disabled on the client to submit their values when the page posts back. This allows the disabled controls to preserve their values after the page posts back to the server. When the SubmitDisabledControls property is set to false, controls on the form that have been disabled using client script will not be submitted to the server the next time the page posts back. As a result, any values stored by the disabled controls are lost. To allow the disabled controls to preserve their values after the page posts back to the server, set the SubmitDisabledControls property to true.

Applies to

Share via