Code:
/ Dotnetfx_Win7_3.5.1 / Dotnetfx_Win7_3.5.1 / 3.5.1 / DEVDIV / depot / DevDiv / releases / whidbey / NetFXspW7 / ndp / fx / src / WinForms / Managed / System / WinForms / TabControl.cs / 1 / TabControl.cs
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
/*
*/
namespace System.Windows.Forms {
using System;
using System.Collections;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Configuration.Assemblies;
using Microsoft.Win32;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Drawing;
using System.Drawing.Design;
using System.Runtime.InteropServices;
using System.Runtime.Remoting;
using System.Runtime.Serialization.Formatters;
using System.Security;
using System.Security.Permissions;
using System.Windows.Forms.Layout;
using System.Globalization;
///
/// The TabControl. This control has a lot of the functionality of a TabStrip
/// but manages a list of TabPages which are the 'pages' that appear on each tab.
///
[
ComVisible(true),
ClassInterface(ClassInterfaceType.AutoDispatch),
DefaultProperty("TabPages"),
DefaultEvent("SelectedIndexChanged"),
Designer("System.Windows.Forms.Design.TabControlDesigner, " + AssemblyRef.SystemDesign),
SRDescription(SR.DescriptionTabControl)
]
public class TabControl : Control {
private static readonly Size DEFAULT_ITEMSIZE = Size.Empty;
private static readonly Point DEFAULT_PADDING = new Point(6, 3);
//properties
private TabPageCollection tabCollection;
private TabAlignment alignment = TabAlignment.Top;
private TabDrawMode drawMode = TabDrawMode.Normal;
private ImageList imageList = null;
private Size itemSize = DEFAULT_ITEMSIZE;
private Point padding = DEFAULT_PADDING;
private TabSizeMode sizeMode = TabSizeMode.Normal;
private TabAppearance appearance = TabAppearance.Normal;
private Rectangle cachedDisplayRect = Rectangle.Empty;
private bool currentlyScaling = false;
private int selectedIndex = -1;
private Size cachedSize = Size.Empty;
private string controlTipText = String.Empty;
private bool handleInTable;
//events
private EventHandler onSelectedIndexChanged;
private DrawItemEventHandler onDrawItem;
//events
private static readonly object EVENT_DESELECTING = new object();
private static readonly object EVENT_DESELECTED = new object();
private static readonly object EVENT_SELECTING = new object();
private static readonly object EVENT_SELECTED = new object();
private static readonly object EVENT_RIGHTTOLEFTLAYOUTCHANGED = new object();
private const int TABCONTROLSTATE_hotTrack = 0x00000001;
private const int TABCONTROLSTATE_multiline = 0x00000002;
private const int TABCONTROLSTATE_showToolTips = 0x00000004;
private const int TABCONTROLSTATE_getTabRectfromItemSize = 0x00000008;
private const int TABCONTROLSTATE_fromCreateHandles = 0x00000010;
private const int TABCONTROLSTATE_UISelection = 0x00000020;
private const int TABCONTROLSTATE_selectFirstControl = 0x00000040;
private const int TABCONTROLSTATE_insertingItem = 0x00000080;
private const int TABCONTROLSTATE_autoSize = 0x00000100;
// PERF: take all the bools and put them into a state variable
private System.Collections.Specialized.BitVector32 tabControlState; // see TABCONTROLSTATE_ consts above
///
/// This message is posted by the control to itself after a TabPage is
/// added to it. On certain occasions, after items are added to a
/// TabControl in quick succession, TCM_ADJUSTRECT calls return the wrong
/// display rectangle. When the message is received, the control calls
/// updateTabSelection() to layout the TabPages correctly.
///
///
/// Constructs a TabBase object, usually as the base class for a TabStrip or TabControl.
///
public TabControl()
: base() {
tabControlState = new System.Collections.Specialized.BitVector32(0x00000000);
tabCollection = new TabPageCollection(this);
SetStyle(ControlStyles.UserPaint, false);
}
///
/// Returns on what area of the control the tabs reside on (A TabAlignment value).
/// The possibilities are Top (the default), Bottom, Left, and Right. When alignment
/// is left or right, the Multiline property is ignored and Multiline is implicitly on.
/// If the alignment is anything other than top, TabAppearance.FlatButtons degenerates
/// to TabAppearance.Buttons.
///
[
SRCategory(SR.CatBehavior),
Localizable(true),
DefaultValue(TabAlignment.Top),
RefreshProperties(RefreshProperties.All),
SRDescription(SR.TabBaseAlignmentDescr)
]
public TabAlignment Alignment {
get {
return alignment;
}
set {
if (this.alignment != value) {
//valid values are 0x0 to 0x3
if (!ClientUtils.IsEnumValid(value, (int)value, (int)TabAlignment.Top, (int)TabAlignment.Right)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(TabAlignment));
}
this.alignment = value;
if (this.alignment == TabAlignment.Left || this.alignment == TabAlignment.Right)
Multiline = true;
RecreateHandle();
}
}
}
///
/// Indicates whether the tabs in the tabstrip look like regular tabs, or if they look
/// like buttons as seen in the Windows 95 taskbar.
/// If the alignment is anything other than top, TabAppearance.FlatButtons degenerates
/// to TabAppearance.Buttons.
///
[
SRCategory(SR.CatBehavior),
Localizable(true),
DefaultValue(TabAppearance.Normal),
SRDescription(SR.TabBaseAppearanceDescr)
]
public TabAppearance Appearance {
get {
if (appearance == TabAppearance.FlatButtons && alignment != TabAlignment.Top) {
return TabAppearance.Buttons;
}
else {
return appearance;
}
}
set {
if (this.appearance != value) {
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)TabAppearance.Normal, (int)TabAppearance.FlatButtons)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(TabAppearance));
}
this.appearance = value;
RecreateHandle();
//Fire OnStyleChanged(EventArgs.Empty) here since we are no longer calling UpdateStyles( ) but always reCreating the Handle.
OnStyleChanged(EventArgs.Empty);
}
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
public override Color BackColor {
get {
//The tab control can only be rendered in 1 color: System's Control color.
//So, always return this value... otherwise, we're inheriting the forms backcolor
//and passing it on to the pab pages.
return SystemColors.Control;
}
set {
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
public override Image BackgroundImage {
get {
return base.BackgroundImage;
}
set {
base.BackgroundImage = value;
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
public override ImageLayout BackgroundImageLayout {
get {
return base.BackgroundImageLayout;
}
set {
base.BackgroundImageLayout = value;
}
}
///
/// Deriving classes can override this to configure a default size for their control.
/// This is more efficient than setting the size in the control's constructor.
///
protected override Size DefaultSize {
get {
return new Size(200, 100);
}
}
///
/// This property is overridden and hidden from statement completion
/// on controls that are based on Win32 Native Controls.
///
[EditorBrowsable(EditorBrowsableState.Never)]
protected override bool DoubleBuffered {
get {
return base.DoubleBuffered;
}
set {
base.DoubleBuffered = value;
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
public override Color ForeColor {
get {
return base.ForeColor;
}
set {
base.ForeColor = value;
}
}
///
/// Returns the parameters needed to create the handle. Inheriting classes
/// can override this to provide extra functionality. They should not,
/// however, forget to call base.getCreateParams() first to get the struct
/// filled up with the basic info.
///
///
/// The rectangle that represents the Area of the tab strip not
/// taken up by the tabs, borders, or anything else owned by the Tab. This
/// is typically the rectangle you want to use to place the individual
/// children of the tab strip.
///
public override Rectangle DisplayRectangle {
get {
// Null out cachedDisplayRect whenever we do anything to change it...
//
if (!cachedDisplayRect.IsEmpty)
return cachedDisplayRect;
Rectangle bounds = Bounds;
NativeMethods.RECT rect = NativeMethods.RECT.FromXYWH(bounds.X, bounds.Y, bounds.Width, bounds.Height);
// We force a handle creation here, because otherwise the DisplayRectangle will be wildly inaccurate
//
if (!IsDisposed)
{
// Since this is called thru the OnResize (and Layout) which is triggered by SetExtent if the TabControl is hosted as
// a ActiveX control, so check if this is ActiveX and dont force Handle Creation here as the native code breaks in this case.
// please Refer to VsWhidbey :: 288940
if (!IsActiveX)
{
if (!IsHandleCreated) {
CreateHandle();
}
}
if (IsHandleCreated)
{
SendMessage(NativeMethods.TCM_ADJUSTRECT, 0, ref rect);
}
}
Rectangle r = Rectangle.FromLTRB(rect.left, rect.top, rect.right, rect.bottom);
Point p = this.Location;
r.X -= p.X;
r.Y -= p.Y;
cachedDisplayRect = r;
return r;
}
}
///
/// The drawing mode of the tabs in the tab strip. This will indicate
///
[
SRCategory(SR.CatBehavior),
DefaultValue(TabDrawMode.Normal),
SRDescription(SR.TabBaseDrawModeDescr)
]
public TabDrawMode DrawMode {
get {
return drawMode;
}
set {
//valid values are 0x0 to 0x1
if (!ClientUtils.IsEnumValid(value, (int)value, (int)TabDrawMode.Normal, (int)TabDrawMode.OwnerDrawFixed)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(TabDrawMode));
}
if (drawMode != value) {
drawMode = value;
RecreateHandle();
}
}
}
///
/// Indicates whether the tabs visually change when the mouse passes over them.
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
SRDescription(SR.TabBaseHotTrackDescr)
]
public bool HotTrack {
get {
return tabControlState[TABCONTROLSTATE_hotTrack];
}
set {
if (HotTrack != value) {
tabControlState[TABCONTROLSTATE_hotTrack] = value;
if (IsHandleCreated) {
RecreateHandle();
}
}
}
}
///
/// Returns the imageList the control points at. This is where tabs that have imageIndex
/// set will get there images from.
///
[
SRCategory(SR.CatAppearance),
RefreshProperties(RefreshProperties.Repaint),
DefaultValue(null),
SRDescription(SR.TabBaseImageListDescr)
]
public ImageList ImageList {
get {
return imageList;
}
set {
if (this.imageList != value) {
EventHandler recreateHandler = new EventHandler(ImageListRecreateHandle);
EventHandler disposedHandler = new EventHandler(DetachImageList);
if (imageList != null) {
imageList.RecreateHandle -= recreateHandler;
imageList.Disposed -= disposedHandler;
}
this.imageList = value;
IntPtr handle = (value != null) ? value.Handle : IntPtr.Zero;
if (IsHandleCreated)
SendMessage(NativeMethods.TCM_SETIMAGELIST, IntPtr.Zero, handle);
// Update the image list in the tab pages.
foreach (TabPage tabPage in TabPages) {
tabPage.ImageIndexer.ImageList = value;
}
if (value != null) {
value.RecreateHandle += recreateHandler;
value.Disposed += disposedHandler;
}
}
}
}
///
/// By default, tabs will automatically size themselves to fit their icon, if any, and their label.
/// However, the tab size can be explicity set by setting this property.
///
[
SRCategory(SR.CatBehavior),
Localizable(true),
SRDescription(SR.TabBaseItemSizeDescr)
]
public Size ItemSize {
get {
if (itemSize.IsEmpty) {
// Obtain the current itemsize of the first tab from the winctl control
//
if (IsHandleCreated) {
tabControlState[TABCONTROLSTATE_getTabRectfromItemSize] = true;
return GetTabRect(0).Size;
}
else {
return DEFAULT_ITEMSIZE;
}
}
else {
return itemSize;
}
}
set {
if (value.Width < 0 || value.Height < 0) {
throw new ArgumentOutOfRangeException("ItemSize", SR.GetString(SR.InvalidArgument, "ItemSize", value.ToString()));
}
itemSize = value;
ApplyItemSize();
UpdateSize();
Invalidate();
}
}
///
/// This private property is set by the TabPageCollection when the user calls "InsertItem".
/// The problem is when InsertItem is called then we add this item to the ControlsCollection (in addition to the TabPageCollection)
/// to keep both the collections is [....]. But the controlCollection.Add is overriden to again ADD the item to the TabPageCollection.
/// So we keep this flag in order to aviod repeatd addition (only during insert)
/// When the Add ends ... we reset this flag.
///
private bool InsertingItem {
get {
return (bool)tabControlState[TABCONTROLSTATE_insertingItem];
}
set {
tabControlState[TABCONTROLSTATE_insertingItem] = value;
}
}
///
/// Indicates if there can be more than one row of tabs. By default [when
/// this property is false], if there are more tabs than available display
/// space, arrows are shown to let the user navigate between the extra
/// tabs, but only one row is shown. If this property is set to true, then
/// Windows spills extra tabs over on to second rows.
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
SRDescription(SR.TabBaseMultilineDescr)
]
public bool Multiline {
get {
return tabControlState[TABCONTROLSTATE_multiline];
}
set {
if (Multiline != value) {
tabControlState[TABCONTROLSTATE_multiline] = value;
if (Multiline == false && (this.alignment == TabAlignment.Left || this.alignment == TabAlignment.Right))
this.alignment = TabAlignment.Top;
RecreateHandle();
}
}
}
///
/// The amount of padding around the items in the individual tabs.
/// You can specify both horizontal and vertical padding.
///
[
SRCategory(SR.CatBehavior),
Localizable(true),
SRDescription(SR.TabBasePaddingDescr)
]
public new Point Padding {
get {
return padding;
}
set {
//do some validation checking here, against min & max GridSize
//
if ( value.X < 0 || value.Y < 0 )
throw new ArgumentOutOfRangeException("Padding", SR.GetString(SR.InvalidArgument, "Padding", value.ToString()));
if (padding != value) {
padding = value;
if (IsHandleCreated) {
RecreateHandle();
}
}
}
}
///
/// This is used for international applications where the language
/// is written from RightToLeft. When this property is true,
// and the RightToLeft is true, mirroring will be turned on on the form, and
/// control placement and text will be from right to left.
///
[
SRCategory(SR.CatAppearance),
Localizable(true),
DefaultValue(false),
SRDescription(SR.ControlRightToLeftLayoutDescr)
]
public virtual bool RightToLeftLayout {
get {
return rightToLeftLayout;
}
set {
if (value != rightToLeftLayout) {
rightToLeftLayout = value;
using(new LayoutTransaction(this, this, PropertyNames.RightToLeftLayout)) {
OnRightToLeftLayoutChanged(EventArgs.Empty);
}
}
}
}
///
/// The number of rows currently being displayed in
/// the tab strip. This is most commonly used when the Multline property
/// is 'true' and you want to know how many rows the tabs are currently
/// taking up.
///
[
SRCategory(SR.CatAppearance),
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
SRDescription(SR.TabBaseRowCountDescr)
]
public int RowCount {
get {
int n;
n = (int)SendMessage(NativeMethods.TCM_GETROWCOUNT, 0, 0);
return n;
}
}
///
/// The index of the currently selected tab in the strip, if there
/// is one. If the value is -1, there is currently no selection. If the
/// value is 0 or greater, than the value is the index of the currently
/// selected tab.
///
[
Browsable(false),
SRCategory(SR.CatBehavior),
DefaultValue(-1),
SRDescription(SR.selectedIndexDescr)
]
public int SelectedIndex {
get {
if (IsHandleCreated) {
int n;
n = (int)SendMessage(NativeMethods.TCM_GETCURSEL, 0, 0);
return n;
}
else {
return selectedIndex;
}
}
set {
if (value < -1) {
throw new ArgumentOutOfRangeException("SelectedIndex", SR.GetString(SR.InvalidLowBoundArgumentEx, "SelectedIndex", value.ToString(CultureInfo.CurrentCulture), (-1).ToString(CultureInfo.CurrentCulture)));
}
if (SelectedIndex != value) {
if (IsHandleCreated) {
// Guard Against CreateHandle ..
// And also if we are setting SelectedIndex ourselves from SelectNextTab..
if (!tabControlState[TABCONTROLSTATE_fromCreateHandles] && !tabControlState[TABCONTROLSTATE_selectFirstControl]) {
tabControlState[TABCONTROLSTATE_UISelection] = true;
// Fire Deselecting .. Deselected on currently selected TabPage...
if (WmSelChanging()) {
tabControlState[TABCONTROLSTATE_UISelection] = false;
return;
}
if(ValidationCancelled) {
tabControlState[TABCONTROLSTATE_UISelection] = false;
return;
}
}
SendMessage(NativeMethods.TCM_SETCURSEL, value, 0);
if (!tabControlState[TABCONTROLSTATE_fromCreateHandles] && !tabControlState[TABCONTROLSTATE_selectFirstControl]) {
// Fire Selecting & Selected .. Also if Selecting is Canceled..
// then retuern as we do not change the SelectedIndex...
tabControlState[TABCONTROLSTATE_selectFirstControl] = true;
if (WmSelChange ()) {
tabControlState[TABCONTROLSTATE_UISelection] = false;
tabControlState[TABCONTROLSTATE_selectFirstControl] = false;
return;
}
else
{
tabControlState[TABCONTROLSTATE_selectFirstControl] = false;
}
}
}
else {
selectedIndex = value;
}
}
}
}
///
/// The selection to the given tab, provided it .equals a tab in the
/// list. The return value is the index of the tab that was selected,
/// or -1 if no tab was selected.
///
[
SRCategory(SR.CatAppearance),
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
SRDescription(SR.TabControlSelectedTabDescr)
]
public TabPage SelectedTab {
get {
return SelectedTabInternal;
}
set {
SelectedTabInternal = value;
}
}
internal TabPage SelectedTabInternal {
get {
int index = SelectedIndex;
if (index == -1) {
return null;
}
else {
Debug.Assert(0 <= index && index < tabPages.Length, "SelectedIndex returned an invalid index");
return tabPages[index];
}
}
set {
int index = FindTabPage(value);
SelectedIndex = index;
}
}
///
/// By default, tabs are big enough to display their text, and any space
/// on the right of the strip is left as such. However, you can also
/// set it such that the tabs are stretched to fill out the right extent
/// of the strip, if necessary, or you can set it such that all tabs
/// the same width.
///
[
SRCategory(SR.CatBehavior),
DefaultValue(TabSizeMode.Normal),
SRDescription(SR.TabBaseSizeModeDescr),
RefreshProperties(RefreshProperties.Repaint)
]
public TabSizeMode SizeMode {
get {
return sizeMode;
}
set {
if (sizeMode == value) return;
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)TabSizeMode.Normal, (int)TabSizeMode.Fixed)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(TabSizeMode));
}
sizeMode = value;
RecreateHandle();
}
}
///
/// Indicates whether tooltips are being shown for tabs that have tooltips set on
/// them.
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
Localizable(true),
SRDescription(SR.TabBaseShowToolTipsDescr)
]
public bool ShowToolTips {
get {
return tabControlState[TABCONTROLSTATE_showToolTips];
}
set {
if (ShowToolTips != value) {
tabControlState[TABCONTROLSTATE_showToolTips] = value;
RecreateHandle();
}
}
}
///
/// Returns the number of tabs in the strip
///
[
SRCategory(SR.CatAppearance),
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
SRDescription(SR.TabBaseTabCountDescr)
]
public int TabCount {
get { return tabPageCount;}
}
///
/// Returns the Collection of TabPages.
///
[
SRCategory(SR.CatBehavior),
SRDescription(SR.TabControlTabsDescr),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
Editor("System.Windows.Forms.Design.TabPageCollectionEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor)),
MergableProperty(false)
]
public TabPageCollection TabPages {
get {
return tabCollection;
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never), Bindable(false)]
public override string Text {
get {
return base.Text;
}
set {
base.Text = value;
}
}
///
/// [To be supplied.]
///
[SRCategory(SR.CatBehavior), SRDescription(SR.drawItemEventDescr)]
public event DrawItemEventHandler DrawItem {
add {
onDrawItem += value;
}
remove {
onDrawItem -= value;
}
}
///
/// [To be supplied.]
///
[SRCategory(SR.CatPropertyChanged), SRDescription(SR.ControlOnRightToLeftLayoutChangedDescr)]
public event EventHandler RightToLeftLayoutChanged {
add {
Events.AddHandler(EVENT_RIGHTTOLEFTLAYOUTCHANGED, value);
}
remove {
Events.RemoveHandler(EVENT_RIGHTTOLEFTLAYOUTCHANGED, value);
}
}
///
/// [To be supplied.]
///
[SRCategory(SR.CatBehavior), SRDescription(SR.selectedIndexChangedEventDescr)]
public event EventHandler SelectedIndexChanged {
add {
onSelectedIndexChanged += value;
}
remove {
onSelectedIndexChanged -= value;
}
}
///
///
/// Occurs before a tabpage is selected as the top tabPage.
///
///
[SRCategory(SR.CatAction), SRDescription(SR.TabControlSelectingEventDescr)
]
public event TabControlCancelEventHandler Selecting {
add {
Events.AddHandler(EVENT_SELECTING, value);
}
remove {
Events.RemoveHandler(EVENT_SELECTING, value);
}
}
///
///
/// Occurs after a tabpage is selected as the top tabPage.
///
///
[SRCategory(SR.CatAction), SRDescription(SR.TabControlSelectedEventDescr)
]
public event TabControlEventHandler Selected {
add {
Events.AddHandler(EVENT_SELECTED, value);
}
remove {
Events.RemoveHandler(EVENT_SELECTED, value);
}
}
///
///
/// Occurs before the visible property of the top tabpage is set to false.
///
///
[SRCategory(SR.CatAction), SRDescription(SR.TabControlDeselectingEventDescr)
]
public event TabControlCancelEventHandler Deselecting {
add {
Events.AddHandler(EVENT_DESELECTING, value);
}
remove {
Events.RemoveHandler(EVENT_DESELECTING, value);
}
}
///
///
/// Occurs after the visible property of the top tabpage is set to false.
///
///
[SRCategory(SR.CatAction), SRDescription(SR.TabControlDeselectedEventDescr)
]
public event TabControlEventHandler Deselected {
add {
Events.AddHandler(EVENT_DESELECTED, value);
}
remove {
Events.RemoveHandler(EVENT_DESELECTED, value);
}
}
///
/// TabControl Onpaint.
///
///
///
///
///
///
///
///
///
///
///
///
/// Allows the user to specify the index in Tabcontrol.TabPageCollection of the tabpage to be hidden.
///
public void DeselectTab(int index) {
TabPage t = GetTabPage(index);
if (SelectedTab == t) {
if (0 <= index && index < TabPages.Count -1) {
SelectedTab = GetTabPage(++index);
}
else {
SelectedTab = GetTabPage(0);
}
}
}
///
/// Allows the user to specify the tabpage in Tabcontrol.TabPageCollection to be hidden.
///
public void DeselectTab(TabPage tabPage) {
if (tabPage == null) {
throw new ArgumentNullException("tabPage");
}
int index = FindTabPage(tabPage);
DeselectTab(index);
}
///
/// Allows the user to specify the name of the tabpage in Tabcontrol.TabPageCollection to be hidden.
///
public void DeselectTab(string tabPageName) {
if (tabPageName == null) {
throw new ArgumentNullException("tabPageName");
}
TabPage tabPage = TabPages[tabPageName];
DeselectTab(tabPage);
}
///
///
///
/// This has package scope so that TabStrip and TabControl can call it.
///
///
/// This has package scope so that TabStrip and TabControl can call it.
///
///
/// Retrieves the bounding rectangle for the given tab in the tab strip.
///
public Rectangle GetTabRect(int index) {
if (index < 0 || (index >= tabPageCount && !tabControlState[TABCONTROLSTATE_getTabRectfromItemSize])) {
throw new ArgumentOutOfRangeException("index", SR.GetString(SR.InvalidArgument, "index", index.ToString(CultureInfo.CurrentCulture)));
}
tabControlState[TABCONTROLSTATE_getTabRectfromItemSize] = false ;
NativeMethods.RECT rect = new NativeMethods.RECT();
// normally, we would not want to create the handle for this, but since
// it is dependent on the actual physical display, we simply must.
if (!IsHandleCreated)
CreateHandle();
SendMessage(NativeMethods.TCM_GETITEMRECT, index, ref rect);
return Rectangle.FromLTRB(rect.left, rect.top, rect.right, rect.bottom);
}
///
///
///
///
///
/// This function is used by the Insert Logic to insert a tabPage in the current TabPage in the TabPageCollection.
///
///
/// Handling special input keys, such as pgup, pgdown, home, end, etc...
///
protected override bool IsInputKey(Keys keyData) {
if ((keyData & Keys.Alt) == Keys.Alt) return false;
switch (keyData & Keys.KeyCode) {
case Keys.PageUp:
case Keys.PageDown:
case Keys.Home:
case Keys.End:
return true;
}
return base.IsInputKey(keyData);
}
///
/// This is a notification that the handle has been created.
/// We do some work here to configure the handle.
/// Overriders should call base.OnHandleCreated()
///
///
/// [To be supplied.]
///
protected override void OnHandleDestroyed(EventArgs e) {
if (!Disposing) {
selectedIndex = SelectedIndex;
}
//Remove the Handle from NativewIndow....
// VSWhidbey 539185, Don't try to remove the Handle if we've already done so
if (handleInTable)
{
handleInTable = false;
NativeWindow.RemoveWindowFromIDTable(this.Handle);
}
base.OnHandleDestroyed(e);
}
///
/// Actually goes and fires the OnDrawItem event. Inheriting controls
/// should use this to know when the event is fired [this is preferable to
/// adding an event handler on yourself for this event]. They should,
/// however, remember to call base.onDrawItem(e); to ensure the event is
/// still fired to external listeners
///
protected virtual void OnDrawItem(DrawItemEventArgs e) {
if (onDrawItem != null) onDrawItem(this, e);
}
///
/// Actually goes and fires the OnLeave event. Inheriting controls
/// should use this to know when the event is fired [this is preferable to
/// adding an event handler on yourself for this event]. They should,
/// however, remember to call base.OnLeave(e); to ensure the event is
/// still fired to external listeners
/// This listener is overidden so that we can fire SAME ENTER and LEAVE
/// events on the TabPage.
/// TabPage should fire enter when the focus is on the TABPAGE and not when the control
/// within the TabPage gets Focused.
/// Similary the Leave event should fire when the TabControl (and hence the TabPage) looses
/// Focus. To be Backward compatible we have added new bool which can be set to true
/// to the get the NEW SANE ENTER-LEAVE EVENTS ON THE TABPAGE.
///
protected override void OnEnter(EventArgs e) {
base.OnEnter (e);
if (SelectedTab != null) {
SelectedTab.FireEnter(e);
}
}
///
/// Actually goes and fires the OnLeave event. Inheriting controls
/// should use this to know when the event is fired [this is preferable to
/// adding an event handler on yourself for this event]. They should,
/// however, remember to call base.OnLeave(e); to ensure the event is
/// still fired to external listeners
/// This listener is overidden so that we can fire SAME ENTER and LEAVE
/// events on the TabPage.
/// TabPage should fire enter when the focus is on the TABPAGE and not when the control
/// within the TabPage gets Focused.
/// Similary the Leave event should fire when the TabControl (and hence the TabPage) looses
/// Focus. To be Backward compatible we have added new bool which can be set to true
/// to the get the NEW SANE ENTER-LEAVE EVENTS ON THE TABPAGE.
///
protected override void OnLeave(EventArgs e) {
if (SelectedTab != null) {
SelectedTab.FireLeave(e);
}
base.OnLeave(e);
}
///
/// We override this to get tabbing functionality.
/// If overriding this, remember to call base.onKeyDown.
///
///
///
///
/// [To be supplied.]
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void OnRightToLeftLayoutChanged(EventArgs e) {
if (GetAnyDisposingInHierarchy()) {
return;
}
if (RightToLeft == RightToLeft.Yes) {
RecreateHandle();
}
EventHandler eh = Events[EVENT_RIGHTTOLEFTLAYOUTCHANGED] as EventHandler;
if (eh != null) {
eh(this, e);
}
}
///
/// Actually goes and fires the onSelectedIndexChanged event. Inheriting controls
/// should use this to know when the event is fired [this is preferable to
/// adding an event handler on yourself for this event]. They should,
/// however, remember to call base.onSelectedIndexChanged(e); to ensure the event is
/// still fired to external listeners
///
protected virtual void OnSelectedIndexChanged(EventArgs e) {
int index = SelectedIndex;
cachedDisplayRect = Rectangle.Empty;
UpdateTabSelection(tabControlState[TABCONTROLSTATE_UISelection]);
tabControlState[TABCONTROLSTATE_UISelection] = false;
if (onSelectedIndexChanged != null) onSelectedIndexChanged(this, e);
}
///
///
/// Raises the
///
protected virtual void OnSelecting(TabControlCancelEventArgs e) {
TabControlCancelEventHandler handler = (TabControlCancelEventHandler)Events[EVENT_SELECTING];
if (handler != null) handler(this, e);
}
///
///
/// Raises the
///
protected virtual void OnSelected(TabControlEventArgs e) {
TabControlEventHandler handler = (TabControlEventHandler)Events[EVENT_SELECTED];
if (handler != null) handler(this, e);
// Raise the enter event for this tab.
if (SelectedTab != null) {
SelectedTab.FireEnter(EventArgs.Empty);
}
}
///
///
/// Raises the
///
protected virtual void OnDeselecting(TabControlCancelEventArgs e) {
TabControlCancelEventHandler handler = (TabControlCancelEventHandler)Events[EVENT_DESELECTING];
if (handler != null) handler(this, e);
}
///
///
/// Raises the
///
protected virtual void OnDeselected(TabControlEventArgs e) {
TabControlEventHandler handler = (TabControlEventHandler)Events[EVENT_DESELECTED];
if (handler != null) handler(this, e);
// Raise the Leave event for this tab.
if (SelectedTab != null) {
SelectedTab.FireLeave(EventArgs.Empty);
}
}
///
/// We override this to get the Ctrl and Ctrl-Shift Tab functionality.
///
///
///
///
/// [To be supplied.]
///
protected override void OnFontChanged(EventArgs e) {
base.OnFontChanged(e);
cachedDisplayRect = Rectangle.Empty;
UpdateSize();
}
internal override void RecreateHandleCore() {
//
TabPage[] tabPages = GetTabPages();
int index = ((tabPages.Length > 0) && (SelectedIndex == -1)) ? 0: SelectedIndex;
// We don't actually want to remove the windows forms Tabpages - we only
// want to remove the corresponding TCITEM structs.
// So, no RemoveAll()
if (IsHandleCreated) {
SendMessage(NativeMethods.TCM_DELETEALLITEMS, 0, 0);
}
this.tabPages = null;
tabPageCount = 0;
base.RecreateHandleCore();
for (int i = 0; i < tabPages.Length; i++) {
TabPages.Add(tabPages[i]);
}
try {
tabControlState[TABCONTROLSTATE_fromCreateHandles] = true;
SelectedIndex = index;
}
finally {
tabControlState[TABCONTROLSTATE_fromCreateHandles] = false;
}
// The comctl32 TabControl seems to have some painting glitches. Briefly
// resizing the control seems to fix these.
//
UpdateSize();
}
///
/// [To be supplied.]
///
protected void RemoveAll() {
this.Controls.Clear();
SendMessage(NativeMethods.TCM_DELETEALLITEMS, 0, 0);
tabPages = null;
tabPageCount = 0;
}
///
///
///
/// Called by ToolTip to poke in that Tooltip into this ComCtl so that the Native ChildToolTip is not exposed.
///
///
///
///
/// Allows the user to specify the index in Tabcontrol.TabPageCollection of the tabpage to be shown.
///
public void SelectTab(int index) {
TabPage t = GetTabPage(index);
if(t != null)
{
SelectedTab = t;
}
}
///
/// Allows the user to specify the tabpage in Tabcontrol.TabPageCollection to be shown.
///
public void SelectTab(TabPage tabPage) {
if (tabPage == null) {
throw new ArgumentNullException("tabPage");
}
int index = FindTabPage(tabPage);
SelectTab(index);
}
///
/// Allows the user to specify the name of the tabpage in Tabcontrol.TabPageCollection to be shown.
///
public void SelectTab(string tabPageName) {
if (tabPageName == null) {
throw new ArgumentNullException("tabPageName");
}
TabPage tabPage = TabPages[tabPageName];
SelectTab(tabPage);
}
///
/// This is called by TabControl in response to the KeyDown event to override the selection of tabpages
/// for different key combinations.
/// Control + Tab selects the next tabpage.
/// Control + Shift + Tab selects the previous tabpage.
/// Control + PageDown selects the next tabpage.
/// Control + PageUp selects the previous tabpage.
///
///
/// Returns a string representation for this control.
///
///
///
///
/// Set the panel selections appropriately
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
/// The tab's window procedure. Inheritng classes can override this
/// to add extra functionality, but should not forget to call
/// base.wndProc(m); to ensure the tab continues to function properly.
///
///
/// [To be supplied.]
///
public class TabPageCollection : IList {
private TabControl owner;
/// A caching mechanism for key accessor
/// We use an index here rather than control so that we don't have lifetime
/// issues by holding on to extra references.
private int lastAccessedIndex = -1;
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public TabPageCollection( TabControl owner ) {
if (owner == null) {
throw new ArgumentNullException("owner");
}
this.owner = owner;
}
///
/// [To be supplied.]
///
public virtual TabPage this[int index] {
get {
return owner.GetTabPage(index);
}
set {
owner.SetTabPage(index, value, value.GetTCITEM());
}
}
///
/// Retrieves the child control with the specified key.
///
public virtual TabPage this[string key] {
get {
// We do not support null and empty string as valid keys.
if (string.IsNullOrEmpty(key)){
return null;
}
// Search for the key in our collection
int index = IndexOfKey(key);
if (IsValidIndex(index)) {
return this[index];
}
else {
return null;
}
}
}
///
/// [To be supplied.]
///
[Browsable(false)]
public int Count {
get {
return owner.tabPageCount;
}
}
///
/// [To be supplied.]
///
public bool IsReadOnly {
get {
return false;
}
}
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public void Add(TabPage value) {
if (value == null) {
throw new ArgumentNullException("value");
}
owner.Controls.Add(value);
}
///
/// [To be supplied.]
///
public void Add(string text) {
TabPage page = new TabPage();
page.Text = text;
Add(page);
}
///
/// [To be supplied.]
///
public void Add(string key, string text) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
Add(page);
}
///
/// [To be supplied.]
///
public void Add(string key, string text, int imageIndex) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
page.ImageIndex = imageIndex;
Add(page);
}
///
/// [To be supplied.]
///
public void Add(string key, string text, string imageKey) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
page.ImageKey = imageKey;
Add(page);
}
// END - NEW ADD OVERLOADS FOR WHIDBEY -->
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public void AddRange(TabPage[] pages) {
if (pages == null) {
throw new ArgumentNullException("pages");
}
foreach(TabPage page in pages) {
Add(page);
}
}
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public bool Contains(TabPage page) {
//check for the page not to be null
if (page == null)
throw new ArgumentNullException("value");
//end check
return IndexOf(page) != -1;
}
///
/// Returns true if the collection contains an item with the specified key, false otherwise.
///
public virtual bool ContainsKey(string key) {
return IsValidIndex(IndexOfKey(key));
}
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public int IndexOf(TabPage page) {
//check for the page not to be null
if (page == null)
throw new ArgumentNullException("value");
//end check
for(int index=0; index < Count; ++index) {
if (this[index] == page) {
return index;
}
}
return -1;
}
///
/// The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1.
///
public virtual int IndexOfKey(String key) {
// Step 0 - Arg validation
if (string.IsNullOrEmpty(key)){
return -1; // we dont support empty or null keys.
}
// step 1 - check the last cached item
if (IsValidIndex(lastAccessedIndex))
{
if (WindowsFormsUtils.SafeCompareStrings(this[lastAccessedIndex].Name, key, /* ignoreCase = */ true)) {
return lastAccessedIndex;
}
}
// step 2 - search for the item
for (int i = 0; i < this.Count; i ++) {
if (WindowsFormsUtils.SafeCompareStrings(this[i].Name, key, /* ignoreCase = */ true)) {
lastAccessedIndex = i;
return i;
}
}
// step 3 - we didn't find it. Invalidate the last accessed index and return -1.
lastAccessedIndex = -1;
return -1;
}
///
/// Inserts the supplied Tabpage at the given index.
///
public void Insert(int index, TabPage tabPage) {
owner.InsertItem(index, tabPage);
try {
// 247078 : See InsertingItem property
owner.InsertingItem = true;
owner.Controls.Add(tabPage);
}
finally {
owner.InsertingItem = false;
}
owner.Controls.SetChildIndex(tabPage, index);
}
///
/// [To be supplied.]
///
public void Insert(int index, string text) {
TabPage page = new TabPage();
page.Text = text;
Insert(index, page);
}
///
/// [To be supplied.]
///
public void Insert(int index, string key, string text) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
Insert(index, page);
}
///
/// [To be supplied.]
///
public void Insert(int index, string key, string text, int imageIndex) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
Insert(index,page);
// ImageKey and ImageIndex require parenting...
page.ImageIndex = imageIndex;
}
///
/// [To be supplied.]
///
public void Insert(int index, string key, string text, string imageKey) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
Insert(index, page);
// ImageKey and ImageIndex require parenting...
page.ImageKey = imageKey;
}
// END - NEW INSERT OVERLOADS FOR WHIDBEY -->
///
/// Determines if the index is valid for the collection.
///
///
/// [To be supplied.]
///
public virtual void Clear() {
owner.RemoveAll();
}
///
/// [To be supplied.]
///
public IEnumerator GetEnumerator() {
TabPage[] tabPages = owner.GetTabPages();
if (tabPages != null) {
return tabPages.GetEnumerator();
}
else {
return new TabPage[0].GetEnumerator();
}
}
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public void Remove(TabPage value) {
//check for the value not to be null
if (value == null)
throw new ArgumentNullException("value");
//end check
owner.Controls.Remove(value);
}
///
/// [To be supplied.]
///
public void RemoveAt(int index) {
owner.Controls.RemoveAt(index);
}
///
/// Removes the child control with the specified key.
///
public virtual void RemoveByKey(string key) {
int index = IndexOfKey(key);
if (IsValidIndex(index)) {
RemoveAt(index);
}
}
}
///
/// Collection of controls...
///
[ComVisible(false)]
public new class ControlCollection : Control.ControlCollection {
private TabControl owner;
/*C#r: protected*/
///
/// [To be supplied.]
///
public ControlCollection(TabControl owner)
: base(owner) {
this.owner = owner;
}
///
/// [To be supplied.]
///
public override void Add(Control value) {
if (!(value is TabPage)) {
throw new ArgumentException(SR.GetString(SR.TabControlInvalidTabPageType, value.GetType().Name));
}
TabPage tabPage = (TabPage)value;
// 247078 : See InsertingItem property
if (!owner.InsertingItem)
{
if (owner.IsHandleCreated) {
owner.AddTabPage(tabPage, tabPage.GetTCITEM());
}
else {
owner.Insert(owner.TabCount, tabPage);
}
}
base.Add(tabPage);
tabPage.Visible = false;
// Without this check, we force handle creation on the tabcontrol
// which is not good at all of there are any OCXs on it.
//
if (owner.IsHandleCreated) {
tabPage.Bounds = owner.DisplayRectangle;
}
// site the tabPage if necessary.
ISite site = owner.Site;
if (site != null) {
ISite siteTab = tabPage.Site;
if (siteTab == null) {
IContainer container = site.Container;
if (container != null)
{
container.Add(tabPage);
}
}
}
owner.ApplyItemSize();
owner.UpdateTabSelection(false);
}
///
/// [To be supplied.]
///
public override void Remove(Control value) {
base.Remove(value);
if (!(value is TabPage)) {
return;
}
int index = owner.FindTabPage((TabPage)value);
int curSelectedIndex = owner.SelectedIndex;
if (index != -1) {
owner.RemoveTabPage(index);
if (index == curSelectedIndex)
{
owner.SelectedIndex = 0; //Always select the first tabPage is the Selected TabPage is removed.
}
}
owner.UpdateTabSelection(false);
}
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
/*
*/
namespace System.Windows.Forms {
using System;
using System.Collections;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Configuration.Assemblies;
using Microsoft.Win32;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Drawing;
using System.Drawing.Design;
using System.Runtime.InteropServices;
using System.Runtime.Remoting;
using System.Runtime.Serialization.Formatters;
using System.Security;
using System.Security.Permissions;
using System.Windows.Forms.Layout;
using System.Globalization;
///
/// The TabControl. This control has a lot of the functionality of a TabStrip
/// but manages a list of TabPages which are the 'pages' that appear on each tab.
///
[
ComVisible(true),
ClassInterface(ClassInterfaceType.AutoDispatch),
DefaultProperty("TabPages"),
DefaultEvent("SelectedIndexChanged"),
Designer("System.Windows.Forms.Design.TabControlDesigner, " + AssemblyRef.SystemDesign),
SRDescription(SR.DescriptionTabControl)
]
public class TabControl : Control {
private static readonly Size DEFAULT_ITEMSIZE = Size.Empty;
private static readonly Point DEFAULT_PADDING = new Point(6, 3);
//properties
private TabPageCollection tabCollection;
private TabAlignment alignment = TabAlignment.Top;
private TabDrawMode drawMode = TabDrawMode.Normal;
private ImageList imageList = null;
private Size itemSize = DEFAULT_ITEMSIZE;
private Point padding = DEFAULT_PADDING;
private TabSizeMode sizeMode = TabSizeMode.Normal;
private TabAppearance appearance = TabAppearance.Normal;
private Rectangle cachedDisplayRect = Rectangle.Empty;
private bool currentlyScaling = false;
private int selectedIndex = -1;
private Size cachedSize = Size.Empty;
private string controlTipText = String.Empty;
private bool handleInTable;
//events
private EventHandler onSelectedIndexChanged;
private DrawItemEventHandler onDrawItem;
//events
private static readonly object EVENT_DESELECTING = new object();
private static readonly object EVENT_DESELECTED = new object();
private static readonly object EVENT_SELECTING = new object();
private static readonly object EVENT_SELECTED = new object();
private static readonly object EVENT_RIGHTTOLEFTLAYOUTCHANGED = new object();
private const int TABCONTROLSTATE_hotTrack = 0x00000001;
private const int TABCONTROLSTATE_multiline = 0x00000002;
private const int TABCONTROLSTATE_showToolTips = 0x00000004;
private const int TABCONTROLSTATE_getTabRectfromItemSize = 0x00000008;
private const int TABCONTROLSTATE_fromCreateHandles = 0x00000010;
private const int TABCONTROLSTATE_UISelection = 0x00000020;
private const int TABCONTROLSTATE_selectFirstControl = 0x00000040;
private const int TABCONTROLSTATE_insertingItem = 0x00000080;
private const int TABCONTROLSTATE_autoSize = 0x00000100;
// PERF: take all the bools and put them into a state variable
private System.Collections.Specialized.BitVector32 tabControlState; // see TABCONTROLSTATE_ consts above
///
/// This message is posted by the control to itself after a TabPage is
/// added to it. On certain occasions, after items are added to a
/// TabControl in quick succession, TCM_ADJUSTRECT calls return the wrong
/// display rectangle. When the message is received, the control calls
/// updateTabSelection() to layout the TabPages correctly.
///
///
/// Constructs a TabBase object, usually as the base class for a TabStrip or TabControl.
///
public TabControl()
: base() {
tabControlState = new System.Collections.Specialized.BitVector32(0x00000000);
tabCollection = new TabPageCollection(this);
SetStyle(ControlStyles.UserPaint, false);
}
///
/// Returns on what area of the control the tabs reside on (A TabAlignment value).
/// The possibilities are Top (the default), Bottom, Left, and Right. When alignment
/// is left or right, the Multiline property is ignored and Multiline is implicitly on.
/// If the alignment is anything other than top, TabAppearance.FlatButtons degenerates
/// to TabAppearance.Buttons.
///
[
SRCategory(SR.CatBehavior),
Localizable(true),
DefaultValue(TabAlignment.Top),
RefreshProperties(RefreshProperties.All),
SRDescription(SR.TabBaseAlignmentDescr)
]
public TabAlignment Alignment {
get {
return alignment;
}
set {
if (this.alignment != value) {
//valid values are 0x0 to 0x3
if (!ClientUtils.IsEnumValid(value, (int)value, (int)TabAlignment.Top, (int)TabAlignment.Right)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(TabAlignment));
}
this.alignment = value;
if (this.alignment == TabAlignment.Left || this.alignment == TabAlignment.Right)
Multiline = true;
RecreateHandle();
}
}
}
///
/// Indicates whether the tabs in the tabstrip look like regular tabs, or if they look
/// like buttons as seen in the Windows 95 taskbar.
/// If the alignment is anything other than top, TabAppearance.FlatButtons degenerates
/// to TabAppearance.Buttons.
///
[
SRCategory(SR.CatBehavior),
Localizable(true),
DefaultValue(TabAppearance.Normal),
SRDescription(SR.TabBaseAppearanceDescr)
]
public TabAppearance Appearance {
get {
if (appearance == TabAppearance.FlatButtons && alignment != TabAlignment.Top) {
return TabAppearance.Buttons;
}
else {
return appearance;
}
}
set {
if (this.appearance != value) {
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)TabAppearance.Normal, (int)TabAppearance.FlatButtons)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(TabAppearance));
}
this.appearance = value;
RecreateHandle();
//Fire OnStyleChanged(EventArgs.Empty) here since we are no longer calling UpdateStyles( ) but always reCreating the Handle.
OnStyleChanged(EventArgs.Empty);
}
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
public override Color BackColor {
get {
//The tab control can only be rendered in 1 color: System's Control color.
//So, always return this value... otherwise, we're inheriting the forms backcolor
//and passing it on to the pab pages.
return SystemColors.Control;
}
set {
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
public override Image BackgroundImage {
get {
return base.BackgroundImage;
}
set {
base.BackgroundImage = value;
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
public override ImageLayout BackgroundImageLayout {
get {
return base.BackgroundImageLayout;
}
set {
base.BackgroundImageLayout = value;
}
}
///
/// Deriving classes can override this to configure a default size for their control.
/// This is more efficient than setting the size in the control's constructor.
///
protected override Size DefaultSize {
get {
return new Size(200, 100);
}
}
///
/// This property is overridden and hidden from statement completion
/// on controls that are based on Win32 Native Controls.
///
[EditorBrowsable(EditorBrowsableState.Never)]
protected override bool DoubleBuffered {
get {
return base.DoubleBuffered;
}
set {
base.DoubleBuffered = value;
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
public override Color ForeColor {
get {
return base.ForeColor;
}
set {
base.ForeColor = value;
}
}
///
/// Returns the parameters needed to create the handle. Inheriting classes
/// can override this to provide extra functionality. They should not,
/// however, forget to call base.getCreateParams() first to get the struct
/// filled up with the basic info.
///
///
/// The rectangle that represents the Area of the tab strip not
/// taken up by the tabs, borders, or anything else owned by the Tab. This
/// is typically the rectangle you want to use to place the individual
/// children of the tab strip.
///
public override Rectangle DisplayRectangle {
get {
// Null out cachedDisplayRect whenever we do anything to change it...
//
if (!cachedDisplayRect.IsEmpty)
return cachedDisplayRect;
Rectangle bounds = Bounds;
NativeMethods.RECT rect = NativeMethods.RECT.FromXYWH(bounds.X, bounds.Y, bounds.Width, bounds.Height);
// We force a handle creation here, because otherwise the DisplayRectangle will be wildly inaccurate
//
if (!IsDisposed)
{
// Since this is called thru the OnResize (and Layout) which is triggered by SetExtent if the TabControl is hosted as
// a ActiveX control, so check if this is ActiveX and dont force Handle Creation here as the native code breaks in this case.
// please Refer to VsWhidbey :: 288940
if (!IsActiveX)
{
if (!IsHandleCreated) {
CreateHandle();
}
}
if (IsHandleCreated)
{
SendMessage(NativeMethods.TCM_ADJUSTRECT, 0, ref rect);
}
}
Rectangle r = Rectangle.FromLTRB(rect.left, rect.top, rect.right, rect.bottom);
Point p = this.Location;
r.X -= p.X;
r.Y -= p.Y;
cachedDisplayRect = r;
return r;
}
}
///
/// The drawing mode of the tabs in the tab strip. This will indicate
///
[
SRCategory(SR.CatBehavior),
DefaultValue(TabDrawMode.Normal),
SRDescription(SR.TabBaseDrawModeDescr)
]
public TabDrawMode DrawMode {
get {
return drawMode;
}
set {
//valid values are 0x0 to 0x1
if (!ClientUtils.IsEnumValid(value, (int)value, (int)TabDrawMode.Normal, (int)TabDrawMode.OwnerDrawFixed)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(TabDrawMode));
}
if (drawMode != value) {
drawMode = value;
RecreateHandle();
}
}
}
///
/// Indicates whether the tabs visually change when the mouse passes over them.
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
SRDescription(SR.TabBaseHotTrackDescr)
]
public bool HotTrack {
get {
return tabControlState[TABCONTROLSTATE_hotTrack];
}
set {
if (HotTrack != value) {
tabControlState[TABCONTROLSTATE_hotTrack] = value;
if (IsHandleCreated) {
RecreateHandle();
}
}
}
}
///
/// Returns the imageList the control points at. This is where tabs that have imageIndex
/// set will get there images from.
///
[
SRCategory(SR.CatAppearance),
RefreshProperties(RefreshProperties.Repaint),
DefaultValue(null),
SRDescription(SR.TabBaseImageListDescr)
]
public ImageList ImageList {
get {
return imageList;
}
set {
if (this.imageList != value) {
EventHandler recreateHandler = new EventHandler(ImageListRecreateHandle);
EventHandler disposedHandler = new EventHandler(DetachImageList);
if (imageList != null) {
imageList.RecreateHandle -= recreateHandler;
imageList.Disposed -= disposedHandler;
}
this.imageList = value;
IntPtr handle = (value != null) ? value.Handle : IntPtr.Zero;
if (IsHandleCreated)
SendMessage(NativeMethods.TCM_SETIMAGELIST, IntPtr.Zero, handle);
// Update the image list in the tab pages.
foreach (TabPage tabPage in TabPages) {
tabPage.ImageIndexer.ImageList = value;
}
if (value != null) {
value.RecreateHandle += recreateHandler;
value.Disposed += disposedHandler;
}
}
}
}
///
/// By default, tabs will automatically size themselves to fit their icon, if any, and their label.
/// However, the tab size can be explicity set by setting this property.
///
[
SRCategory(SR.CatBehavior),
Localizable(true),
SRDescription(SR.TabBaseItemSizeDescr)
]
public Size ItemSize {
get {
if (itemSize.IsEmpty) {
// Obtain the current itemsize of the first tab from the winctl control
//
if (IsHandleCreated) {
tabControlState[TABCONTROLSTATE_getTabRectfromItemSize] = true;
return GetTabRect(0).Size;
}
else {
return DEFAULT_ITEMSIZE;
}
}
else {
return itemSize;
}
}
set {
if (value.Width < 0 || value.Height < 0) {
throw new ArgumentOutOfRangeException("ItemSize", SR.GetString(SR.InvalidArgument, "ItemSize", value.ToString()));
}
itemSize = value;
ApplyItemSize();
UpdateSize();
Invalidate();
}
}
///
/// This private property is set by the TabPageCollection when the user calls "InsertItem".
/// The problem is when InsertItem is called then we add this item to the ControlsCollection (in addition to the TabPageCollection)
/// to keep both the collections is [....]. But the controlCollection.Add is overriden to again ADD the item to the TabPageCollection.
/// So we keep this flag in order to aviod repeatd addition (only during insert)
/// When the Add ends ... we reset this flag.
///
private bool InsertingItem {
get {
return (bool)tabControlState[TABCONTROLSTATE_insertingItem];
}
set {
tabControlState[TABCONTROLSTATE_insertingItem] = value;
}
}
///
/// Indicates if there can be more than one row of tabs. By default [when
/// this property is false], if there are more tabs than available display
/// space, arrows are shown to let the user navigate between the extra
/// tabs, but only one row is shown. If this property is set to true, then
/// Windows spills extra tabs over on to second rows.
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
SRDescription(SR.TabBaseMultilineDescr)
]
public bool Multiline {
get {
return tabControlState[TABCONTROLSTATE_multiline];
}
set {
if (Multiline != value) {
tabControlState[TABCONTROLSTATE_multiline] = value;
if (Multiline == false && (this.alignment == TabAlignment.Left || this.alignment == TabAlignment.Right))
this.alignment = TabAlignment.Top;
RecreateHandle();
}
}
}
///
/// The amount of padding around the items in the individual tabs.
/// You can specify both horizontal and vertical padding.
///
[
SRCategory(SR.CatBehavior),
Localizable(true),
SRDescription(SR.TabBasePaddingDescr)
]
public new Point Padding {
get {
return padding;
}
set {
//do some validation checking here, against min & max GridSize
//
if ( value.X < 0 || value.Y < 0 )
throw new ArgumentOutOfRangeException("Padding", SR.GetString(SR.InvalidArgument, "Padding", value.ToString()));
if (padding != value) {
padding = value;
if (IsHandleCreated) {
RecreateHandle();
}
}
}
}
///
/// This is used for international applications where the language
/// is written from RightToLeft. When this property is true,
// and the RightToLeft is true, mirroring will be turned on on the form, and
/// control placement and text will be from right to left.
///
[
SRCategory(SR.CatAppearance),
Localizable(true),
DefaultValue(false),
SRDescription(SR.ControlRightToLeftLayoutDescr)
]
public virtual bool RightToLeftLayout {
get {
return rightToLeftLayout;
}
set {
if (value != rightToLeftLayout) {
rightToLeftLayout = value;
using(new LayoutTransaction(this, this, PropertyNames.RightToLeftLayout)) {
OnRightToLeftLayoutChanged(EventArgs.Empty);
}
}
}
}
///
/// The number of rows currently being displayed in
/// the tab strip. This is most commonly used when the Multline property
/// is 'true' and you want to know how many rows the tabs are currently
/// taking up.
///
[
SRCategory(SR.CatAppearance),
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
SRDescription(SR.TabBaseRowCountDescr)
]
public int RowCount {
get {
int n;
n = (int)SendMessage(NativeMethods.TCM_GETROWCOUNT, 0, 0);
return n;
}
}
///
/// The index of the currently selected tab in the strip, if there
/// is one. If the value is -1, there is currently no selection. If the
/// value is 0 or greater, than the value is the index of the currently
/// selected tab.
///
[
Browsable(false),
SRCategory(SR.CatBehavior),
DefaultValue(-1),
SRDescription(SR.selectedIndexDescr)
]
public int SelectedIndex {
get {
if (IsHandleCreated) {
int n;
n = (int)SendMessage(NativeMethods.TCM_GETCURSEL, 0, 0);
return n;
}
else {
return selectedIndex;
}
}
set {
if (value < -1) {
throw new ArgumentOutOfRangeException("SelectedIndex", SR.GetString(SR.InvalidLowBoundArgumentEx, "SelectedIndex", value.ToString(CultureInfo.CurrentCulture), (-1).ToString(CultureInfo.CurrentCulture)));
}
if (SelectedIndex != value) {
if (IsHandleCreated) {
// Guard Against CreateHandle ..
// And also if we are setting SelectedIndex ourselves from SelectNextTab..
if (!tabControlState[TABCONTROLSTATE_fromCreateHandles] && !tabControlState[TABCONTROLSTATE_selectFirstControl]) {
tabControlState[TABCONTROLSTATE_UISelection] = true;
// Fire Deselecting .. Deselected on currently selected TabPage...
if (WmSelChanging()) {
tabControlState[TABCONTROLSTATE_UISelection] = false;
return;
}
if(ValidationCancelled) {
tabControlState[TABCONTROLSTATE_UISelection] = false;
return;
}
}
SendMessage(NativeMethods.TCM_SETCURSEL, value, 0);
if (!tabControlState[TABCONTROLSTATE_fromCreateHandles] && !tabControlState[TABCONTROLSTATE_selectFirstControl]) {
// Fire Selecting & Selected .. Also if Selecting is Canceled..
// then retuern as we do not change the SelectedIndex...
tabControlState[TABCONTROLSTATE_selectFirstControl] = true;
if (WmSelChange ()) {
tabControlState[TABCONTROLSTATE_UISelection] = false;
tabControlState[TABCONTROLSTATE_selectFirstControl] = false;
return;
}
else
{
tabControlState[TABCONTROLSTATE_selectFirstControl] = false;
}
}
}
else {
selectedIndex = value;
}
}
}
}
///
/// The selection to the given tab, provided it .equals a tab in the
/// list. The return value is the index of the tab that was selected,
/// or -1 if no tab was selected.
///
[
SRCategory(SR.CatAppearance),
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
SRDescription(SR.TabControlSelectedTabDescr)
]
public TabPage SelectedTab {
get {
return SelectedTabInternal;
}
set {
SelectedTabInternal = value;
}
}
internal TabPage SelectedTabInternal {
get {
int index = SelectedIndex;
if (index == -1) {
return null;
}
else {
Debug.Assert(0 <= index && index < tabPages.Length, "SelectedIndex returned an invalid index");
return tabPages[index];
}
}
set {
int index = FindTabPage(value);
SelectedIndex = index;
}
}
///
/// By default, tabs are big enough to display their text, and any space
/// on the right of the strip is left as such. However, you can also
/// set it such that the tabs are stretched to fill out the right extent
/// of the strip, if necessary, or you can set it such that all tabs
/// the same width.
///
[
SRCategory(SR.CatBehavior),
DefaultValue(TabSizeMode.Normal),
SRDescription(SR.TabBaseSizeModeDescr),
RefreshProperties(RefreshProperties.Repaint)
]
public TabSizeMode SizeMode {
get {
return sizeMode;
}
set {
if (sizeMode == value) return;
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)TabSizeMode.Normal, (int)TabSizeMode.Fixed)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(TabSizeMode));
}
sizeMode = value;
RecreateHandle();
}
}
///
/// Indicates whether tooltips are being shown for tabs that have tooltips set on
/// them.
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
Localizable(true),
SRDescription(SR.TabBaseShowToolTipsDescr)
]
public bool ShowToolTips {
get {
return tabControlState[TABCONTROLSTATE_showToolTips];
}
set {
if (ShowToolTips != value) {
tabControlState[TABCONTROLSTATE_showToolTips] = value;
RecreateHandle();
}
}
}
///
/// Returns the number of tabs in the strip
///
[
SRCategory(SR.CatAppearance),
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
SRDescription(SR.TabBaseTabCountDescr)
]
public int TabCount {
get { return tabPageCount;}
}
///
/// Returns the Collection of TabPages.
///
[
SRCategory(SR.CatBehavior),
SRDescription(SR.TabControlTabsDescr),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
Editor("System.Windows.Forms.Design.TabPageCollectionEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor)),
MergableProperty(false)
]
public TabPageCollection TabPages {
get {
return tabCollection;
}
}
///
/// [To be supplied.]
///
[Browsable(false), EditorBrowsable(EditorBrowsableState.Never), Bindable(false)]
public override string Text {
get {
return base.Text;
}
set {
base.Text = value;
}
}
///
/// [To be supplied.]
///
[SRCategory(SR.CatBehavior), SRDescription(SR.drawItemEventDescr)]
public event DrawItemEventHandler DrawItem {
add {
onDrawItem += value;
}
remove {
onDrawItem -= value;
}
}
///
/// [To be supplied.]
///
[SRCategory(SR.CatPropertyChanged), SRDescription(SR.ControlOnRightToLeftLayoutChangedDescr)]
public event EventHandler RightToLeftLayoutChanged {
add {
Events.AddHandler(EVENT_RIGHTTOLEFTLAYOUTCHANGED, value);
}
remove {
Events.RemoveHandler(EVENT_RIGHTTOLEFTLAYOUTCHANGED, value);
}
}
///
/// [To be supplied.]
///
[SRCategory(SR.CatBehavior), SRDescription(SR.selectedIndexChangedEventDescr)]
public event EventHandler SelectedIndexChanged {
add {
onSelectedIndexChanged += value;
}
remove {
onSelectedIndexChanged -= value;
}
}
///
///
/// Occurs before a tabpage is selected as the top tabPage.
///
///
[SRCategory(SR.CatAction), SRDescription(SR.TabControlSelectingEventDescr)
]
public event TabControlCancelEventHandler Selecting {
add {
Events.AddHandler(EVENT_SELECTING, value);
}
remove {
Events.RemoveHandler(EVENT_SELECTING, value);
}
}
///
///
/// Occurs after a tabpage is selected as the top tabPage.
///
///
[SRCategory(SR.CatAction), SRDescription(SR.TabControlSelectedEventDescr)
]
public event TabControlEventHandler Selected {
add {
Events.AddHandler(EVENT_SELECTED, value);
}
remove {
Events.RemoveHandler(EVENT_SELECTED, value);
}
}
///
///
/// Occurs before the visible property of the top tabpage is set to false.
///
///
[SRCategory(SR.CatAction), SRDescription(SR.TabControlDeselectingEventDescr)
]
public event TabControlCancelEventHandler Deselecting {
add {
Events.AddHandler(EVENT_DESELECTING, value);
}
remove {
Events.RemoveHandler(EVENT_DESELECTING, value);
}
}
///
///
/// Occurs after the visible property of the top tabpage is set to false.
///
///
[SRCategory(SR.CatAction), SRDescription(SR.TabControlDeselectedEventDescr)
]
public event TabControlEventHandler Deselected {
add {
Events.AddHandler(EVENT_DESELECTED, value);
}
remove {
Events.RemoveHandler(EVENT_DESELECTED, value);
}
}
///
/// TabControl Onpaint.
///
///
///
///
///
///
///
///
///
///
///
///
/// Allows the user to specify the index in Tabcontrol.TabPageCollection of the tabpage to be hidden.
///
public void DeselectTab(int index) {
TabPage t = GetTabPage(index);
if (SelectedTab == t) {
if (0 <= index && index < TabPages.Count -1) {
SelectedTab = GetTabPage(++index);
}
else {
SelectedTab = GetTabPage(0);
}
}
}
///
/// Allows the user to specify the tabpage in Tabcontrol.TabPageCollection to be hidden.
///
public void DeselectTab(TabPage tabPage) {
if (tabPage == null) {
throw new ArgumentNullException("tabPage");
}
int index = FindTabPage(tabPage);
DeselectTab(index);
}
///
/// Allows the user to specify the name of the tabpage in Tabcontrol.TabPageCollection to be hidden.
///
public void DeselectTab(string tabPageName) {
if (tabPageName == null) {
throw new ArgumentNullException("tabPageName");
}
TabPage tabPage = TabPages[tabPageName];
DeselectTab(tabPage);
}
///
///
///
/// This has package scope so that TabStrip and TabControl can call it.
///
///
/// This has package scope so that TabStrip and TabControl can call it.
///
///
/// Retrieves the bounding rectangle for the given tab in the tab strip.
///
public Rectangle GetTabRect(int index) {
if (index < 0 || (index >= tabPageCount && !tabControlState[TABCONTROLSTATE_getTabRectfromItemSize])) {
throw new ArgumentOutOfRangeException("index", SR.GetString(SR.InvalidArgument, "index", index.ToString(CultureInfo.CurrentCulture)));
}
tabControlState[TABCONTROLSTATE_getTabRectfromItemSize] = false ;
NativeMethods.RECT rect = new NativeMethods.RECT();
// normally, we would not want to create the handle for this, but since
// it is dependent on the actual physical display, we simply must.
if (!IsHandleCreated)
CreateHandle();
SendMessage(NativeMethods.TCM_GETITEMRECT, index, ref rect);
return Rectangle.FromLTRB(rect.left, rect.top, rect.right, rect.bottom);
}
///
///
///
///
///
/// This function is used by the Insert Logic to insert a tabPage in the current TabPage in the TabPageCollection.
///
///
/// Handling special input keys, such as pgup, pgdown, home, end, etc...
///
protected override bool IsInputKey(Keys keyData) {
if ((keyData & Keys.Alt) == Keys.Alt) return false;
switch (keyData & Keys.KeyCode) {
case Keys.PageUp:
case Keys.PageDown:
case Keys.Home:
case Keys.End:
return true;
}
return base.IsInputKey(keyData);
}
///
/// This is a notification that the handle has been created.
/// We do some work here to configure the handle.
/// Overriders should call base.OnHandleCreated()
///
///
/// [To be supplied.]
///
protected override void OnHandleDestroyed(EventArgs e) {
if (!Disposing) {
selectedIndex = SelectedIndex;
}
//Remove the Handle from NativewIndow....
// VSWhidbey 539185, Don't try to remove the Handle if we've already done so
if (handleInTable)
{
handleInTable = false;
NativeWindow.RemoveWindowFromIDTable(this.Handle);
}
base.OnHandleDestroyed(e);
}
///
/// Actually goes and fires the OnDrawItem event. Inheriting controls
/// should use this to know when the event is fired [this is preferable to
/// adding an event handler on yourself for this event]. They should,
/// however, remember to call base.onDrawItem(e); to ensure the event is
/// still fired to external listeners
///
protected virtual void OnDrawItem(DrawItemEventArgs e) {
if (onDrawItem != null) onDrawItem(this, e);
}
///
/// Actually goes and fires the OnLeave event. Inheriting controls
/// should use this to know when the event is fired [this is preferable to
/// adding an event handler on yourself for this event]. They should,
/// however, remember to call base.OnLeave(e); to ensure the event is
/// still fired to external listeners
/// This listener is overidden so that we can fire SAME ENTER and LEAVE
/// events on the TabPage.
/// TabPage should fire enter when the focus is on the TABPAGE and not when the control
/// within the TabPage gets Focused.
/// Similary the Leave event should fire when the TabControl (and hence the TabPage) looses
/// Focus. To be Backward compatible we have added new bool which can be set to true
/// to the get the NEW SANE ENTER-LEAVE EVENTS ON THE TABPAGE.
///
protected override void OnEnter(EventArgs e) {
base.OnEnter (e);
if (SelectedTab != null) {
SelectedTab.FireEnter(e);
}
}
///
/// Actually goes and fires the OnLeave event. Inheriting controls
/// should use this to know when the event is fired [this is preferable to
/// adding an event handler on yourself for this event]. They should,
/// however, remember to call base.OnLeave(e); to ensure the event is
/// still fired to external listeners
/// This listener is overidden so that we can fire SAME ENTER and LEAVE
/// events on the TabPage.
/// TabPage should fire enter when the focus is on the TABPAGE and not when the control
/// within the TabPage gets Focused.
/// Similary the Leave event should fire when the TabControl (and hence the TabPage) looses
/// Focus. To be Backward compatible we have added new bool which can be set to true
/// to the get the NEW SANE ENTER-LEAVE EVENTS ON THE TABPAGE.
///
protected override void OnLeave(EventArgs e) {
if (SelectedTab != null) {
SelectedTab.FireLeave(e);
}
base.OnLeave(e);
}
///
/// We override this to get tabbing functionality.
/// If overriding this, remember to call base.onKeyDown.
///
///
///
///
/// [To be supplied.]
///
[EditorBrowsable(EditorBrowsableState.Advanced)]
protected virtual void OnRightToLeftLayoutChanged(EventArgs e) {
if (GetAnyDisposingInHierarchy()) {
return;
}
if (RightToLeft == RightToLeft.Yes) {
RecreateHandle();
}
EventHandler eh = Events[EVENT_RIGHTTOLEFTLAYOUTCHANGED] as EventHandler;
if (eh != null) {
eh(this, e);
}
}
///
/// Actually goes and fires the onSelectedIndexChanged event. Inheriting controls
/// should use this to know when the event is fired [this is preferable to
/// adding an event handler on yourself for this event]. They should,
/// however, remember to call base.onSelectedIndexChanged(e); to ensure the event is
/// still fired to external listeners
///
protected virtual void OnSelectedIndexChanged(EventArgs e) {
int index = SelectedIndex;
cachedDisplayRect = Rectangle.Empty;
UpdateTabSelection(tabControlState[TABCONTROLSTATE_UISelection]);
tabControlState[TABCONTROLSTATE_UISelection] = false;
if (onSelectedIndexChanged != null) onSelectedIndexChanged(this, e);
}
///
///
/// Raises the
///
protected virtual void OnSelecting(TabControlCancelEventArgs e) {
TabControlCancelEventHandler handler = (TabControlCancelEventHandler)Events[EVENT_SELECTING];
if (handler != null) handler(this, e);
}
///
///
/// Raises the
///
protected virtual void OnSelected(TabControlEventArgs e) {
TabControlEventHandler handler = (TabControlEventHandler)Events[EVENT_SELECTED];
if (handler != null) handler(this, e);
// Raise the enter event for this tab.
if (SelectedTab != null) {
SelectedTab.FireEnter(EventArgs.Empty);
}
}
///
///
/// Raises the
///
protected virtual void OnDeselecting(TabControlCancelEventArgs e) {
TabControlCancelEventHandler handler = (TabControlCancelEventHandler)Events[EVENT_DESELECTING];
if (handler != null) handler(this, e);
}
///
///
/// Raises the
///
protected virtual void OnDeselected(TabControlEventArgs e) {
TabControlEventHandler handler = (TabControlEventHandler)Events[EVENT_DESELECTED];
if (handler != null) handler(this, e);
// Raise the Leave event for this tab.
if (SelectedTab != null) {
SelectedTab.FireLeave(EventArgs.Empty);
}
}
///
/// We override this to get the Ctrl and Ctrl-Shift Tab functionality.
///
///
///
///
/// [To be supplied.]
///
protected override void OnFontChanged(EventArgs e) {
base.OnFontChanged(e);
cachedDisplayRect = Rectangle.Empty;
UpdateSize();
}
internal override void RecreateHandleCore() {
//
TabPage[] tabPages = GetTabPages();
int index = ((tabPages.Length > 0) && (SelectedIndex == -1)) ? 0: SelectedIndex;
// We don't actually want to remove the windows forms Tabpages - we only
// want to remove the corresponding TCITEM structs.
// So, no RemoveAll()
if (IsHandleCreated) {
SendMessage(NativeMethods.TCM_DELETEALLITEMS, 0, 0);
}
this.tabPages = null;
tabPageCount = 0;
base.RecreateHandleCore();
for (int i = 0; i < tabPages.Length; i++) {
TabPages.Add(tabPages[i]);
}
try {
tabControlState[TABCONTROLSTATE_fromCreateHandles] = true;
SelectedIndex = index;
}
finally {
tabControlState[TABCONTROLSTATE_fromCreateHandles] = false;
}
// The comctl32 TabControl seems to have some painting glitches. Briefly
// resizing the control seems to fix these.
//
UpdateSize();
}
///
/// [To be supplied.]
///
protected void RemoveAll() {
this.Controls.Clear();
SendMessage(NativeMethods.TCM_DELETEALLITEMS, 0, 0);
tabPages = null;
tabPageCount = 0;
}
///
///
///
/// Called by ToolTip to poke in that Tooltip into this ComCtl so that the Native ChildToolTip is not exposed.
///
///
///
///
/// Allows the user to specify the index in Tabcontrol.TabPageCollection of the tabpage to be shown.
///
public void SelectTab(int index) {
TabPage t = GetTabPage(index);
if(t != null)
{
SelectedTab = t;
}
}
///
/// Allows the user to specify the tabpage in Tabcontrol.TabPageCollection to be shown.
///
public void SelectTab(TabPage tabPage) {
if (tabPage == null) {
throw new ArgumentNullException("tabPage");
}
int index = FindTabPage(tabPage);
SelectTab(index);
}
///
/// Allows the user to specify the name of the tabpage in Tabcontrol.TabPageCollection to be shown.
///
public void SelectTab(string tabPageName) {
if (tabPageName == null) {
throw new ArgumentNullException("tabPageName");
}
TabPage tabPage = TabPages[tabPageName];
SelectTab(tabPage);
}
///
/// This is called by TabControl in response to the KeyDown event to override the selection of tabpages
/// for different key combinations.
/// Control + Tab selects the next tabpage.
/// Control + Shift + Tab selects the previous tabpage.
/// Control + PageDown selects the next tabpage.
/// Control + PageUp selects the previous tabpage.
///
///
/// Returns a string representation for this control.
///
///
///
///
/// Set the panel selections appropriately
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
/// The tab's window procedure. Inheritng classes can override this
/// to add extra functionality, but should not forget to call
/// base.wndProc(m); to ensure the tab continues to function properly.
///
///
/// [To be supplied.]
///
public class TabPageCollection : IList {
private TabControl owner;
/// A caching mechanism for key accessor
/// We use an index here rather than control so that we don't have lifetime
/// issues by holding on to extra references.
private int lastAccessedIndex = -1;
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public TabPageCollection( TabControl owner ) {
if (owner == null) {
throw new ArgumentNullException("owner");
}
this.owner = owner;
}
///
/// [To be supplied.]
///
public virtual TabPage this[int index] {
get {
return owner.GetTabPage(index);
}
set {
owner.SetTabPage(index, value, value.GetTCITEM());
}
}
///
/// Retrieves the child control with the specified key.
///
public virtual TabPage this[string key] {
get {
// We do not support null and empty string as valid keys.
if (string.IsNullOrEmpty(key)){
return null;
}
// Search for the key in our collection
int index = IndexOfKey(key);
if (IsValidIndex(index)) {
return this[index];
}
else {
return null;
}
}
}
///
/// [To be supplied.]
///
[Browsable(false)]
public int Count {
get {
return owner.tabPageCount;
}
}
///
/// [To be supplied.]
///
public bool IsReadOnly {
get {
return false;
}
}
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public void Add(TabPage value) {
if (value == null) {
throw new ArgumentNullException("value");
}
owner.Controls.Add(value);
}
///
/// [To be supplied.]
///
public void Add(string text) {
TabPage page = new TabPage();
page.Text = text;
Add(page);
}
///
/// [To be supplied.]
///
public void Add(string key, string text) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
Add(page);
}
///
/// [To be supplied.]
///
public void Add(string key, string text, int imageIndex) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
page.ImageIndex = imageIndex;
Add(page);
}
///
/// [To be supplied.]
///
public void Add(string key, string text, string imageKey) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
page.ImageKey = imageKey;
Add(page);
}
// END - NEW ADD OVERLOADS FOR WHIDBEY -->
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public void AddRange(TabPage[] pages) {
if (pages == null) {
throw new ArgumentNullException("pages");
}
foreach(TabPage page in pages) {
Add(page);
}
}
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public bool Contains(TabPage page) {
//check for the page not to be null
if (page == null)
throw new ArgumentNullException("value");
//end check
return IndexOf(page) != -1;
}
///
/// Returns true if the collection contains an item with the specified key, false otherwise.
///
public virtual bool ContainsKey(string key) {
return IsValidIndex(IndexOfKey(key));
}
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public int IndexOf(TabPage page) {
//check for the page not to be null
if (page == null)
throw new ArgumentNullException("value");
//end check
for(int index=0; index < Count; ++index) {
if (this[index] == page) {
return index;
}
}
return -1;
}
///
/// The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1.
///
public virtual int IndexOfKey(String key) {
// Step 0 - Arg validation
if (string.IsNullOrEmpty(key)){
return -1; // we dont support empty or null keys.
}
// step 1 - check the last cached item
if (IsValidIndex(lastAccessedIndex))
{
if (WindowsFormsUtils.SafeCompareStrings(this[lastAccessedIndex].Name, key, /* ignoreCase = */ true)) {
return lastAccessedIndex;
}
}
// step 2 - search for the item
for (int i = 0; i < this.Count; i ++) {
if (WindowsFormsUtils.SafeCompareStrings(this[i].Name, key, /* ignoreCase = */ true)) {
lastAccessedIndex = i;
return i;
}
}
// step 3 - we didn't find it. Invalidate the last accessed index and return -1.
lastAccessedIndex = -1;
return -1;
}
///
/// Inserts the supplied Tabpage at the given index.
///
public void Insert(int index, TabPage tabPage) {
owner.InsertItem(index, tabPage);
try {
// 247078 : See InsertingItem property
owner.InsertingItem = true;
owner.Controls.Add(tabPage);
}
finally {
owner.InsertingItem = false;
}
owner.Controls.SetChildIndex(tabPage, index);
}
///
/// [To be supplied.]
///
public void Insert(int index, string text) {
TabPage page = new TabPage();
page.Text = text;
Insert(index, page);
}
///
/// [To be supplied.]
///
public void Insert(int index, string key, string text) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
Insert(index, page);
}
///
/// [To be supplied.]
///
public void Insert(int index, string key, string text, int imageIndex) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
Insert(index,page);
// ImageKey and ImageIndex require parenting...
page.ImageIndex = imageIndex;
}
///
/// [To be supplied.]
///
public void Insert(int index, string key, string text, string imageKey) {
TabPage page = new TabPage();
page.Name = key;
page.Text = text;
Insert(index, page);
// ImageKey and ImageIndex require parenting...
page.ImageKey = imageKey;
}
// END - NEW INSERT OVERLOADS FOR WHIDBEY -->
///
/// Determines if the index is valid for the collection.
///
///
/// [To be supplied.]
///
public virtual void Clear() {
owner.RemoveAll();
}
///
/// [To be supplied.]
///
public IEnumerator GetEnumerator() {
TabPage[] tabPages = owner.GetTabPages();
if (tabPages != null) {
return tabPages.GetEnumerator();
}
else {
return new TabPage[0].GetEnumerator();
}
}
///
/// [To be supplied.]
///
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public void Remove(TabPage value) {
//check for the value not to be null
if (value == null)
throw new ArgumentNullException("value");
//end check
owner.Controls.Remove(value);
}
///
/// [To be supplied.]
///
public void RemoveAt(int index) {
owner.Controls.RemoveAt(index);
}
///
/// Removes the child control with the specified key.
///
public virtual void RemoveByKey(string key) {
int index = IndexOfKey(key);
if (IsValidIndex(index)) {
RemoveAt(index);
}
}
}
///
/// Collection of controls...
///
[ComVisible(false)]
public new class ControlCollection : Control.ControlCollection {
private TabControl owner;
/*C#r: protected*/
///
/// [To be supplied.]
///
public ControlCollection(TabControl owner)
: base(owner) {
this.owner = owner;
}
///
/// [To be supplied.]
///
public override void Add(Control value) {
if (!(value is TabPage)) {
throw new ArgumentException(SR.GetString(SR.TabControlInvalidTabPageType, value.GetType().Name));
}
TabPage tabPage = (TabPage)value;
// 247078 : See InsertingItem property
if (!owner.InsertingItem)
{
if (owner.IsHandleCreated) {
owner.AddTabPage(tabPage, tabPage.GetTCITEM());
}
else {
owner.Insert(owner.TabCount, tabPage);
}
}
base.Add(tabPage);
tabPage.Visible = false;
// Without this check, we force handle creation on the tabcontrol
// which is not good at all of there are any OCXs on it.
//
if (owner.IsHandleCreated) {
tabPage.Bounds = owner.DisplayRectangle;
}
// site the tabPage if necessary.
ISite site = owner.Site;
if (site != null) {
ISite siteTab = tabPage.Site;
if (siteTab == null) {
IContainer container = site.Container;
if (container != null)
{
container.Add(tabPage);
}
}
}
owner.ApplyItemSize();
owner.UpdateTabSelection(false);
}
///
/// [To be supplied.]
///
public override void Remove(Control value) {
base.Remove(value);
if (!(value is TabPage)) {
return;
}
int index = owner.FindTabPage((TabPage)value);
int curSelectedIndex = owner.SelectedIndex;
if (index != -1) {
owner.RemoveTabPage(index);
if (index == curSelectedIndex)
{
owner.SelectedIndex = 0; //Always select the first tabPage is the Selected TabPage is removed.
}
}
owner.UpdateTabSelection(false);
}
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- OpacityConverter.cs
- ChildDocumentBlock.cs
- ConfigurationLoader.cs
- OdbcConnectionFactory.cs
- FormsAuthenticationEventArgs.cs
- DeferredReference.cs
- FormsAuthenticationEventArgs.cs
- CodeDomLoader.cs
- ProtectedConfigurationSection.cs
- DispatcherFrame.cs
- AppDomainAttributes.cs
- XmlSchemaCollection.cs
- SafeProcessHandle.cs
- WebHttpSecurityModeHelper.cs
- RectangleHotSpot.cs
- HttpApplicationFactory.cs
- HtmlElementEventArgs.cs
- XomlDesignerLoader.cs
- StylusTouchDevice.cs
- AppDomainResourcePerfCounters.cs
- HyperLinkStyle.cs
- ProgressChangedEventArgs.cs
- IntPtr.cs
- Socket.cs
- Table.cs
- StrokeIntersection.cs
- Error.cs
- XmlTypeAttribute.cs
- StructuredTypeEmitter.cs
- CodeComment.cs
- TypefaceCollection.cs
- EncryptedPackage.cs
- DataGridTablesFactory.cs
- ImplicitInputBrush.cs
- ObjectReferenceStack.cs
- TransformGroup.cs
- Border.cs
- DependencyProperty.cs
- FloaterParaClient.cs
- ModuleBuilder.cs
- CodeTypeConstructor.cs
- XmlElementAttribute.cs
- Keyboard.cs
- FormViewInsertEventArgs.cs
- OrderByLifter.cs
- SchemaMapping.cs
- NameNode.cs
- DataGridView.cs
- SmtpMail.cs
- ErrorWrapper.cs
- TransformProviderWrapper.cs
- TableSectionStyle.cs
- Assert.cs
- EntitySqlQueryState.cs
- ToolBarTray.cs
- _PooledStream.cs
- WindowsEditBoxRange.cs
- XmlIlTypeHelper.cs
- GridViewPageEventArgs.cs
- SequentialOutput.cs
- ExpressionEvaluator.cs
- WebZoneDesigner.cs
- ServiceObjectContainer.cs
- followingquery.cs
- SiteMapSection.cs
- WindowCollection.cs
- TextSchema.cs
- RuntimeArgument.cs
- SchemaImporterExtension.cs
- Inflater.cs
- XPathExpr.cs
- ConnectionStringSettingsCollection.cs
- XmlSerializerAssemblyAttribute.cs
- FlowPanelDesigner.cs
- QueueProcessor.cs
- ClientFormsAuthenticationCredentials.cs
- StringSource.cs
- FixedSOMContainer.cs
- ProfileSettingsCollection.cs
- BaseValidator.cs
- TargetParameterCountException.cs
- ContractValidationHelper.cs
- TypeToken.cs
- DBCommandBuilder.cs
- AstNode.cs
- CodeSubDirectory.cs
- InputMethod.cs
- BaseParagraph.cs
- ComponentConverter.cs
- EntityViewGenerationAttribute.cs
- FixedTextBuilder.cs
- CrossAppDomainChannel.cs
- PackagePartCollection.cs
- NativeMethods.cs
- KnownIds.cs
- TextServicesCompartmentEventSink.cs
- DataMemberConverter.cs
- MenuItemAutomationPeer.cs
- KeyValuePairs.cs
- _AutoWebProxyScriptHelper.cs