Back to all docs
API Reference / Telerik.Windows.Controls.Docking / ToolWindow

Class
ToolWindow

This class represents a tool window.

Definition

Namespace:Telerik.Windows.Controls.Docking

Assembly:Telerik.Windows.Controls.Docking.dll

Syntax:
cs-api-definition
public class ToolWindow : WindowBase, INotifyLayoutChange, IDragAware

Inheritance: objectWindowBaseToolWindow

Implements: IDragAwareINotifyLayoutChange

Inherited Members WindowBase.IsModalPropertyWindowBase.IsOpenPropertyWindowBase.IsResizingPropertyWindowBase.IsDraggingPropertyWindowBase.IsActiveWindowPropertyWindowBase.IsInActiveStatePropertyWindowBase.IsTopmostPropertyWindowBase.CaptionHeightPropertyWindowBase.ResizeBorderPropertyWindowBase.LeftPropertyWindowBase.TopPropertyWindowBase.WindowStatePropertyWindowBase.ResizeModePropertyWindowBase.CanClosePropertyWindowBase.CanMovePropertyWindowBase.SizeToContentPropertyWindowBase.HideMinimizeButtonPropertyWindowBase.HideMaximizeButtonPropertyWindowBase.CornerRadiusPropertyWindowBase.Close()WindowBase.GetZIndex()WindowBase.BringToFront()WindowBase.GetNormalSizeAndPosition()WindowBase.ShouldActivateOnShow()WindowBase.ShouldShowInTaskSwitcher()WindowBase.ShouldActivate()WindowBase.ChangeVisualState()WindowBase.ShowWindow(bool)WindowBase.OnLocationChanged(EventArgs)WindowBase.OnWindowStateChanged(EventArgs)WindowBase.OnHostCreated(HostWindowCreatedEventArgs)WindowBase.OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)WindowBase.GetApplicationSize()WindowBase.OnLayoutChangeEnded()WindowBase.OnLayoutChangeStarted()WindowBase.CloseWithoutEventsAndAnimations()WindowBase.OnCloseAnimationFinished()WindowBase.OnShowAnimationFinished()WindowBase.OnRootVisualSizeChanged()WindowBase.GetWindowStartupLocation()WindowBase.OnDeactivated(EventArgs)WindowBase.ShouldSystemMenuOnRightClick()WindowBase.IsModalWindowBase.IsOpenWindowBase.IsTopmostWindowBase.CaptionHeightWindowBase.ResizeBorderWindowBase.LeftWindowBase.TopWindowBase.IsResizingWindowBase.IsDraggingWindowBase.IsLayoutChangingWindowBase.WindowStateWindowBase.ResizeModeWindowBase.CanCloseWindowBase.CanMoveWindowBase.IsActiveWindowWindowBase.IsInActiveStateWindowBase.CornerRadiusWindowBase.SizeToContentWindowBase.HideMaximizeButtonWindowBase.HideMinimizeButtonWindowBase.OwnerWindowBase.ActivatedWindowBase.DeactivatedWindowBase.LayoutChangeEndedWindowBase.LayoutChangeStartedWindowBase.LocationChangedWindowBase.WindowStateChanged

Constructors

ToolWindow()

Initializes a new instance of the ToolWindow class.

Declaration

cs-api-definition
public ToolWindow()

Fields

IsSelectedProperty

Identifies the IsSelected dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsSelectedProperty

Field Value

DependencyProperty

Properties

IsSelected

Gets or sets a value indicating whether this pane is selected.

Declaration

cs-api-definition
public bool IsSelected { get; set; }

Property Value

bool

True if this pane is active; otherwise, false.

Methods

ChangeVisualState(bool)

Updates the visual state of the control.

Declaration

cs-api-definition
protected override void ChangeVisualState(bool useTransitions)

Parameters

useTransitions

bool

Indicates whether transitions should be used.

Overrides WindowBase.ChangeVisualState(bool)

CheckCanClose()

Checks whether the window can be closed. This method doesn't consider the CanClose property, but checked for some other kind of constraints.

Declaration

cs-api-definition
protected override bool CheckCanClose()

Returns

bool

True if the window can be changed; false otherwise.

Overrides WindowBase.CheckCanClose()

GetWindowOwner()

Declaration

cs-api-definition
protected override ContentControl GetWindowOwner()

Returns

ContentControl

Overrides WindowBase.GetWindowOwner()

GetWindowOwnerHandle()

Declaration

cs-api-definition
protected override nint GetWindowOwnerHandle()

Returns

nint

Overrides WindowBase.GetWindowOwnerHandle()

OnActivated(EventArgs)

Raises the event. This method is called when the window is activated.

Declaration

cs-api-definition
protected override void OnActivated(EventArgs e)

Parameters

e

EventArgs

The EventArgs instance containing the event data.

Overrides WindowBase.OnActivated(EventArgs)

OnClosed()

Declaration

cs-api-definition
protected override void OnClosed()

Overrides WindowBase.OnClosed()

OnClosing()

Declaration

cs-api-definition
protected override bool OnClosing()

Returns

bool

Overrides WindowBase.OnClosing()

OnContentChanged(object, object)

Called when the value of the property changes.

Declaration

cs-api-definition
protected override void OnContentChanged(object oldContent, object newContent)

Parameters

oldContent

object

The old value of the property.

newContent

object

The new value of the property.

OnCreateAutomationPeer()

Create the automation peer for this class.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

Overrides WindowBase.OnCreateAutomationPeer()

OnDragDelta(Point, Rect, Rect, bool)

Declaration

cs-api-definition
protected override Rect OnDragDelta(Point globalMousePosition, Rect initialRect, Rect destinationRect, bool isResize)

Parameters

globalMousePosition

Point

initialRect

Rect

destinationRect

Rect

isResize

bool

Returns

Rect

Overrides WindowBase.OnDragDelta(Point, Rect, Rect, bool)

OnDragEnd(Point, bool, bool)

Declaration

cs-api-definition
protected override void OnDragEnd(Point globalMousePosition, bool isCancel, bool isResize)

Parameters

globalMousePosition

Point

isCancel

bool

isResize

bool

Overrides WindowBase.OnDragEnd(Point, bool, bool)

OnDragStart(Point, bool)

Declaration

cs-api-definition
protected override void OnDragStart(Point globalMousePosition, bool isResize)

Parameters

globalMousePosition

Point

isResize

bool

Overrides WindowBase.OnDragStart(Point, bool)

OnGotFocus(RoutedEventArgs)

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

OnInitialized(EventArgs)

Raises the event and sets from the active theme.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnKeyDown(KeyEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnKeyDown(KeyEventArgs e)

Parameters

e

KeyEventArgs

The data for the event.

OnLayoutChangeEnded(EventArgs)

Raises the LayoutChangeEnded event of the RadDocking and the WindowBase.

Declaration

cs-api-definition
protected override void OnLayoutChangeEnded(EventArgs args)

Parameters

args

EventArgs

The System.EventArgs instance containing the event data.

Overrides WindowBase.OnLayoutChangeEnded(EventArgs)

OnLayoutChangeStarted(EventArgs)

Raises the LayoutChangeStarted event of the RadDocking and the WindowBase.

Declaration

cs-api-definition
protected override void OnLayoutChangeStarted(EventArgs args)

Parameters

args

EventArgs

The System.EventArgs instance containing the event data.

Overrides WindowBase.OnLayoutChangeStarted(EventArgs)

OnRightMouseButtonUp()

Declaration

cs-api-definition
protected override void OnRightMouseButtonUp()

Overrides WindowBase.OnRightMouseButtonUp()

ResetTheme()

Resets the theme.

Declaration

cs-api-definition
public void ResetTheme()

ShouldFocusOnActivate()

Declaration

cs-api-definition
protected override bool ShouldFocusOnActivate()

Returns

bool

Overrides WindowBase.ShouldFocusOnActivate()

Extension Methods

DockingLogicalTreeHelper.GetParentDocking(ToolWindow)
In this article
DefinitionConstructorsToolWindow()FieldsIsSelectedPropertyPropertiesIsSelectedMethodsChangeVisualState(bool)CheckCanClose()GetWindowOwner()GetWindowOwnerHandle()OnActivated(EventArgs)OnClosed()OnClosing()OnContentChanged(object, object)OnCreateAutomationPeer()OnDragDelta(Point, Rect, Rect, bool)OnDragEnd(Point, bool, bool)OnDragStart(Point, bool)OnGotFocus(RoutedEventArgs)OnInitialized(EventArgs)OnKeyDown(KeyEventArgs)OnLayoutChangeEnded(EventArgs)OnLayoutChangeStarted(EventArgs)OnRightMouseButtonUp()ResetTheme()ShouldFocusOnActivate()Extension Methods
Not finding the help you need?
Contact Support