Edit

Share via

ControlAdapter.OnInit(EventArgs) Method

  • Reference

Definition

Namespace:
System.Web.UI.Adapters
Assembly:
System.Web.dll

Overrides the OnInit(EventArgs) method for the associated control.

protected public:
 virtual void OnInit(EventArgs ^ e);
protected internal virtual void OnInit (EventArgs e);
abstract member OnInit : EventArgs -> unit
override this.OnInit : EventArgs -> unit
Protected Friend Overridable Sub OnInit (e As EventArgs)

Parameters

e
EventArgs

An EventArgs that contains the event data.

Examples

The following code sample derives a custom control adapter from the ControlAdapter class. It then overrides the OnInit method to set a property on the associated control and call the base method to complete the control initialization.

#using <System.Web.dll>
#using <System.dll>

using namespace System;
using namespace System::Web::UI;
using namespace System::Web::UI::Adapters;

public ref class CustomControlAdapter: public ControlAdapter
{
   // Override the ControlAdapter default OnInit implementation.
protected:
   virtual void OnInit( EventArgs^ e ) override
   {
      // Make the control invisible.
      Control->Visible = false;
      
      // Call the base method, which calls OnInit of the control,
      // which raises the control Init event.
      ControlAdapter::OnInit( e );
   }
};

using System;
using System.Web.UI;
using System.Web.UI.Adapters;

public class CustomControlAdapter : ControlAdapter
{
    // Override the ControlAdapter default OnInit implementation.
    protected override void OnInit (EventArgs e)
    {
        // Make the control invisible.
        Control.Visible = false;

        // Call the base method, which calls OnInit of the control,
        // which raises the control Init event.
        base.OnInit(e);
    }
}

Imports System.Web.UI
Imports System.Web.UI.Adapters

Public Class CustomControlAdapter
    Inherits ControlAdapter

    ' Override the ControlAdapter default OnInit implementation.
    Protected Overrides Sub OnInit(ByVal e As EventArgs)

        ' Make the control invisible.
        Control.Visible = False

        ' Call the base method, which calls OnInit of the control, 
        ' which raises the control Init event.
        MyBase.OnInit(e)

    End Sub
End Class

Remarks

If there is an adapter attached to a Control object and the OnInit method is overridden, the override method is called instead of the Control.OnInit method.

Override OnInit to perform target-specific processing in the Initialize stage of the control lifecycle. Typically, these are functions that are performed when a control is created.

Notes to Inheritors

When you inherit from the ControlAdapter class and the adapter overrides the OnInit(EventArgs) method, the adapter must call the corresponding base class method, which in turn calls the OnInit(EventArgs) method. If the OnInit(EventArgs) method is not called, the Init event will not be raised.

Applies to

See also