ToolWindowContainer Class
Represents a dock container that can hold tool windows.
public class ToolWindowContainer : DockContainer, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IDockObject- Inheritance:
- object MarshalByRefObject Component Control ScrollableControl UIControl DockContainer object
Constructors
ToolWindowContainer()
Initializes an instance of the class.
public ToolWindowContainer()Properties
DisplayRectangle
Gets the rectangle that represents the virtual display area of the control.
public override Rectangle DisplayRectangle { get; }Property Value
DockObjectType
A DockObjectType specifying the type of dock object.
SelectedToolWindow
The selected ToolWindow.
[Browsable(false)]
public override ToolWindow? SelectedToolWindow { get; set; }Property Value
Remarks
This method may only be called if the DockObjectType is ToolWindowContainer or AutoHideContainer.
ToolWindows
The collection of child ToolWindow controls.
[Browsable(false)]
public override ToolWindowCollection ToolWindows { get; }Property Value
Methods
ArrangeOverride(Size)
Positions child elements and determines an arrange size.
protected override Size ArrangeOverride(Size finalSize)| Parameter | Type | Description |
|---|---|---|
| finalSize | Size | The final area within the parent that this element should use to arrange itself and its children. |
Returns
- Size:
The actual size used.
Remarks
Element authors should override this method, call Arrange(Rectangle) on each visible child element and position each child element. It is required that a parent element calls Arrange(Rectangle) on each child or they won't be rendered.
AutoHide()
Auto-hides the tool windows in the ToolWindowContainer.
public void AutoHide()Close()
Closes all the tool windows in the DockContainer.
public override void Close()Remarks
This method may only be called if the DockObjectType is ToolWindowContainer or AutoHideContainer.
ContainsToolWindow(string[])
Returns whether the container or one of its children contains a ToolWindow with any of the specified GUIDs.
protected override bool ContainsToolWindow(string[] guids)| Parameter | Type | Description |
|---|---|---|
| guids | string[] | The array of GUIDs. |
Returns
- bool:
trueif the container or one of its children contains a ToolWindow with any of the specified GUIDs; otherwise,false.
CreateControlsInstance()
Creates a new instance of the control collection for the control.
protected override Control.ControlCollection CreateControlsInstance()Returns
- Control.ControlCollection:
A new instance of Control.ControlCollection assigned to the control.
GetToolWindowCount()
Returns the number of ToolWindow objects within the container or its child controls.
HitTestForDock(Point)
Hits tests a Point to see if a dock should occur.
protected override DockStyle HitTestForDock(Point point)| Parameter | Type | Description |
|---|---|---|
| point | Point | The Point to test. |
Returns
InvalidateTitleBar()
Invalidates the title bar.
public void InvalidateTitleBar()MeasureOverride(Graphics?, Size)
Measures the size in layout required for child elements and determines a size for the element itself.
protected override Size MeasureOverride(Graphics? g, Size availableSize)| Parameter | Type | Description |
|---|---|---|
| g | Graphics | The Graphics object to use for measurement. |
| availableSize | Size | The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available. |
Returns
- Size:
The size that this element determines it needs during layout, based on its calculations of child element sizes.
Remarks
Element authors should override this method, call Measure(Graphics?, Size) on each visible child element and determine the total size required.
ProcessCmdKey(ref Message, Keys)
Processes a command key.
protected override bool ProcessCmdKey(ref Message m, Keys keyData)| Parameter | Type | Description |
|---|---|---|
| m | Message | |
| keyData | Keys | One of the Keys values that represents the key to process. |
Returns
- bool:
trueif the character was processed by the control; otherwise,false.
ToString()
Returns the string representation of this object.
Undock()
Undocks the DockContainer.
public override void Undock()Remarks
This method may only be called if the DockObjectType is ToolWindowContainer or AutoHideContainer.
UpdateImageList()
Updates the ImageList used with the container.
protected override void UpdateImageList()UpdateTabStrip()
Updates the TabStrip used within the container.
protected override void UpdateTabStrip()UpdateTitleBar()
Updates the title bar.
protected override void UpdateTitleBar()Inherited Members
- DockContainer.Dispose(bool)
- DockContainer.CreateChildren()
- DockContainer.OnDockChanged(EventArgs)
- DockContainer.OnEnter(EventArgs)
- DockContainer.OnLeave(EventArgs)
- DockContainer.OnRender(PaintEventArgs)
- DockContainer.UpdateLayout()
- DockContainer.DockManager
- DockContainer.RootDock
- UIControl.AddPendingGraphicsInversion(Rectangle)
- UIControl.AddPendingScrollOperation(Rectangle, Orientation, int)
- UIControl.AddPendingScrollOperation(Rectangle, int, int)
- UIControl.AddToInvalidatedRegion()
- UIControl.AddToInvalidatedRegion(Rectangle)
- UIControl.Arrange(Rectangle)
- UIControl.ContainsLocation(Point)
- UIControl.DpiScaleChanged(SizeF)
- UIControl.GetCursor(Point)
- UIControl.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIControl.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIControl.InvalidateArrange()
- UIControl.InvalidateMeasure()
- UIControl.Measure(Graphics, Size)
- UIControl.OnClick(EventArgs)
- UIControl.OnDoubleClick(EventArgs)
- UIControl.OnDpiChangedAfterParent(EventArgs)
- UIControl.OnHandleCreated(EventArgs)
- UIControl.OnLayout(LayoutEventArgs)
- UIControl.OnLocationChanged(EventArgs)
- UIControl.OnMouseCaptureChanged(EventArgs)
- UIControl.OnMouseDown(MouseEventArgs)
- UIControl.OnMouseEnter(EventArgs)
- UIControl.OnMouseHover(EventArgs)
- UIControl.OnMouseLeave(EventArgs)
- UIControl.OnMouseMove(MouseEventArgs)
- UIControl.OnMouseUp(MouseEventArgs)
- UIControl.OnMouseWheel(MouseEventArgs)
- UIControl.OnPaint(PaintEventArgs)
- UIControl.OnPaintBackground(PaintEventArgs)
- UIControl.OnParentChanged()
- UIControl.OnParentChanged(EventArgs)
- UIControl.OnRenderChildElements(PaintEventArgs)
- UIControl.OnResize(EventArgs)
- UIControl.OnRightToLeftChanged(EventArgs)
- UIControl.OnVisibleChanged(EventArgs)
- UIControl.Render(PaintEventArgs)
- UIControl.ResetDoubleBufferCanvas(bool)
- UIControl.ResumePainting()
- UIControl.SuspendPainting()
- UIControl.TransformToAncestor(IUIElement)
- UIControl.TransformToDescendant(IUIElement)
- UIControl.UpdateCursor()
- UIControl.UpdateCursor(Point)
- UIControl.ActualHeight
- UIControl.ActualWidth
- UIControl.BackColor
- UIControl.BackgroundImage
- UIControl.CaptureMouseWhenPressed
- UIControl.ClipBounds
- UIControl.DesiredSize
- UIControl.DpiScaleFactor
- UIControl.Font
- UIControl.ForeColor
- UIControl.IsArrangeValid
- UIControl.IsMeasureValid
- UIControl.IsPaintValid
- UIControl.IsRightToLeft
- UIControl.LastMouseUpButton
- UIControl.PaintingSuspended
- UIControl.UseControlGraphicsForMeasure
- UIControl.UseExtendedDoubleBuffering
- MarshalByRefObject.GetLifetimeService()
- MarshalByRefObject.InitializeLifetimeService()
- MarshalByRefObject.MemberwiseClone(bool)
- object.GetType()
- object.MemberwiseClone()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()