CheckBoxList.OnPreRender(EventArgs) CheckBoxList.OnPreRender(EventArgs) CheckBoxList.OnPreRender(EventArgs) CheckBoxList.OnPreRender(EventArgs) Method

Definition

Configures the CheckBoxList control prior to rendering on the client.

protected public:
 override void OnPreRender(EventArgs ^ e);
protected internal override void OnPreRender (EventArgs e);
override this.OnPreRender : EventArgs -> unit
Protected Friend Overrides Sub OnPreRender (e As EventArgs)

Parameters

e
EventArgs EventArgs EventArgs EventArgs

An EventArgs that contains the event data.

Examples

The following code example demonstrates how to override the CreateControlStyle method in a custom server control so that it always returns a new instance of the TableStyle class for the CheckBoxList.

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS.Controls" Assembly="Samples.AspNet.CS" %>
<%@ Page language="c#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>Custom CheckBoxList - OnPreRender - C# Example</title>
  </head>
  <body>
    <form id="Form1" method="post" runat="server">
      <h3>Custom CheckBoxList - OnPreRender - C# Example</h3>

      <aspSample:CustomCheckBoxListOnPreRender
        id="CheckBoxList1" runat="server">
        <asp:ListItem Selected="True">Item 1</asp:ListItem>
        <asp:ListItem>Item 2</asp:ListItem>
        <asp:ListItem>Item 3</asp:ListItem>
        <asp:ListItem>Item 4</asp:ListItem>
        <asp:ListItem>Item 5</asp:ListItem>
        <asp:ListItem>Item 6</asp:ListItem>
      </aspSample:CustomCheckBoxListOnPreRender>

    </form>
  </body>
</html>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.VB.Controls" Assembly="Samples.AspNet.VB" %>
<%@ Page language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>Custom CheckBoxList - OnPreRender - VB.NET Example</title>
  </head>
  <body>
    <form id="Form1" method="post" runat="server">
      <h3>Custom CheckBoxList - OnPreRender - VB.NET Example</h3>
      <aspSample:CustomCheckBoxListOnPreRender id="CheckBoxList" runat="server"
       RepeatLayout="Table" RepeatColumns="2" CellSpacing="3" CellPadding="3">
                <asp:ListItem  Selected="True">Item 1</asp:ListItem>
                <asp:ListItem>Item 2</asp:ListItem>
                <asp:ListItem>Item 3</asp:ListItem>
                <asp:ListItem>Item 4</asp:ListItem>
                <asp:ListItem>Item 5</asp:ListItem>
                <asp:ListItem>Item 6</asp:ListItem>
            </aspSample:CustomCheckBoxListOnPreRender>
    </form>
  </body>
</html>
using System;
using System.Web;
using System.Web.UI.WebControls;
using System.Security.Permissions;

namespace Samples.AspNet.CS.Controls
{
    [AspNetHostingPermission(SecurityAction.Demand, 
        Level = AspNetHostingPermissionLevel.Minimal)]
    public class CustomCheckBoxListOnPreRender : CheckBoxList
    {
        protected override void OnPreRender(EventArgs e)
        {
            // Run the OnPreRender method on the base class.
            base.OnPreRender(e);

            // Display the Calendar with a 3 point border.
            this.BorderWidth =  Unit.Point(3);
        }
    }
}
Imports System
Imports System.Web
IMports System.Web.UI.WebControls
Imports System.Security.Permissions

Namespace Samples.AspNet.VB.Controls
    <AspNetHostingPermission(SecurityAction.Demand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    Public Class CustomCheckBoxListOnPreRender
        Inherits System.Web.UI.WebControls.CheckBoxList

        Protected Overrides Sub OnPreRender(ByVal e As EventArgs)

            ' Run the OnPreRender method on the base class.
            MyBase.OnPreRender(e)

            ' Display the CheckBoxList with a 3 point border.
            Me.BorderWidth = Unit.Point(3)
        End Sub
    End Class
End Namespace

Remarks

The OnPreRender method is used primarily by control developers in custom controls that derive from the CheckBoxList class. The OnPreRender method allows derived classes to handle the PreRender event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

The OnPreRender method performs any necessary prerendering steps prior to saving view state and rendering content for the CheckBoxList. The individual list items contained in the CheckBoxList control are initialized for rendering using the current AutoPostBack, CausesValidation, and ValidationGroup values.

Notes to Inheritors

When overriding OnPreRender(EventArgs) in a derived class, be sure to call the base class's OnPreRender(EventArgs) method so that registered delegates receive the event.

Applies to

See also