RibbonWindow Class

[TemplatePart(Name = "PART_ApplicationIcon", Type = typeof(UIElement))]
[TemplatePart(Name = "PART_TitleBar", Type = typeof(Panel))]
[TemplatePart(Name = "PART_TitleBarText", Type = typeof(RibbonWindowTitleBarText))]
public class RibbonWindow : Window

public RibbonWindow()

[Localizability(LocalizationCategory.Title)]
public string ApplicationName { get; set; }

Property Value

string:

The name of the application.

Remarks

This property, along with the DocumentName property, is use to construct the window's title.

[Localizability(LocalizationCategory.Title)]
public string DocumentName { get; set; }

Property Value

string:

The name of the current document, if any.

Remarks

This property, along with the ApplicationName property, is use to construct the window's title.

public bool HasRibbon { get; }

Property Value

bool:

true if a ActiproSoftware.Windows.Controls.Ribbon.RibbonWindow.Ribbon control is displayed in the window; otherwise, false.

public bool IsMaximizeButtonVisible { get; set; }

Property Value

bool:

true if the maximize button is visible; otherwise, false. The default value is true.

public bool IsMinimizeButtonVisible { get; set; }

Property Value

bool:

true if the minimize button is visible; otherwise, false. The default value is true.

public bool IsRibbonBackstageOpen { get; }

Property Value

bool:

true if an attached ActiproSoftware.Windows.Controls.Ribbon.RibbonWindow.Ribbon control has its backstage open; otherwise, false.

public bool IsRibbonVisibleWithBackstage { get; set; }

Property Value

bool:

true if the ribbon should remain visible when the Backstage is displayed; otherwise, false. The default value is false.

public bool IsTitleBarVisible { get; set; }

Property Value

bool:

true if the title bar is visible; otherwise, false. The default value is true.

Remarks

Normally, setting the WindowStyle property to None would hide a title bar. However, RibbonWindow is often forced to be in None style to achieve its custom UI. Therefore, set this property to false in cases where you maximize the RibbonWindow, hide any child ActiproSoftware.Windows.Controls.Ribbon.RibbonWindow.Ribbon and want to achieve an effect similar to normal windows when their style is None. This sort of functionality is useful when trying to mimic a "full-screen" mode temporarily.

public DataTemplate TitleBarHeaderTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate for the center title bar area where title bar text is typically displayed.

public DataTemplate TitleBarLeftContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate that can inject additional controls in the left side of the title bar, next to the icon.

public RibbonWindowTitleBarViewModel TitleBarViewModel { get; }

Property Value

RibbonWindowTitleBarViewModel:

The RibbonWindowTitleBarViewModel for the title bar.

protected override void OnActivated(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

public override void OnApplyTemplate()

protected override void OnDeactivated(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnStateChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnTemplateChanged(ControlTemplate oldTemplate, ControlTemplate newTemplate)

Parameter	Type	Description
oldTemplate	ControlTemplate	The old template.
newTemplate	ControlTemplate	The new template.

public bool SetSize(double width, double height)

Parameter	Type	Description
width	double	The new width.
height	double	The new height.

Returns

bool:

true if the resize operation was successful; otherwise false.

public static readonly DependencyProperty ApplicationNameProperty

public static readonly DependencyProperty DocumentNameProperty

public static readonly DependencyProperty HasRibbonProperty

public static readonly DependencyProperty IsMaximizeButtonVisibleProperty

public static readonly DependencyProperty IsMinimizeButtonVisibleProperty

public static readonly DependencyProperty IsRibbonBackstageOpenProperty

public static readonly DependencyProperty IsRibbonVisibleWithBackstageProperty

public static readonly DependencyProperty IsTitleBarVisibleProperty

public static readonly DependencyProperty TitleBarHeaderTemplateProperty

public static readonly DependencyProperty TitleBarLeftContentTemplateProperty

public static readonly DependencyProperty TitleBarViewModelProperty