Click here to Skip to main content
15,891,529 members
Articles / Programming Languages / Visual Basic
Article

Control Arrays in VB.NET

Rate me:
Please Sign up or sign in to vote.
3.36/5 (33 votes)
10 Mar 20042 min read 282.7K   38   18
This article explains control arrays with example.

Control Arrays

Control Arrays are arrays of controls sharing a common event handler. That is, you need to write code for only one event, which can handle other controls' events.

For example if you consider an application like calculator, where on the click event of the buttons from 0 to 9, you want to append the text to the visible text. So when you write code for all individual buttons, it is a time consuming process. Because we need the same peace of code for all these buttons, we can create one event handler to handle the events raised by all these buttons.

In Visual Basic 6, this was fairly simple. You have to copy and paste the control and confirm ‘Yes’ when asked, whether to create a control array. You can see the first control automatically gets an index of zero and the following controls get the index incremented by one from the last control. And if you double click on the buttons, you can see all these controls have same event handler, however you can notice a new argument, which is passed to the click event, named Index. This index property is the one, which will tell you which button is clicked (If you want to know, which one clicked). To create this while runtime, you can copy one control at design time and use this button to create other buttons. You can load a control and remove a control dynamically in VB6.

In Dot net the creation of control arrays are easier than the previous versions and are not created by copying and pasting, instead simply add the control events to the Handles list. You can give any name to this procedure.

Example

VB.NET
Private Sub ClickButton(ByVal sender As System.Object, _
  ByVal e As System.EventArgs) Handles Button1.Click, _
  Button2.Click, Button3.Enter
        Dim btn As Button
        btn = CType(sender, Button)
        MsgBox(btn.Text)
End Sub 

In the above example ClickButton procedure is handling the click event of Button1 and Button2, whereas Enter event of the Button3. In order to check the control that is pressed, you need to convert the sender to the respective type. The CType function converts it into a button type, so that you can access the attributes of the event raised by the control.

Now let us see how to create a button in run time,

VB.NET
'Create the button
        Dim btn As New Button()
'Specify the 
location and the size
        btn.Location = New System.Drawing.Point(200, 30)
        btn.Size = New System.Drawing.Size(100, 20)
        btn.Text = "New Button"
'Add it to the forms control collection
               Me.Controls.Add(btn)
'Link the event to the event handler
        AddHandler btn.Click, AddressOf Me.ClickButton 

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Web Developer
United States United States
I'm ManojRajan, Working as a consultant architect in Tennessee. I have more than 8 years of experience in Microsoft Technologies.

Comments and Discussions

 
QuestionNeed Help for getting number of index of control arrays Pin
Glenn Maramis26-May-14 2:18
Glenn Maramis26-May-14 2:18 
GeneralArrays of controls in vb.net Pin
spvasekar1-Sep-12 3:33
spvasekar1-Sep-12 3:33 
GeneralWorking Example Pin
deliot17-Nov-10 6:57
deliot17-Nov-10 6:57 
GeneralControl Arrays in VB.NET Pin
Bill Ruf22-Jun-09 10:41
Bill Ruf22-Jun-09 10:41 
GeneralControl array in VB.NET Pin
manish_ahuja6-Apr-09 10:54
manish_ahuja6-Apr-09 10:54 
GeneralHi ManojRajan Pin
hugosanguino8-Aug-08 9:53
hugosanguino8-Aug-08 9:53 
GeneralControl Arrays in VB.NET by Relman Pin
Relman10-Nov-04 4:13
Relman10-Nov-04 4:13 
GeneralArticle is not complete Pin
Fade (Amit BS)24-Mar-04 7:40
Fade (Amit BS)24-Mar-04 7:40 
GeneralRe: Article is not complete Pin
ManojRajan24-Mar-04 17:37
ManojRajan24-Mar-04 17:37 
GeneralRe: Article is not complete Pin
Fade (Amit BS)14-Apr-04 5:43
Fade (Amit BS)14-Apr-04 5:43 
GeneralRe: Article is not complete Pin
ManojRajan14-Apr-04 18:51
ManojRajan14-Apr-04 18:51 
GeneralRe: Article is not complete Pin
Fade (Amit BS)17-Apr-04 14:56
Fade (Amit BS)17-Apr-04 14:56 
GeneralRe: Article is not complete Pin
Duane Flanders19-Aug-04 7:48
Duane Flanders19-Aug-04 7:48 
Fade (Amit BS) wrote:
Yes, you can use the name property if it's unique, and even if you want to create it in run time i believe that if you use some good naming conventions it will work, but it's not a good policy when creating many controls during run-time.

You must set the name property of the control at run-time when you are creating controls dynamically unless you are wanting to use the default name (why would any one want to do that) Confused | :confused:

Fade (Amit BS) wrote:
the tag property is used to determine the order which buttons recieve the focus when you click the 'TAB' key to switch to the next control, and it won't be wise to change it in run-time(i'm not even sure that you can) because they are all inter-connected to eachother - when you change one, they(the controls on the form) all re-adapt- might get messy

I don't think you understand what the tag property is used for. It is used for holding any other information that may be required by your program. The tab order property is used for controlling the tab order. Changing it only affects the order in which the controls are tabbed to and only gets messy if you set them to the wrong order.

I am wondering if you understand 'AddHandler'. This is how control arrays are done in .NET. when you add a handler to an existing subroutine it is the same as if you had a control array in vb6 or added the control to the handles in the subroutine declaration. Yes, while it is true that there is no index for you to know which button was clicked, this can be determined by the name property as shown in the 'ClickButton' method. Or, if you don't want to use the name property, you can set an index (by using the tag property)as you create the controls and use it to determine the button that was clicked and then write the correct text into the correct textbox.

Lets assume that we have 2 textboxes on a form and we add 2 buttons during run-time. We set the tag property to 1 for the first button and to 2 for the second button (I will leave the code for this to you to write). As we create the new buttons we also add a handler for each button's click event to point us to the following sub. Now when we click on a button all we need to do is check the tag property and use the select case to determine which button was clicked and put the text into the correct textbox. No subclassing of the buttons requiredBig Grin | :-D

<br />
Private Sub ClickButton(ByVal sender As System.Object, _<br />
  ByVal e As System.EventArgs) <br />
        Dim btn As Button<br />
        btn = CType(sender, Button)<br />
        Select Case btn.Tag<br />
           Case 1<br />
              Textbox1.Text="Clicked"<br />
              Textbox2.Text=""<br />
           Case 2<br />
              Textbox1.Text=""<br />
              Textbox2.Text="Clicked"<br />
        End Select<br />
End Sub <br />

GeneralRe: Article is not complete Pin
ManojRajan19-Aug-04 19:00
ManojRajan19-Aug-04 19:00 
RantRe: Article is not complete Pin
Neville Nazerane25-Jul-10 20:08
Neville Nazerane25-Jul-10 20:08 
GeneralRe: Article is not complete Pin
Anonymous20-Aug-04 1:01
Anonymous20-Aug-04 1:01 
GeneralRe: Article is not complete Pin
jaman4dbz19-May-06 12:06
jaman4dbz19-May-06 12:06 
GeneralRe: Article is not complete Pin
Craig P Williams Sr16-Mar-23 4:25
professionalCraig P Williams Sr16-Mar-23 4:25 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.