Page.FindControl Method (String)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Searches the page naming container for a server control with the specified identifier.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

Public Overrides Function FindControl (
	id As String
) As Control


Type: System.String

The identifier for the control to be found.

Return Value

Type: System.Web.UI.Control

The specified control, or null if the specified control does not exist.

The FindControl method can be used to access a control whose ID is not available at design time. The method searches only the page's immediate, or top-level, container; it does not recursively search for controls in naming containers contained on the page. To access controls in a subordinate naming container, call the FindControl method of that container.

The following code example demonstrates how to use the FindControl method to locate controls inside templates. In this example, two Repeater controls are defined; each shows a different way to catch the Click event of a LinkButton inside the repeater item template.

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "">

<script runat="server">

  Private Class RepeaterObject

    Private _string As String

    Public Sub New(ByVal label As String)
      _string = label
    End Sub

    Public Property RepeaterLabel() As String
        Return _string
      End Get
      Set(ByVal value As String)
        _string = value
      End Set
    End Property

  End Class

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)

    If (Not IsPostBack) Then

      Dim al As New ArrayList()
      al.Add(New RepeaterObject("RepeaterObject1"))
      al.Add(New RepeaterObject("RepeaterObject2"))
      al.Add(New RepeaterObject("RepeaterObject3"))
      Repeater1.DataSource = al
      Repeater2.DataSource = al
    End If

  End Sub

  ' This occurs for Repeater1 and originates from LinkButton onClick.
  Protected Sub OnMyCommand1(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.CommandEventArgs)
    Dim b As LinkButton = sender
    If Not (b Is Nothing) Then
      Dim c As Label = CType(b.Parent.FindControl("Label1"), Label)
      If Not (c Is Nothing) Then
        c.Text = "text changed in handler"
        c.ForeColor = System.Drawing.Color.Green
      End If
    End If

  End Sub

  ' This occurs for Repeater2 and comes from the Repeater onItemCommand.
  Protected Sub OnMyCommand2(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.RepeaterCommandEventArgs)
    Dim l As Label = CType(e.Item.FindControl("Label1"), Label)
    If Not (l Is Nothing) Then
      l.Text = "text changed in handler"
      l.ForeColor = System.Drawing.Color.Red
    End If
  End Sub


<html xmlns="" >
<head runat="server">
    <title>Page FindControl Example</title>
    <form id="form1" runat="server">

    <asp:Panel ID="Panel1" runat="server" >
        This repeater sample shows the bubbled event and FindControl when the repeater item OnCommand event occurs.<br />
        <asp:Repeater ID="Repeater1" runat="server">
                <asp:Label runat="server" ID="Label1" Text='<%#Eval("RepeaterLabel")%>' />&nbsp;
                <asp:LinkButton ID="LinkButton1" Text="Change" runat="server" OnCommand="OnMyCommand1" /> <br />
        <hr />

        This repeater shows the bubbled event and FindControl when the repeater OnItemCommand event occurs. <br />
        <asp:Repeater ID="Repeater2" runat="server" OnItemCommand="OnMyCommand2">
                <asp:Label runat="server" ID="Label1" Text='<%#Eval("RepeaterLabel")%>' />&nbsp;
                <asp:LinkButton ID="LinkButton2" Text="Change" runat="server" /> <br />


.NET Framework
Available since 2.0
Return to top