ToolWindow Class

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

public ToolWindow()

Remarks

For internal use only. Please use the other constructors.

public ToolWindow(DockManager dockManager, string key, string text, Image image, Control childControl)

Parameter	Type	Description
dockManager	DockManager	The DockManager that is managing the dock object.
key	string	A string-based key that identifies an object within its parent collection.
text	string	The text that is displayed in tabs for the tool window.
image	Image	The Image displayed for the tool window.
childControl	Control	The child Control to fill the tool window. This value may be null.

public ToolWindow(DockManager dockManager, string key, string text, int imageIndex, Control childControl)

Parameter	Type	Description
dockManager	DockManager	The DockManager that is managing the dock object.
key	string	A string-based key that identifies an object within its parent collection.
text	string	The text that is displayed in tabs for the tool window.
imageIndex	int	The index of an Image within an ImageList, that is displayed for the tool window.
childControl	Control	The child Control to fill the tool window. This value may be null.

[Browsable(false)]
public AutoHideContainer AutoHideContainer { get; }

Property Value

AutoHideContainer:

The AutoHideContainer that contains the dock object.

public Size AutoHideSize { get; set; }

Property Value

Size:

The size of the tool window when it is in an auto-hide state.

public DefaultableBoolean CanAttach { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be attached to another tool window.

Remarks

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

public DefaultableBoolean CanAutoHide { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be placed in auto-hide mode.

Remarks

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

public DefaultableBoolean CanBecomeDocument { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be placed in a document state.

Remarks

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

public DefaultableBoolean CanDockHostBottom { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be docked to the bottom of the host container control.

Remarks

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

public DefaultableBoolean CanDockHostLeft { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be docked to the left of the host container control.

Remarks

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

public DefaultableBoolean CanDockHostRight { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be docked to the right of the host container control.

Remarks

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

public DefaultableBoolean CanDockHostTop { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be docked to the top of the host container control.

Remarks

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

public DefaultableBoolean CanDrag { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be dragged to another location.

Remarks

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

public DefaultableBoolean CanFloat { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be contained in a floating window.

Remarks

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

public DefaultableBoolean CanResize { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the tool window may be resized when in a floating state.

Remarks

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

[Browsable(false)]
public override DockManager DockManager { get; set; }

Property Value

DockManager:

The DockManager that is managing the dock object.

[Browsable(false)]
public override DockObjectType DockObjectType { get; }

Property Value

DockObjectType:

A DockObjectType specifying the type of dock object.

public Size DockedSize { get; set; }

Property Value

Size:

The size of the tool window when it is in a docked state.

public Point FloatingLocation { get; set; }

Property Value

Point:

The location of the tool window when it is in a floating state.

Remarks

Setting this property at run-time will move the tool window if it is floating.

public Size FloatingSize { get; set; }

Property Value

Size:

The size of the tool window when it is in a floating state.

Remarks

Setting this property at run-time will resize the tool window if it is floating.

public DefaultableBoolean HasOptions { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean indicating whether the tool window has more options available.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global DockManager setting. If this value resolves to true then the tool window will display a drop-down menu button.

public DefaultableBoolean HasTitleBar { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean indicating whether the tool window displays a title bar when docked.

Remarks

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

[Browsable(false)]
public ToolWindowState State { get; set; }

Property Value

ToolWindowState:

The ToolWindowState of the tool window.

[Browsable(false)]
public override TabbedMdiContainer TabbedMdiContainer { get; }

Property Value

TabbedMdiContainer:

The TabbedMdiContainer that contains the dock object.

[Browsable(false)]
public ToolWindowContainer ToolWindowContainer { get; }

Property Value

ToolWindowContainer:

The ToolWindowContainer that contains the dock object.

public override void Activate(bool focus)

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

public void AutoHide()

public void AutoHide(Sides side)

Parameter	Type	Description
side	Sides	A Sides indicating the host side upon which to auto-hide.

public override void Close(TabbedMdiWindowCloseReason reason)

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

protected override void Dispose(bool disposing)

Parameter	Type	Description
disposing	bool	Whether the object is being disposed.

public void DockTo(IDockObject targetDockObject, DockOperationType dockOperationType)

Parameter	Type	Description
targetDockObject	IDockObject	The target dock object.
dockOperationType	DockOperationType	A DockOperationType indicating the type of dock operation to perform.

public override void DpiScaleChanged(SizeF scaleFactor)

Parameter	Type	Description
scaleFactor	SizeF	The new scale factor where Width is applied to the x-axis, and Height is applied to the y-axis.

See Also

• DpiScaleFactor

public override 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 override 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 override 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.

protected override void OnLayout(LayoutEventArgs e)

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

protected override bool ProcessCmdKey(ref Message m, Keys keyData)

Parameter	Type	Description
m	Message	The message to process.
keyData	Keys	One of the Keys values that represents the key to process.

Returns

bool:

true if the key was processed by the control; otherwise, false.

public virtual void ResetAutoHideSize()

public virtual void ResetDockedSize()

public virtual void ResetFloatingLocation()

public virtual void ResetFloatingSize()

public virtual bool ShouldSerializeAutoHideSize()

Returns

bool:

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

public virtual bool ShouldSerializeDockedSize()

Returns

bool:

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

public virtual bool ShouldSerializeFloatingLocation()

Returns

bool:

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

public virtual bool ShouldSerializeFloatingSize()

Returns

bool:

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

public override string ToString()

Returns

string:

A string whose value represents this object.

public void Undock()

protected override void UpdateUI()