TabbedMdiWindow Class

public abstract class TabbedMdiWindow : UIContainerControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IDockObject, IImageListProvider

protected TabbedMdiWindow(TabbedMdiWindowCreationMethod creationMethod)

Parameter	Type	Description
creationMethod	TabbedMdiWindowCreationMethod	A TabbedMdiWindowCreationMethod that indicates how the window was created.

[Browsable(false)]
public bool Active { get; }

Property Value

bool:

true if the window is active; otherwise, false.

Remarks

An active window is one which is active in the application but not necessarily visible.

If a window is attached to another window in tabbed MDI and they have a TabStrip control determining which one is displayed, both are considered active since they are currently available to be used but only the displayed window is flagged as visible.

public BackgroundFill BackgroundFill { get; set; }

Property Value

BackgroundFill:

The BackgroundFill for a window.

public SimpleBorder Border { get; set; }

Property Value

SimpleBorder:

The SimpleBorder for a window.

public DefaultableBoolean CanClose { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the window may be closed.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global DockManager setting.

public Image ContextImage { get; set; }

Property Value

Image:

The context Image displayed for the window. The default value is null.

[Browsable(false)]
public TabbedMdiWindowCreationMethod CreationMethod { get; }

Property Value

TabbedMdiWindowCreationMethod:

A TabbedMdiWindowCreationMethod identifying how the window was created.

protected override Size DefaultSize { get; }

Property Value

Size:

The default Size of the control.

public override Rectangle DisplayRectangle { get; }

Property Value

Rectangle:

A Rectangle that represents the display area of the control.

public abstract DockManager DockManager { get; set; }

Property Value

DockManager:

The DockManager that is managing the dock object.

public abstract DockObjectType DockObjectType { get; }

Property Value

DockObjectType:

A DockObjectType specifying the type of dock object.

public Image Image { get; set; }

Property Value

Image:

The Image displayed for the window. The default value is null.

[ImageIndex]
[TypeConverter(typeof(ImageIndexConverter))]
public int ImageIndex { get; set; }

Property Value

int:

The index of an image within an ImageList that is displayed for the window. The default value is -1.

[Browsable(false)]
public bool IsInitialized { get; }

Property Value

bool:

true if the window has been initialized; otherwise, false.

Remarks

A window has been initialized if the WindowInitializing event has been raised for the window. This event fires before the first time the window is activated, allowing for lazy initialization of windows.

public string Key { get; set; }

Property Value

string:

A string-based key that identifies an object within its parent collection.

public Rectangle StandardMdiBounds { get; set; }

Property Value

Rectangle:

The bounds of the standard MDI form.

public abstract TabbedMdiContainer TabbedMdiContainer { get; }

Property Value

TabbedMdiContainer:

The TabbedMdiContainer that contains the dock object.

[Browsable(true)]
public override string Text { get; set; }

Property Value

string:

The text that is displayed in tabs for the window. The default value is null.

public string TitleBarText { get; set; }

Property Value

string:

The text that is displayed in title bars for the window. The default value is null.

public string ToolTipText { get; set; }

Property Value

string:

The text that is displayed on a tool tip for the window. The default value is null.

protected override bool UseExtendedDoubleBuffering { get; }

Property Value

bool:

true if extended double buffering should be used; otherwise, false.

public bool Visible { get; set; }

Property Value

bool

public void Activate()

public abstract void Activate(bool focus)

Parameter	Type	Description
focus	bool	Whether to set focus to the window.

public void Close()

public abstract void Close(TabbedMdiWindowCloseReason reason)

Parameter	Type	Description
reason	TabbedMdiWindowCloseReason	A TabbedMdiWindowCloseReason that specifies why the window was closed.

public Image GetImage()

Returns

Image:

The Image associated with the window.

Remarks

If an image has been set to the Image property, that will be returned. Otherwise, the ImageIndex property will be used to find an image in a parent ImageList.

public virtual bool IsMenuItemChecked(TabbedMdiWindowContextMenuItemType menuItemType)

Parameter	Type	Description
menuItemType	TabbedMdiWindowContextMenuItemType	A TabbedMdiWindowContextMenuItemType specifying the type of menu item to examine.

Returns

bool:

true if the menu item type should be checked; otherwise, false.

public virtual bool IsMenuItemEnabled(TabbedMdiWindowContextMenuItemType menuItemType)

Parameter	Type	Description
menuItemType	TabbedMdiWindowContextMenuItemType	A TabbedMdiWindowContextMenuItemType specifying the type of menu item to examine.

Returns

bool:

true if the menu item type should be enabled; otherwise, false.

public virtual bool IsMenuItemVisible(TabbedMdiWindowContextMenuItemType menuItemType)

Parameter	Type	Description
menuItemType	TabbedMdiWindowContextMenuItemType	A TabbedMdiWindowContextMenuItemType specifying the type of menu item to examine.

Returns

bool:

true if the menu item type should be visible; otherwise, false.

public void MoveToNewHorizontalTabbedMdiContainer()

Remarks

This method will throw an exception if the window is not currently an active MDI tabbed document.

public void MoveToNewVerticalTabbedMdiContainer()

Remarks

This method will throw an exception if the window is not currently an active MDI tabbed document.

public void MoveToNextTabbedMdiContainer()

Remarks

This method will throw an exception if the window is not currently an active MDI tabbed document.

public void MoveToPositionInTabbedMdiContainer(int index)

Parameter	Type	Description
index	int	The target index.

Remarks

This method will throw an exception if the window is not currently an active MDI tabbed document.

public void MoveToPreviousTabbedMdiContainer()

Remarks

This method will throw an exception if the window is not currently an active MDI tabbed document.

protected virtual void OnActivated(TabbedMdiWindowEventArgs e)

Parameter	Type	Description
e	TabbedMdiWindowEventArgs	A TabbedMdiWindowEventArgs that contains the event data.

protected virtual void OnActivating(TabbedMdiWindowEventArgs e)

Parameter	Type	Description
e	TabbedMdiWindowEventArgs	A TabbedMdiWindowEventArgs that contains the event data.

protected virtual void OnClosed(TabbedMdiWindowEventArgs e)

Parameter	Type	Description
e	TabbedMdiWindowEventArgs	A TabbedMdiWindowEventArgs that contains the event data.

protected virtual void OnClosing(TabbedMdiWindowClosingEventArgs e)

Parameter	Type	Description
e	TabbedMdiWindowClosingEventArgs	A TabbedMdiWindowClosingEventArgs that contains the event data.

protected override void OnEnter(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnInitializing(TabbedMdiWindowEventArgs e)

Parameter	Type	Description
e	TabbedMdiWindowEventArgs	A TabbedMdiWindowEventArgs that contains the event data.

protected override void OnLeave(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnRender(PaintEventArgs e)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.

protected virtual void OnStateChanged(TabbedMdiWindowEventArgs e)

Parameter	Type	Description
e	TabbedMdiWindowEventArgs	A TabbedMdiWindowEventArgs that contains the event data.

public virtual void ResetBackgroundFill()

public virtual void ResetBorder()

public virtual void ResetStandardMdiBounds()

public virtual bool ShouldSerializeBackgroundFill()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeBorder()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeStandardMdiBounds()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

protected virtual void UpdateUI()

protected override void WndProc(ref Message m)

Parameter	Type	Description
m	Message	The Windows Message to process.

public event TabbedMdiWindowEventHandler Activated

Event Type

TabbedMdiWindowEventHandler

public event TabbedMdiWindowEventHandler Activating

Event Type

TabbedMdiWindowEventHandler

public event TabbedMdiWindowEventHandler Closed

Event Type

TabbedMdiWindowEventHandler

public event TabbedMdiWindowClosingEventHandler Closing

Event Type

TabbedMdiWindowClosingEventHandler

public event TabbedMdiWindowEventHandler Initializing

Event Type

TabbedMdiWindowEventHandler

Remarks

After this event is raised for the window, the window's IsInitialized property is set to true. This event is only called once during the lifetime of the window.

public event TabbedMdiWindowEventHandler StateChanged

Event Type

TabbedMdiWindowEventHandler