Infragistics2.Win.UltraWinTabControl.v8.1
UltraTab Class
See Also  Members   Example 
Infragistics.Win.UltraWinTabControl Namespace : UltraTab Class

The object that represents a specific tab in an UltraTabControl or UltraTabStripControl. It exposes properties and methods relating to that specific tab.

Object Model




Syntax

Visual Basic (Declaration) 
Public Class UltraTab 
   Inherits KeyedSubObjectBase
   Implements IKeyedSubObjectIKeyedSubObjectEx, ITabItem 
C# 
public class UltraTab : KeyedSubObjectBase, IKeyedSubObjectIKeyedSubObjectEx, ITabItem  

Remarks

The tabs are maintained in their original order in the UltraTabsCollection.

The tabs are also maintained in their current display order in the VisibleTabsCollection.

The VisibleTabs collection contains all tabs, including tabs whose UltraTab.Visible property is false.

Note: The TabPage property returns the control that is used to parent child controls for this tab. In the case of an UltraTabStripControl the TabPage property always returns the control's UltraTabControlBase.SharedControlsPage.

Example

The following sample code illustrates how to add tabs.

Visual BasicCopy Code
    Imports Infragistics.Win
    Imports Infragistics.Win.UltraWinTabs
    Imports Infragistics.Win.UltraWinTabControl

    Private Sub button8_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles button8.Click

        ' Call BeginUpdate to prevent the display from
        ' refreshing as we add individual tabs.
        ' Note: This MUST be paired with a call to
        ' EndUpdate below.
        Me.ultraTabControl1.BeginUpdate()

        ' Specify that mnemonics will be supported. If so and
        ' there is an '&' in a tab's text, the following character
        ' will be treated as an accelerator (i.e. the tab will
        ' be activated when the user presses the 'Alt' key and
        ' that character).
        Me.ultraTabControl1.UseMnemonics = DefaultableBoolean.True

        Dim tabAdded As UltraTab
        Dim tabs As UltraTabsCollection = Me.ultraTabControl1.Tabs

        ' Add a tab to the Tabs collection
        tabAdded = tabs.Add("options", "&Options")

        ' Setting the FixedWidth property will cause
        ' this tab to be displayed that size regardless
        ' of what is required to display its image and
        ' text
        tabAdded.FixedWidth = 80 ' pixels

        ' Create a new control
        Dim tb As New TextBox()
        tb.Location = New Point(20, 20)
        tb.Size = New Size(80, 20)

        ' Add the control to the tab's tab page
        tabAdded.TabPage.Controls.Add(tb)

        ' Continue to add tabs
        tabAdded = tabs.Add("general", "&General")
        tabAdded = tabs.Add("advanced", "Ad&vanced")

        ' Select the 'options' tab by setting the SelectedTab
        ' property. This will raise the ActiveTabChanging,
        ' ActiveTabChanged, SelectedTabChanging and
        ' SelectedTabChanged events. It will also cause
        ' the 'options' tab TabPage to be made visible and
        ' the tab to scroll into view.
        Me.ultraTabControl1.SelectedTab = tabs("options")

        ' Activate the 'general' tab by setting the ActiveTab
        ' property. This will raise the ActiveTabChanging,
        ' and ActiveTabChanged events. It will also cause
        ' the tab to scroll into view but the only other
        ' visible change will be that a focus rect will
        ' be drawn around the tab if the control has focus.
        Me.ultraTabControl1.ActiveTab = tabs("general")

        ' Give the tab control focus
        Me.ultraTabControl1.Focus()

        ' Call EndUpdate to allow the display to refresh
        Me.ultraTabControl1.EndUpdate()

    End Sub

C#Copy Code
       using System.Diagnostics;
       
using Infragistics.Win;
       
using Infragistics.Win.UltraWinTabs;
       
using Infragistics.Win.UltraWinTabControl;

       
private void button8_Click(object sender, System.EventArgs e)
       {
           
// Call BeginUpdate to prevent the display from
           
// refreshing as we add individual tabs.
           
// Note: This MUST be paired with a call to
           
// EndUpdate below.
           
this.ultraTabControl1.BeginUpdate();
       
           
// Specify that mnemonics will be supported. If so and
           
// there is an '&' in a tab's text, the following character
           
// will be treated as an accelerator (i.e. the tab will
           
// be activated when the user presses the 'Alt' key and
           
// that character).
           
this.ultraTabControl1.UseMnemonics = DefaultableBoolean.True;

           UltraTab tabAdded;
           UltraTabsCollection tabs =
this.ultraTabControl1.Tabs;

           
// Add a tab to the Tabs collection
           
tabAdded = tabs.Add("options", "&Options");

           
// Setting the FixedWidth property will cause
           
// this tab to be displayed that size regardless
           
// of what is required to display its image and
           
// text
           
tabAdded.FixedWidth = 80; // pixels

           
// Create a new control
           
TextBox tb = new TextBox();
           tb.Location =
new Point(20,20);
           tb.Size =
new Size(80, 20);
           
           
// Add the control to the tab's tab page
           
tabAdded.TabPage.Controls.Add(tb );

           
// Continue to add tabs
           
tabAdded = tabs.Add("general", "&General");
           tabAdded = tabs.Add(
"advanced", "Ad&vanced");

           
// Select the 'options' tab by setting the SelectedTab
           
// property. This will raise the ActiveTabChanging,
           
// ActiveTabChanged, SelectedTabChanging and
           
// SelectedTabChanged events. It will also cause
           
// the 'options' tab TabPage to be made visible and
           
// the tab to scroll into view.
           
this.ultraTabControl1.SelectedTab = tabs["options"];

           
// Activate the 'general' tab by setting the ActiveTab
           
// property. This will raise the ActiveTabChanging,
           
// and ActiveTabChanged events. It will also cause
           
// the tab to scroll into view but the only other
           
// visible change will be that a focus rect will
           
// be drawn around the tab if the control has focus.
           
this.ultraTabControl1.ActiveTab = tabs["general"];

           
// Give the tab control focus
           
this.ultraTabControl1.Focus();

           
// Call EndUpdate to allow the display to refresh
           
this.ultraTabControl1.EndUpdate();

       }

See Also