- dotnet-framework-api
-
dotnet-api
-
C1.Win.Command.8 Assembly
-
C1.Win.Command
-
Classes
- AllowDropEventArgs
- AutoCreatedDockingTabEventArgs
- BeforeSelectWindowEventArgs
- C1Border
- C1Border.BorderTypeConverter
- C1Command
- C1Command.TypeConverter
- C1CommandControl
- C1CommandDock
- C1CommandException
- C1CommandHolder
- C1CommandLink
- C1CommandLinks
- C1CommandMdiList
- C1CommandMenu
- C1Commands
- C1ContextMenu
- C1CustomizerForm
- C1DockingManager
- C1DockingTab
- C1DockingTabPage
- C1DockingTabPages
- C1MainMenu
- C1NewToolbarForm
- C1RadialMenu
- C1SelectMdiChildForm
- C1SelectMdiChildForm.WindowItem
- C1SideCaption
- C1SideCaption.SideCaptionTypeConverter
- C1Stack
- C1ToolBar
- CentralTabMinimumSize
- CheckedChangedEventArgs
- ClickEventArgs
- CommandClickEventArgs
- CommandLinkEventArgs
- CommandStateQueryEventArgs
- ContextInfo
- CustomTooltipDisplayingEventArgs
- CustomizeLinkEventArgs
- CustomizeToolBarEventArgs
- DockingAnchorsEventArgs
- DraggedEventArgs
- DrawArrowEventArgs
- DrawBarEventArgs
- DrawFloatingCaptionEventArgs
- DrawLinkEventArgs
- DrawTabEventArgs
- DropDownEventArgs
- FindTypeByName
- FloatingEventArgs
- FloatingWindowCreatedEventArgs
- LayoutLinkEventArgs
- MeasureFloatingCaptionEventArgs
- MeasureLinkEventArgs
- MeasureTabEventArgs
- Pair
- RadialMenuCommandItem
- RadialMenuItem
- RadialMenuItemBase
- RadialMenuItemCheckEventArgs
- RadialMenuItemClickEventArgs
- RadialMenuItemCollection
- RadialMenuItemUncheckEventArgs
- ResizeEventArgs
- ResizingEventArgs
- SelectedIndexChangingEventArgs
- TabPageCancelEventArgs
- TabPageEventArgs
- TabPageMovedEventArgs
- UIStrings
- UIStringsItemEventArgs
- Enums
- Delegates
-
Classes
- C1.Win.Command.Docking
- C1.Win.Command.Docking.Drawing
- C1.Win.Command.Docking.Style
- C1.Win.Command.RadialMenu
- C1.Win.Command.Styles.RadialMenu
- C1.Win.Command.Styles.RadialMenu.Base
-
C1.Win.Command
- C1.Win.SuperTooltip.8 Assembly
-
C1.Win.Command.8 Assembly
C1.Win.Command.C1DockingTab
C1DockingTab Class
This class implements the familiar tab control interface: several overlaying pages (each of which can contain arbitrary controls) accessible via tabs at the side of the control.
Implements
Namespace: C1.Win.Command
Assembly: C1.Win.Command.8.dll
Syntax
[ToolboxBitmap(typeof(C1DockingTab), "C1DockingTab.png")]
[C1Description("C1DockingTab", "Represents a tab control that provides overlaying pages accessible via tabs.")]
public class C1DockingTab : Control, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, ISupportInitialize, IFontOwner, ISupportSuperTooltipConstructors
| Name | Description |
|---|---|
| C1DockingTab() | Initializes a new instance of the C1DockingTab class. |
Properties
| Name | Description |
|---|---|
| AcceptsCtrlTab | Gets or sets a value indicating whether the control handles Ctrl-Tab and Ctrl-Shift-Tab keys. |
| AlignTabs | Gets or sets the value indicating how tabs are aligned along the side of the page content area. |
| Alignment | Gets or sets the area of the control (top, bottom, left or right) where the tabs are aligned. |
| Animate | Gets or sets a value indicating whether to use animation when showing or hiding the control. |
| AutoHiding | Gets or sets the value indicating whether the pages of the tab control are in auto-hiding mode. |
| BackColor | Gets or sets the background color for the control. |
| BorderStyle | Indicates the border style for the DockingTab. |
| CanAutoHide | Gets or sets a value indicating whether the pages can auto-hide (if both CanAutoHide and ShowCaption are true, a pin icon appears in the caption area). |
| CanCloseTabs | Gets or sets a value indicating whether individual tab pages can be closed by the end user. If CanCloseTabs is true, a close icon appears either in the caption area (if ShowCaption is true), or in the tabs area otherwise. |
| CanMoveTabs | Gets or sets a value indicating whether the end user can rearrange tabs by dragging them around at runtime. |
| CanRenameTabs | Gets or sets a value indicating whether the end user can rename tabs by double clicking on the tab's text. |
| CloseBox | Gets or sets position of close box. |
| CreatorDockingTab | Gets the C1DockingTab which automatically created this instance in response to user actions. |
| DefaultSize | This method is for internal use only. |
| DisplayRectangle | This method is for internal use only. |
| Dock | Gets or sets the docking of the control in the parent container. Can be specified only for controls not parented in a C1CommandDock. |
| DockPreventModifierKey | Gets or sets modifier key which, if pressed, will prevent the floating control from docking when it is moved around at runtime. |
| Floating | Gets the value indicating whether the C1DockingTab is currently floating (runtime-only). |
| HotTrack | Gets or sets a value indicating whether the control's tabs change in appearance when the mouse passes over them. |
| ImageList | Gets or sets the image list used to provide images to show on the control’s tabs. |
| Indent | Gets or sets the indentation of the first tab from the side of the control. |
| ItemSize | Gets or sets the size of the tabs (if empty, the size is calculated automatically based on content). |
| KeepClosedPages | Gets or sets a value indicating whether a tab page closed by the end user should be kept in an internal array (used when a previously saved tabs layout is restored). The default is true. |
| LayoutExclude | List of controls whose children are excluded from SaveLayout / RestoreLayout. |
| MaxRowCount | Gets or sets the maximum number of tab rows for multi-line docking tab control. |
| MaximumSize | |
| MinimumSize | |
| MultiLine | Gets or sets a value indicating whether more than one row of tabs can be displayed. |
| OutlineMode | Gets or sets the mode used to draw window outline while moving the window. |
| Padding | Gets or sets the amount of space around images and text shown on the tabs. |
| RightToLeftLayout | Gets or sets a value indicating whether right-to-left mirror placement is turned on. |
| RowCount | Gets the number of tab rows (runtime-only). |
| ScrollActive | Gets the value indicating whether tabs scrolling arrows are currently shown (runtime-only). |
| SelectedIndex | Gets or sets the index of the currently selected page. |
| SelectedTab | Gets or sets the currently selected page. |
| SelectedTabBold | Gets or sets the value indicating whether to draw selected tab text with bold font. |
| ShowCaption | Gets or sets a value indicating whether caption is shown on the pages. |
| ShowSingleTab | Gets or sets a value indicating whether a tab will be shown when there is only one page in the control. |
| ShowTabList | Gets or sets the value indicating whether to show a button with dropdown list of all tabs (ignored in multiline mode). |
| ShowTabs | Gets or sets whether tabs area is displayed within the C1DockingTab. |
| ShowToolTips | Gets or sets a value indicating whether the tool tip is shown when the mouse passes over the tab. |
| SplitterWidth | Gets or sets the width of automatic splitters drawn between pages of the control when page docking is enabled. |
| SuperTooltip | |
| TabAreaBackColor | Gets or sets the background color for the tab area. |
| TabAreaBorder | Gets or sets the value indicating whether to draw border around the tab area. |
| TabAreaSpacing | Gets or sets the spacing between the edge of the tab area and the tabs. |
| TabCount | Gets the number of pages in the control. |
| TabLayout | Gets or sets the layout of text and images on the tabs. |
| TabLook | Gets or sets the look of the tabs (whether to show text, image or both). |
| TabPages | Gets the collection of tab pages in this control. |
| TabShape | Indicates the tab shape. |
| TabSizeMode | Gets or sets the way in which the tabs are sized. |
| TabTextAlignment | Gets or sets a value that specifies the alignment of a text shown on the tab. |
| TabsCanFocus | Gets or sets a value indicating whether tabs can receive focus on mouse click. |
| TabsShowFocusCues | Gets or sets a value indicating whether tabs should display focus rectangles. |
| TabsSpacing | Gets or sets the distance between tabs (may be negative to overlap tabs). |
| Text | Gets the text of the currently selected tab (runtime-only). |
| TextDirection | Gets or sets the direction of the text drawn on the tabs. |
| UIStrings | Gets the array of user interface strings. |
Methods
| Name | Description |
|---|---|
| BeginInit() | |
| BeginUpdate() | Temporarily suspends the layout logic for the control. |
| Close(C1DockingTabPage) | Closes the tab page specified. |
| CreateAccessibilityInstance() | |
| CreateControlsInstance() | This method is for internal use only. |
| Dispose(bool) | Releases the resources used by the C1DockingTab. |
| EndInit() | |
| EndUpdate() | Resumes normal layout logic. |
| FindPage(string) | Returns the page with the specified tab text. |
| Float(C1DockingTabPage) | Floats the page out from the form. |
| Float(C1DockingTabPage, Point) | Floats the specified tab page out from the form. |
| Float(C1DockingTabPage, int, int) | Floats the specified tab page out from the form. |
| GetCreatedDockingTabs() | Returns the collection of all C1DockingTab components that were automatically created as the result of user interaction with the current C1DockingTab (e.g. when a page is teared off and dropped to float outside of the form). |
| GetTabRowCol(int, out int, out int) | Returns the row and column of the specified tab in the tabs of the C1DockingTab. |
| IsHot(C1DockingTabPage) | Returns true if the specified tab is in the hot state, otherwise false. |
| OnAlignTabsChanged(EventArgs) | Raises the AlignTabsChanged event. |
| OnAlignmentChanged(EventArgs) | Raises the AlignmentChanged event. |
| OnAutoCreatedDockingTab(AutoCreatedDockingTabEventArgs) | Raises the AutoCreatedDockingTab event. |
| OnAutoHidingChanged(EventArgs) | Raises the AutoHidingChanged event. |
| OnAutoHidingChanging(CancelEventArgs) | Fires the AutoHidingChanging event. |
| OnBackColorChanged(EventArgs) | This method is for internal use only. |
| OnBackgroundImageChanged(EventArgs) | This method is for internal use only. |
| OnCanAutoHideChanged(EventArgs) | Raises the CanAutoHideChanged event. |
| OnCanCloseTabsChanged(EventArgs) | Raises the CanCloseTabsChanged event. |
| OnCanMoveTabsChanged(EventArgs) | Raises the CanMoveTabsChanged event. |
| OnControlAdded(ControlEventArgs) | |
| OnControlRemoved(ControlEventArgs) | |
| OnDoubleClick(EventArgs) | |
| OnFloatingChanged(EventArgs) | Raises the FloatingChanged event. |
| OnFontChanged(EventArgs) | This method is for internal use only. |
| OnForeColorChanged(EventArgs) | This method is for internal use only. |
| OnHotTrackChanged(EventArgs) | Raises the HotTrackChanged event. |
| OnIndentChanged(EventArgs) | Raises the IndentChanged event. |
| OnItemSizeChanged(EventArgs) | Raises the ItemSizeChanged event. |
| OnKeyDown(KeyEventArgs) | |
| OnLayout(LayoutEventArgs) | This method is for internal use only. |
| OnMeasureTab(MeasureTabEventArgs) | Raises the MeasureTab event. |
| OnMouseCaptureChanged(EventArgs) | Raises the MouseCaptureChanged event. |
| OnMouseClick(MouseEventArgs) | Raises the MouseClick event. |
| OnMouseDown(MouseEventArgs) | This method is for internal use only. |
| OnMouseLeave(EventArgs) | This method is for internal use only. |
| OnMouseMove(MouseEventArgs) | This method is for internal use only. |
| OnMouseUp(MouseEventArgs) | This method is for internal use only. |
| OnMultiLineChanged(EventArgs) | Raises the MultiLineChanged event. |
| OnPaddingChanged(EventArgs) | Raises the PaddingChanged event. |
| OnPaint(PaintEventArgs) | This method is for internal use only. |
| OnParentChanged(EventArgs) | This method is for internal use only. |
| OnResize(EventArgs) | This method is for internal use only. |
| OnRightToLeftChanged(EventArgs) | This method is for internal use only. |
| OnRightToLeftLayoutChanged(EventArgs) | Raises the RightToLeftLayoutChanged event. |
| OnSelectedIndexChanged(EventArgs) | Raises the SelectedIndexChanged event. |
| OnSelectedIndexChanging(SelectedIndexChangingEventArgs) | Raises the SelectedIndexChanging event. |
| OnSelectedTabChanged(EventArgs) | Raises the SelectedTabChanged event. |
| OnShowCaptionChanged(EventArgs) | Raises the ShowCaptionChanged event. |
| OnShowSingleTabChanged(EventArgs) | Raises the ShowSingleTabChanged event. |
| OnShowTabListChanged(EventArgs) | Raises the ShowTablistChanged event. |
| OnShowTabsChanged(EventArgs) | Raises the ShowTabsChanged event. |
| OnShowToolTipsChanged(EventArgs) | Raises the ShowToolTipsChanged event. |
| OnSizeChanged(EventArgs) | |
| OnSystemColorsChanged(EventArgs) | This method is for internal use only. |
| OnTabClick(EventArgs) | Raises the TabClick event. |
| OnTabLayoutChanged(EventArgs) | Raises the TabLayoutChanged event. |
| OnTabLookChanged(EventArgs) | Raises the TabLookChanged event. |
| OnTabPageClosed(TabPageEventArgs) | Raises the TabPageClosed event. |
| OnTabPageClosing(TabPageCancelEventArgs) | Raises the TabPageClosing event. |
| OnTabPageMoved(TabPageMovedEventArgs) | Raises the TabPageMoved event. |
| OnTabSizeModeChanged(EventArgs) | Raises the TabSizeModeChanged event. |
| OnTabStyleChanged(EventArgs) | Raises the TabStyleChanged event. |
| OnVisibleChanged(EventArgs) | This method is for internal use only. |
| ProcessCmdKey(ref Message, Keys) | This method is for internal use only. |
| Refresh() | This method is for internal use only. |
| ResetBackColor() | Resets the BackColor property to its default value. |
| ResetItemSize() | This method is for internal use only. |
| ResetPadding() | This method is for internal use only. |
| ResetSelectedIndex() | Restore the SelectedIndex property to its default value. |
| ResetTabAreaBackColor() | This method is for internal use only. |
| ResetUIStrings() | This method is for internal use only. |
| RestoreLayout(Form, Stream) | Restores layout of all C1DockingTab controls on the form from the stream. |
| RestoreLayout(Form, string) | Restores layout of all C1DockingTab controls on the form from the specified file. |
| SaveLayout(Form, Stream, params string[]) | Saves layout of all C1DockingTab controls on the form to the stream. |
| SaveLayout(Form, string, params string[]) | Saves layout of all C1DockingTab controls on the form to the specified file. |
| ScaleControl(SizeF, BoundsSpecified) | |
| ScrollToSelectedTab() | Scrolls the tabs if necessary so that the tab of the currently selected page is visible. |
| ShouldSerializeBackColor() | This method is for internal use only. |
| ShouldSerializeItemSize() | This method is for internal use only. |
| ShouldSerializePadding() | This method is for internal use only. |
| ShouldSerializeSelectedIndex() | Indicates whether the SelectedIndex has a default value. |
| ShouldSerializeTabAreaBackColor() | This method is for internal use only. |
| ShouldSerializeUIStrings() | This method is for internal use only. |
| SlideHidePage() | Hides the page by sliding it to the side. |
| SlideShowPage(C1DockingTabPage) | Shows the page by sliding it out. |
| SlideShowPage(int) | Shows the page by sliding it out. |
| WndProc(ref Message) | This method is for internal use only. |
Events
| Name | Description |
|---|---|
| AlignTabsChanged | Occurs when the AlignTabs property is changed. |
| AlignmentChanged | Occurs when the Alignment property is changed. |
| AutoCreatedDockingTab | Fired when a new C1DockingTab is automatically created in response to user actions (e.g. tearing off a tab and dropping it elsewhere). |
| AutoHidingChanged | Occurs when the AutoHiding property is changed. |
| AutoHidingChanging | Event fires when the AutoHiding property is about to change. Allows to cancel the change. |
| CanAutoHideChanged | Occurs when the CanAutoHide property is changed. |
| CanCloseTabsChanged | Occurs when the CanCloseTabs property is changed. |
| CanMoveTabsChanged | Occurs when the CanMoveTabs property is changed. |
| DrawTab | Allows to override the standard drawing of the tabs with custom drawing. |
| FloatingChanged | Occurs when the Floating property is changed. |
| HotTrackChanged | Occurs when the HotTrack property is changed. |
| IndentChanged | Occurs when the Indent property is changed. |
| ItemSizeChanged | Occurs when the ItemSize property is changed. |
| MeasureTab | Allows to arbitrarily change the size of the tabs. |
| MultiLineChanged | Occurs when the MultiLine property is changed. |
| PaddingChanged | Occurs when the Padding property is changed. |
| RightToLeftLayoutChanged | Occurs when the RightToLeftLayout property is changed. |
| SelectedIndexChanged | Occurs when the SelectedIndex property is changed. |
| SelectedIndexChanging | Event fired when the index of the currently selected page is about to change. Allows to cancel the change. |
| SelectedTabChanged | Event fired when the SelectedTab is changed. |
| ShowCaptionChanged | Occurs when the ShowCaption property is changed. |
| ShowSingleTabChanged | Occurs when the ShowSingleTab property is changed. |
| ShowTablistChanged | Occurs when the ShowTabList property is changed. |
| ShowTabsChanged | Occurs when the ShowTabs property is changed. |
| ShowToolTipsChanged | Occurs when the ShowToolTips property is changed. |
| TabClick | Occurs when the page header of DockingTab is clicked. |
| TabLayoutChanged | Occurs when the TabLayout property is changed. |
| TabLookChanged | Occurs when the TabLook property is changed. |
| TabPageClosed | Event fired after a page has been closed. |
| TabPageClosing | Event fired when the currently selected page is about to be closed by the user. Allows to cancel closing the page. |
| TabPageMoved | Occurs when a tab is moved by the user. |
| TabSizeModeChanged | Occurs when the TabSizeMode property is changed. |
| TabStyleChanged | Occurs when the TabStyle property is changed. |