Click or drag to resize
Telerik.WinControls.UI.Docking Namespace
Classes
  ClassDescription
Public classAutoHideGroup
A logical structure that treats a number of DockWindow instances as group that is auto-hidden/restored at once.
Public classAutoHideGroupCollection
A collection that containes instances of type AutoHideGroup.
Public classAutoHidePopup
Represents a popup Form that is used to display auto-hidden windows.
Public classAutoHideTabStrip
A predefined ToolTabStrip instance that resides within an AutoHidePopup and is used to display auto-hidden dock windows.
Public classAutoHideTabStripElement
A predefined RadPageViewStripElement that holds the associated RadPageViewStripItem for each auto-hidden DockWindow.
Public classAutoHideTransaction
Implements a transaction that is associated with a successful AutoHideWindow request.
Public classAutoHideWindowDisplayingEventArgs
Encapsulates the data associated with the AutoHideWindowDisplaying event.
Public classCloseTransaction
Implements a transaction that is associated with a successful CloseWindow request.
Public classContextMenuDisplayingEventArgs
Encapsulates the arguments, associated with
Public classContextMenuItemClickEventArgs
Public classContextMenuService
Provides methods for displaying a context menu for a document or tool window.
Public classControlTreeChangedEventArgs
Public classDesignTimeRadDockComponentFactory
Public classDockAutoHideSerializationContainer
Represents a logical container of TabStrip instances that contain RadDock windows with "auto-hide" state
Public classDockHelper
A helper class that exposes common methods, used across a docking framework.
Public classDockingGuideImage
Encapsulates a docking guide image. Includes additional settings allowing for proper Docking Guides visualization.
Public classDockingGuideImageElement
Public classDockingGuidesControl
Public classDockingGuidesElement
Public classDockingGuidesTemplate
Defines settings for the Docking Guides used by the DragDropService.
Public classDockPopupForm
Base class for all Popup Forms that are used with a RadDock instance. Such Forms are FloatingWindow and AutoHidePopup classes.
Public classDockStateChangingEventArgs
Represents the arguments associated with a DockStateChanging event.
Public classDockTabStrip
Base class for a TabStripPanel instance that resides on a RadDock scene.
Public classDockTabStripNeededEventArgs
Represents the arguments associated with a DockTabStripNeeded event.
Public classDockWindow
Base class for all tool and document windows available per RadDock instance. Implements the IDockWindow interface.
Public classDockWindowCancelEventArgs
Represents the arguments associated with all cancelable events, associated with a DockWindow instance.
Public classDockWindowCollection
A collection that stores all DockWindow instances available per RadDock basis.
Public classDockWindowEventArgs
Represents the arguments associated with all DockWindow events.
Public classDockWindowPlaceholder
A serializable placeholder, used primarily during RadDock's serialization process.
Public classDockWindowSerializableCollection
A collection, which supports serialization of the contained DockWindow instances.
Public classDockWindowSnapshotEventArgs
Represents the arguments associated with a QuickNavigatorSnapshotNeeded event.
Public classDockWindowTransaction
Implements a transaction that is associated with a DockWindow request.
Public classDocumentContainer
Represents a special container, which is used to store document tab strips.
Public classDocumentManager
Manages the document windows in a RadDock instance. Supports additional collection of all DockWindow instances that reside within a DocumentTabStrip. The collection's sort order depends on the activation precedence. Provides methods for navigating to next and previous document. Keeps track of the currently active window.
Public classDocumentTabStrip
A predefined DockTabStrip instance that resides within a DocumentContainer and hosts documents. For a document is considered a DocumentWindow instance or a ToolWindow, which has a TabbedDocument DockState.
Public classDocumentWindow
Implements a special DockWindow that may reside within a document container only.
Public classDragDropDockPositionEventArgs
Represents the arguments, associated with a PreviewDockPosition event.
Public classDragDropHitTestEventArgs
Represents the arguments, associated with a PreviewDropTarget event.
Public classDragDropService
Encapsulates the core drag-and-drop functionality for a RadDock instance. What RadDock does is to start and stop the service when drag operation is instanciated.
Public classDragDropTargetEventArgs
Represents the arguments, associated with a PreviewDropTarget event.
Public classDragDropTransaction
Implements a transaction that is associated with a successful drag-and-drop operation.
Public classFloatingWindow
Represents a popup form that is used to host floating DockWindow instances.
Public classFloatingWindowCollection
An ICollection implementation to store all floating windows associated with a RadDock instance.
Public classFloatingWindowEventArgs
Encapsulates the data, associated with the FloatingWindowCreated event.
Public classFloatingWindowList
A serializable collection of FloatingWindow instances.
Public classFloatTransaction
Implements a transaction that is associated with a FloatWindow operation.
Public classGuidToNameMapping
Maps a globally unique identifier (Guid) to a human-readable name. Used by the new RadDock framework when converting an old DockingManager framework to its new counterpart.
Public classGuidToNameMappingCollection
A strongly-typed collection of GuidToNameMapping instances.
Public classHostWindow
Represents a special type of DockWindow, which is used internally by RadDock to wrap custom controls as part of the docking framework.
Public classPerformDockTransaction
Implements a base transaction that is associated with a successful DockWindow request. Concrete inheritors are DockWindowTransaction and DragDropTransaction.
Public classPredefinedCommandNames
Contains the names of all predefined commands available in a RadDock instance.
Public classPredefinedDockingGuidesTemplate
Represents a DockingGuidesTemplate which uses embedded images and may not be modified by the user.
Public classQuickNavigator
Represents a predefined RadControl instance which hosts a QuickNavigatorElement.
Public classQuickNavigatorElement
Represents the RadElement structure that is hosted on a DockQuickNavigator control. The element has the following structure: 1. Header 2. Dock Layout with three elements: - Tool Window List - Document List - Preview 3. Footer
Public classQuickNavigatorList
Represents a dock layout panel, which hosts a header plus a scrollable list with items.
Public classQuickNavigatorListItem
Represents an item that may reside in a QuickNavigator DockWindow list.
Public classQuickNavigatorSettings
Encapsulates all the settings that control the appearance and behavior of the QuickNavigator for a RadDock.
Public classCode exampleRadDock
Represents the major control in the Telerik.WinForms.UI.Docking assembly. Root component for the entire docking framework. Provides highly extensible and completely transparent transaction-based API for managing a set of tool and document windows registered within the docking framework. Mimics the user experience found in Microsoft Visual Studio - dockable panes, tabbed documents, document navigation plus much more.
Examples
A typical scenario of utilizing a docking framework is as follows: Create a new RadDock instance.Create the desired ToolWindow and/or DocumentWindow instances.Register the newly created dock windows with the RadDock using the DockWindow or the AddDocument methods respectively.Add the new RadDock instance to a Form.Display the Form.
Remarks
Although a rare scenario, sometimes the need of nested RadDock instances may emerge. This is fully supported by the RadDock component and unlimited levels of nesting are allowed.
Public classRadDockCommand
Represents base command that is associated with a RadDock instance.
Public classRadDockCommandManager
Manages all the commands registered with a RadDock instance.
Public classRadDockComponentFactory
Public classRadDockObject
Base class for all generic RadDock objects - such as Services, Settings, etc.
Public classRadDockService
Defines base for all services registered with a RadDock instance.
Public classRadDockTransaction
A logical representation of a RadDock operation.
Public classRadDockTransactionCancelEventArgs
Represents the arguments associated with a TransactionCommitting event.
Public classRadDockTransactionEventArgs
Represents the arguments associated with all Transaction related events.
Public classRedockAutoHideState
A predefined RedockState, used by a RedockService to restore an auto-hide state.
Public classRedockFloatingState
A predefined RedockState, used by a RedockService to restore a floating state.
Public classRedockService
Represents a service that allows a DockWindow state to be saved and restored later on.
Public classRedockState
Represents an object that stores information about what was a docking window's previous state.
Public classRedockTransaction
Implements a transaction that is associated with a successful Redock request.
Public classRunTimeRadDockComponentFactory
Public classSelectedTabChangedEventArgs
Public classSelectedTabChangingEventArgs
Public classSerializableFloatingWindow
Represents a serializable version of a FloatingWindow instance.
Public classServiceConstants
Defines the available constants used by a RadDock instance to store its services.
Public classSplitContainerLayoutInfo
Encapsulates the layout information for a layout pass of a RadSplitContainer.
Public classSplitContainerLayoutStrategy
Defines the layout strategy for a RadSplitContainer.
Public classSplitContainerNeededEventArgs
Represents the arguments associated with a DockTabStripNeeded event.
Public classSplitPanelEventArgs
Public classSplitPanelSizeInfo
Encapsulates all size-related properties for a SplitPanel instance residing on a RadSplitContainer.
Public classStateService
Represents a service that is state-based. E.g. it may start, perform some action and stop.
Public classStateServiceStartingEventArgs
Represents the arguments associated with a StateService.Starting event.
Public classStateServiceStoppingEventArgs
Represents the arguments associated with a StateService.Stopping event.
Public classThemedDockingGuidesTemplate
Public classToolTabStrip
A predefined DockTabStrip instance that is used to store ToolWindow instances.
Public classToolWindow
Implements a DockWindow that resides within a ToolTabStrip.
Public classToolWindowCaptionElement
Implements the Caption element in a ToolTabStrip control.
Public classToolWindowCaptionElementStateManager
Structures
  StructureDescription
Public structureDockingGuideHitTest
Contains the hit-test information of a DragDropService.
Interfaces
  InterfaceDescription
Public interfaceIDockingGuideImage
Public interfaceIDockingGuidesTemplate
Public interfaceIDockWindow
Defines the common properties for a RadDock-related object such as DockWindow, FloatingWindow, AutoHidePopup, etc.
Delegates
  DelegateDescription
Public delegateAutoHideWindowDisplayingEventHandler
Defines a method signature to handle AutoHideWindowDisplaying event.
Public delegateContextMenuDisplayingEventHandler
Public delegateContextMenuItemClickEventHandler
Public delegateControlTreeChangedEventHandler
Public delegateDockStateChangingEventHandler
A method template that is used to handle a DockState changing event.
Public delegateDockTabStripNeededEventHandler
A method template used to handle a DockTabStripNeeded event.
Public delegateDockWindowCancelEventHandler
A method template that is used to handle all cancelable events, associated with a DockWindow instance.
Public delegateDockWindowEventHandler
A method template that is used to handle all DockWindow events.
Public delegateDockWindowSnapshotEventHandler
A method template that is used to handle the QuickNavigatorSnapshotNeeded event.
Public delegateDragDropDockPositionEventHandler
Defines method signature to handle a PreviewDockPosition event.
Public delegateDragDropHitTestEventHandler
Defines method signature to handle a PreviewHitTest event.
Public delegateDragDropTargetEventHandler
Defines method signature to handle a PreviewDropTarget event.
Public delegateFloatingWindowEventHandler
Defines a method signature to handle FloatingWindowCreated event.
Public delegateRadDockTransactionCancelEventHandler
A method template that is used to handle a TransactionCommitting event.
Public delegateRadDockTransactionEventHandler
A method template that is used to handle all Transaction related events.
Public delegateSelectedTabChangedEventHandler
Public delegateSelectedTabChangingEventHandler
Public delegateSplitContainerNeededEventHandler
A method template used to handle a DockTabStripNeeded event.
Public delegateSplitPanelEventHandler
Public delegateStateServiceStartingEventHandler
Defines an entry point for methods that can handle events like StateService.Starting one.
Public delegateStateServiceStoppingEventHandler
Defines an entry point for methods that can handle events like StateService.Stopping one.
Enumerations
  EnumerationDescription
Public enumerationActiveDocumentListSortOrder
Defines the possible order of items in the ActiveDocumentList menu, displayed for each DocumentTabStrip.
Public enumerationAllowedDockPosition
Defines the allowed dock positions for a DockWindow.
Public enumerationAllowedDockState
Defines the states, allowed per DockWindow instance.
Public enumerationAutoHideAnimateMode
Defines the possible modes for animating an auto-hidden window.
Public enumerationAutoHideDisplayReason
Defines the possible reasons for displaying an auto-hidden window.
Public enumerationAutoHidePosition
Defines the possible edges for a DockWindow to become auto-hidden.
Public enumerationContextMenuType
Defines the different types of context menus, displayed within a RadDock instance.
Public enumerationControlTreeChangeAction
Defines the possible actions for a ControlTreeChanged event.
Public enumerationDockingGuidesPosition
Defines the position of the docking guides.
Public enumerationDockPosition
Defines the docking position of a DockWindow.
Public enumerationDockState
Defines the possible valid states for IDockWindow instances.
Public enumerationDockTransactionType
Defines the possible transactions in a RadDock instance.
Public enumerationDockType
Defines the possible valid types for IDockable instances.
Public enumerationDockWindowCloseAction
Defines the possible actions to be taken when a CloseWindow request is made.
Public enumerationDockWindowInsertOrder
Defines the possible insertion order when adding new documents.
Public enumerationDocumentCloseActivation
Defines which document should be activated upon closing active document.
Public enumerationDocumentStripButtons
Defines the available buttons for a DockWindow, residing in a DocumentTabStrip instance.
Public enumerationDragDropBehavior
Defines the behavior of a started DragDropService instance.
Public enumerationDragDropContext
Specifies the possible drag-and-drop contexts.
Public enumerationDragDropMode
Defines the supported drag-and-drop modes by a DragDropService.
Public enumerationQuickNavigatorDisplayPosition
Defines the possible start-up positions for a RadDock's QuickNavigator.
Public enumerationRedockTransactionReason
Public enumerationServiceState
Defines the possible states for a RadDockService instance.
Public enumerationSplitPanelSizeMode
Defines the posiible size modes for a split panel residing on a RadSplitContainer.
Public enumerationToolStripCaptionButtons
Defines the visible buttons for a DockWindow, residing in a ToolTabStrip instance.