RibbonBackstageTabItem Class
Represents a tab control used within a RibbonBackstage.
[TemplatePart(Name = "PART_SelectionElement", Type = typeof(FrameworkElement))]
public class RibbonBackstageTabItem : TabItem
- Inheritance:
- object Visual UIElement FrameworkElement Control ContentControl HeaderedContentControl TabItem object
Constructors
RibbonBackstageTabItem()
Initializes an instance of the class.
public RibbonBackstageTabItem()
Properties
HeaderAlignment
A RibbonBackstageHeaderAlignment indicating the alignment of the control within the ribbon Backstage header.
public RibbonBackstageHeaderAlignment HeaderAlignment { get; set; }
Property Value
- RibbonBackstageHeaderAlignment:
The default value is Top.
ImageSourceResolved
The resolved ImageSource for the image to use in the control's template.
Key
A string that uniquely identifies the control.
[Localizability(LocalizationCategory.NeverLocalize)]
public string? Key { get; set; }
Property Value
KeyTipText
The key tip text used to access the control.
[Localizability(LocalizationCategory.Label)]
public string? KeyTipText { get; set; }
Property Value
Label
The text label to display.
[Localizability(LocalizationCategory.Label)]
public string? Label { get; set; }
Property Value
LargeImageSource
The ImageSource for a large image, generally 32x32 size.
ScreenTipFooter
The screen tip footer content.
ScreenTipHeader
The screen tip header content.
SmallImageSource
The ImageSource for a small image, generally 16x16 size.
Title
The string title, which can override the Label when displayed in screen tips and customization UI.
[Localizability(LocalizationCategory.Title)]
public string? Title { get; set; }
Property Value
VariantSize
The VariantSize currently assigned to the control.
Methods
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Provides an appropriate TabItemAutomationPeer implementation for this control, as part of the WPF automation infrastructure.
protected override AutomationPeer OnCreateAutomationPeer()
Returns
- AutomationPeer:
The type-specific AutomationPeer implementation.
OnKeyTipInvoked(KeyTipInvokedEventArgs)
Occurs when the control's key tip is invoked.
protected virtual void OnKeyTipInvoked(KeyTipInvokedEventArgs e)
| Parameter | Type | Description |
|---|---|---|
| e | KeyTipInvokedEventArgs | The event data. |
OnKeyTipOpening(KeyTipOpeningEventArgs)
Occurs when the control's key tip is opening.
protected virtual void OnKeyTipOpening(KeyTipOpeningEventArgs e)
| Parameter | Type | Description |
|---|---|---|
| e | KeyTipOpeningEventArgs | The event data. |
OnToolTipOpening(ToolTipEventArgs)
Invoked whenever the ToolTipOpening routed event reaches this class in its route. Implement this method to add class handling for this event.
protected override void OnToolTipOpening(ToolTipEventArgs e)
| Parameter | Type | Description |
|---|---|---|
| e | ToolTipEventArgs | Provides data about the event. |
ToString()
Returns the string representation of this object.
Fields
HeaderAlignmentProperty
Defines the HeaderAlignment property.
public static readonly DependencyProperty HeaderAlignmentProperty
ImageSourceResolvedProperty
Defines the ImageSourceResolved property.
public static readonly DependencyProperty ImageSourceResolvedProperty
KeyProperty
Defines the Key property.
public static readonly DependencyProperty KeyProperty
KeyTipTextProperty
Defines the KeyTipText property.
public static readonly DependencyProperty KeyTipTextProperty
LabelProperty
Defines the Label property.
public static readonly DependencyProperty LabelProperty
LargeImageSourceProperty
Defines the LargeImageSource property.
public static readonly DependencyProperty LargeImageSourceProperty
ScreenTipFooterProperty
Defines the ScreenTipFooter property.
public static readonly DependencyProperty ScreenTipFooterProperty
ScreenTipHeaderProperty
Defines the ScreenTipHeader property.
public static readonly DependencyProperty ScreenTipHeaderProperty
SmallImageSourceProperty
Defines the SmallImageSource property.
public static readonly DependencyProperty SmallImageSourceProperty
TitleProperty
Defines the Title property.
public static readonly DependencyProperty TitleProperty
VariantSizeProperty
Defines the VariantSize property.
public static readonly DependencyProperty VariantSizeProperty