Class CardPanelHeader
This control can change visibility of other controls depending on the selected tab.
[ControlCategory("Other")]
public class CardPanelHeader : HiddenBorder, IBaseObjectWithAttr, IBaseObjectWithId, INotifyPropertyChanged, IDisposableObject, IBaseObject, ISupportInitialize, IFocusable, IComponent, IControl, IDisposable, IWin32Window, ILayoutItem, INotifyDataErrorInfo, ITextProperty- Inheritance
-
CardPanelHeader
- Implements
Remarks
Allows to switch cards in the CardPanel control by clicking on the card title.
Constructors
- CardPanelHeader()
Initializes a new instance of the CardPanelHeader class.
- CardPanelHeader(Control)
Initializes a new instance of the CardPanelHeader class.
Fields
- CreateButton
Gets or sets function which creates button for the CardPanelHeader.
- DefaultAdditionalSpace
Gets or sets default value of the AdditionalSpace property.
- DefaultTabMargin
Gets or sets default value for the tab margin.
- DefaultTabPadding
Gets or sets default value for the tab padding.
Properties
- ActiveTabColors
Gets or sets active tab colors.
- AdditionalSpace
Gets or sets size of the additional space which is added when UpdateCardsMode is not None.
- BackgroundColorActiveTab
Gets or sets background color of the active tab.
- BackgroundColorInactiveTab
Gets or sets background color of the inactive tab.
- CloseButton
Gets the "Close" button.
- DefaultActiveTabColors
Gets or sets default active tab colors.
- DefaultInactiveTabColors
Gets or sets default inactive tab colors.
- DefaultTabHasBorder
Gets or sets default value of the TabHasBorder.
- DefaultUseTabBackgroundColor
Gets or sets default value for the UseTabBackgroundColor property.
- DefaultUseTabBold
Gets or sets default value for the UseTabBold property.
- DefaultUseTabForegroundColor
Gets or sets default value for the UseTabForegroundColor property.
- ForegroundColorActiveTab
Gets or sets foreground color of the active tab.
- ForegroundColorInactiveTab
Gets or sets foreground color of the inactive tab.
- HasCloseButton
Gets or sets a value indicating whether the close button is visible. Default value is
false.
- HasInteriorBorder
Gets or sets whether tab interior border is visible.
- ImageToText
Gets or sets the layout relationship between the image and text content within the tab (vertical or horizontal align).
- InactiveTabColors
Gets or sets inactive tab colors.
- IsBold
Gets or sets whether font style override is bold.
- IsVerticalText
Gets or sets a value indicating whether the text should be rendered vertically.
- SelectedTab
Gets selected tab.
- SelectedTabIndex
Gets or sets selected tab index.
- TabHasBorder
Gets or sets whether tabs have border.
- TabHorizontalAlignment
Gets or sets HorizontalAlignment of the tabs.
- TabMargin
Gets or sets individual tab margin.
- TabPadding
Gets or sets individual tab padding.
- TabTheme
Gets or sets colors and styles theme of the tabs.
- Tabs
Gets tabs collection.
- TabsAlignment
Gets or sets the area of the control (for example, along the top) where the tabs are aligned.
- Text
Gets or sets text of the first tab.
- UpdateCardsMode
Gets or sets whether to update size of the cards when selected tab is changed.
- UpdateCardsVisible
Gets or sets whether to update visibility of the cards when selected tab is changed.
- UseTabBackgroundColor
Gets or sets whether to set background color for the active tab.
- UseTabBold
Gets whether to set bold style for the title of active tab.
- UseTabForegroundColor
Gets or sets whether to set foreground color for the active tab.
Methods
- Add(string?, AbstractControl?)
Adds new item to the control.
- Add(string?, ObjectUniqueId)
Adds new item to the control.
- CardsWidthToMax(WindowSizeToContentMode)
Sets width of all cards to value obtained with GetMaxCardSize().
- CreateCloseButton()
Creates a new instance of a close button with default settings.
- CreateHeaderButton()
Creates header button control inherited from SpeedButton.
- DefaultPaint(PaintEventArgs)
Default painting method of the UserControl and its descendants.
- GetActiveColors()
Gets colors of the active tab.
- GetCardSizes()
Gets cards width and height.
- GetCardsParent()
Gets parent control of the cards.
- GetColors(bool)
Gets colors of the active or inactive tab.
- GetInactiveColors()
Gets colors of the inactive tab.
- GetInteriorBorderColor()
Gets interior border color.
- GetMaxCardSize()
Calculates maximal width of cards.
- GetRealTabHorizontalAlignment()
Gets real tab horizontal alignment which depends on TabHorizontalAlignment and TabsAlignment.
- GetTab(int?)
Gets item with the specified index.
- IndexOfCardControl(AbstractControl?)
Gets item with the specified control.
- Insert(int?, string?, AbstractControl?)
Inserts new item to the control at the specified position.
- Insert(int?, string?, ObjectUniqueId)
Inserts new item to the control at the specified position.
- OnButtonSizeChanged(object?, EventArgs)
Called when size of the tab button is changed.
- OnItemClick(object?, EventArgs)
Called when tab is clicked.
- OnTabsItemInserted(object?, int, CardPanelHeaderItem)
Called when tab is inserted.
- OnTabsItemRemoved(object?, int, CardPanelHeaderItem)
Called when tab is removed.
- RemoveAt(int?)
Removes item at the specified index.
- SelectFirstTab()
Selects the first tab if it exists.
- SelectLastTab()
Selects the last tab if it exists.
- SetCardsVisible()
Updates visibility of the cards.
- UpdateTab(CardPanelHeaderItem)
Updates tab properties.
- UpdateTabs()
Updates all tabs properties.
Events
- BeforeTabClick
Occurs before the tab is clicked.
- ButtonSizeChanged
Occurs when size of any button is changed.
- CloseButtonClick
Occurs when the close button is clicked.
- TabClick
Occurs when the tab is clicked.