Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

NavigationPane Class

Namespace:
ActiproSoftware.Windows.Controls.Navigation
Assembly:
ActiproSoftware.Navigation.Wpf.dll

Represents a pane that can be displayed in a navigation bar control.

public class NavigationPane : Expander
Inheritance:
object Visual UIElement FrameworkElement Control ContentControl HeaderedContentControl Expander object

Constructors

NavigationPane()

Initializes an instance of the class.

public NavigationPane()

Properties

DefaultSortOrder

The default sort order of the pane, that is used when the pane is reset in the options window.

public int DefaultSortOrder { get; set; }

Property Value

int:

The default value is -1.

Remarks

Leave the value -1 to have it auto-configured the first time the options window is displayed.

DefaultVisibility

The default Visibility of the pane, that is used when the pane is reset in the options window.

public Visibility DefaultVisibility { get; set; }

Property Value

Visibility:

The default value is Visible.

Remarks

This property should match the initial setting of the Visibility property for the pane.

HeaderBackgroundHighlightHover

The header background Brush to use for the pane when the mouse is over it.

public Brush? HeaderBackgroundHighlightHover { get; set; }

Property Value

Brush

HeaderBackgroundHighlightHoverSelected

The header background Brush to use for the pane when it is selected and the mouse is over it.

public Brush? HeaderBackgroundHighlightHoverSelected { get; set; }

Property Value

Brush

HeaderBackgroundHighlightSelected

The header background Brush to use for the pane when it is selected.

public Brush? HeaderBackgroundHighlightSelected { get; set; }

Property Value

Brush

HeaderBackgroundHover

The header background Brush to use for the pane when the mouse is over it.

public Brush? HeaderBackgroundHover { get; set; }

Property Value

Brush

HeaderBackgroundHoverSelected

The header background Brush to use for the pane when it is selected and the mouse is over it.

public Brush? HeaderBackgroundHoverSelected { get; set; }

Property Value

Brush

HeaderBackgroundNormal

The header background Brush to use for the pane when it is in a normal state.

public Brush? HeaderBackgroundNormal { get; set; }

Property Value

Brush

HeaderBackgroundSelected

The header background Brush to use for the pane when it is selected.

public Brush? HeaderBackgroundSelected { get; set; }

Property Value

Brush

HeaderForegroundDisabled

The header foreground Brush to use for the pane when it is disabled.

public Brush? HeaderForegroundDisabled { get; set; }

Property Value

Brush

HeaderForegroundNormal

The header foreground Brush to use for the pane when it is in a normal state.

public Brush? HeaderForegroundNormal { get; set; }

Property Value

Brush

HeaderForegroundSelected

The header foreground Brush to use for the pane when it is selected.

public Brush? HeaderForegroundSelected { get; set; }

Property Value

Brush

HeaderInnerBorderHover

The header border Brush to use for the pane when the mouse is over it.

public Brush? HeaderInnerBorderHover { get; set; }

Property Value

Brush

HeaderInnerBorderHoverSelected

The header border Brush to use for the pane when it is selected and the mouse is over it.

public Brush? HeaderInnerBorderHoverSelected { get; set; }

Property Value

Brush

HeaderInnerBorderNormal

The header border Brush to use for the pane when it is in a normal state.

public Brush? HeaderInnerBorderNormal { get; set; }

Property Value

Brush

HeaderInnerBorderSelected

The header border Brush to use for the pane when it is selected.

public Brush? HeaderInnerBorderSelected { get; set; }

Property Value

Brush

HeaderOuterBorderHover

The header border Brush to use for the pane when the mouse is over it.

public Brush? HeaderOuterBorderHover { get; set; }

Property Value

Brush

HeaderOuterBorderHoverSelected

The header border Brush to use for the pane when it is selected and the mouse is over it.

public Brush? HeaderOuterBorderHoverSelected { get; set; }

Property Value

Brush

HeaderOuterBorderNormal

The header border Brush to use for the pane when it is in a normal state.

public Brush? HeaderOuterBorderNormal { get; set; }

Property Value

Brush

HeaderOuterBorderSelected

The header border Brush to use for the pane when it is selected.

public Brush? HeaderOuterBorderSelected { get; set; }

Property Value

Brush

ImageSourceLarge

The ImageSource for the 32x32 image to display for the control.

public ImageSource? ImageSourceLarge { get; set; }

Property Value

ImageSource

ImageSourceSmall

The ImageSource for the 16x16 image to display for the control.

public ImageSource? ImageSourceSmall { get; set; }

Property Value

ImageSource

IsMouseOverPane

Indicates whether the pane is currently selected.

public bool IsMouseOverPane { get; }

Property Value

bool:

true if the pane is currently selected; otherwise, false.

NavigationBar

The NavigationBar that hosts this pane, if any.

public NavigationBar? NavigationBar { get; }

Property Value

NavigationBar

PopupPadding

The amount of padding added around the pane's content, when displayed in a popup.

public Thickness PopupPadding { get; set; }

Property Value

Thickness

Title

The title of the pane, which appears on pane access buttons, in the navigation bar header, and on menus.

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

Property Value

string

VariantSize

The variant size of the pane.

public NavigationPaneVariantSize VariantSize { get; }

Property Value

NavigationPaneVariantSize:

The default value is Large.

Methods

OnCreateAutomationPeer()

Creates the implementation of AutomationPeer for the Expander control.

protected override AutomationPeer? OnCreateAutomationPeer()

Returns

AutomationPeer:

A new ExpanderAutomationPeer for this Expander control.

OnMouseLeave(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseLeave attached event is raised on this element. Implement this method to add class handling for this event.

protected override void OnMouseLeave(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

The MouseEventArgs that contains the event data.

OnMouseMove(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

protected override void OnMouseMove(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

The MouseEventArgs that contains the event data.

Fields

DefaultSortOrderProperty

Defines the DefaultSortOrder property.

public static readonly DependencyProperty DefaultSortOrderProperty

DefaultVisibilityProperty

Defines the DefaultVisibility property.

public static readonly DependencyProperty DefaultVisibilityProperty

HeaderBackgroundHighlightHoverProperty

Defines the HeaderBackgroundHighlightHover property.

public static readonly DependencyProperty HeaderBackgroundHighlightHoverProperty

HeaderBackgroundHighlightHoverSelectedProperty

Defines the HeaderBackgroundHighlightHoverSelected property.

public static readonly DependencyProperty HeaderBackgroundHighlightHoverSelectedProperty

HeaderBackgroundHighlightSelectedProperty

Defines the HeaderBackgroundHighlightSelected property.

public static readonly DependencyProperty HeaderBackgroundHighlightSelectedProperty

HeaderBackgroundHoverProperty

Defines the HeaderBackgroundHover property.

public static readonly DependencyProperty HeaderBackgroundHoverProperty

HeaderBackgroundHoverSelectedProperty

Defines the HeaderBackgroundHoverSelected property.

public static readonly DependencyProperty HeaderBackgroundHoverSelectedProperty

HeaderBackgroundNormalProperty

Defines the HeaderBackgroundNormal property.

public static readonly DependencyProperty HeaderBackgroundNormalProperty

HeaderBackgroundSelectedProperty

Defines the HeaderBackgroundSelected property.

public static readonly DependencyProperty HeaderBackgroundSelectedProperty

HeaderForegroundDisabledProperty

Defines the HeaderForegroundDisabled property.

public static readonly DependencyProperty HeaderForegroundDisabledProperty

HeaderForegroundNormalProperty

Defines the HeaderForegroundNormal property.

public static readonly DependencyProperty HeaderForegroundNormalProperty

HeaderForegroundSelectedProperty

Defines the HeaderForegroundSelected property.

public static readonly DependencyProperty HeaderForegroundSelectedProperty

HeaderInnerBorderHoverProperty

Defines the HeaderInnerBorderHover property.

public static readonly DependencyProperty HeaderInnerBorderHoverProperty

HeaderInnerBorderHoverSelectedProperty

Defines the HeaderInnerBorderHoverSelected property.

public static readonly DependencyProperty HeaderInnerBorderHoverSelectedProperty

HeaderInnerBorderNormalProperty

Defines the HeaderInnerBorderNormal property.

public static readonly DependencyProperty HeaderInnerBorderNormalProperty

HeaderInnerBorderSelectedProperty

Defines the HeaderInnerBorderSelected property.

public static readonly DependencyProperty HeaderInnerBorderSelectedProperty

HeaderOuterBorderHoverProperty

Defines the HeaderOuterBorderHover property.

public static readonly DependencyProperty HeaderOuterBorderHoverProperty

HeaderOuterBorderHoverSelectedProperty

Defines the HeaderOuterBorderHoverSelected property.

public static readonly DependencyProperty HeaderOuterBorderHoverSelectedProperty

HeaderOuterBorderNormalProperty

Defines the HeaderOuterBorderNormal property.

public static readonly DependencyProperty HeaderOuterBorderNormalProperty

HeaderOuterBorderSelectedProperty

Defines the HeaderOuterBorderSelected property.

public static readonly DependencyProperty HeaderOuterBorderSelectedProperty

ImageSourceLargeProperty

Defines the ImageSourceLarge property.

public static readonly DependencyProperty ImageSourceLargeProperty

ImageSourceSmallProperty

Defines the ImageSourceSmall property.

public static readonly DependencyProperty ImageSourceSmallProperty

IsMouseOverPaneProperty

Defines the IsMouseOverPane property.

public static readonly DependencyProperty IsMouseOverPaneProperty

PopupPaddingProperty

Defines the PopupPadding property.

public static readonly DependencyProperty PopupPaddingProperty

TitleProperty

Defines the Title property.

public static readonly DependencyProperty TitleProperty

VariantSizeProperty

Defines the VariantSize property.

public static readonly DependencyProperty VariantSizeProperty

Extension Methods