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

Remarks

For detailed documentation on this control's features and how to use them, please see the NavigationBar-related series of documentation topics.

Constructors

NavigationPane()

Initializes an instance of the class.

public NavigationPane()

Properties

DefaultSortOrder

Gets or sets 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 sort order of the pane, that is used when the pane is reset in the options window. The default value is -1.

Remarks

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

DefaultVisibility

Gets or sets 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 Visibility of the pane, that is used when the pane is reset in the options window. The default value is Visible.

Remarks

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

HeaderBackgroundHighlightHover

Gets or sets the header background Brush to use for the pane when the mouse is over it.

public Brush HeaderBackgroundHighlightHover { get; set; }

Property Value

Brush:

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

HeaderBackgroundHighlightHoverSelected

Gets or sets 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:

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

HeaderBackgroundHighlightSelected

Gets or sets the header background Brush to use for the pane when it is selected.

public Brush HeaderBackgroundHighlightSelected { get; set; }

Property Value

Brush:

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

HeaderBackgroundHover

Gets or sets the header background Brush to use for the pane when the mouse is over it.

public Brush HeaderBackgroundHover { get; set; }

Property Value

Brush:

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

HeaderBackgroundHoverSelected

Gets or sets 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:

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

HeaderBackgroundNormal

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

public Brush HeaderBackgroundNormal { get; set; }

Property Value

Brush:

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

HeaderBackgroundSelected

Gets or sets the header background Brush to use for the pane when it is selected.

public Brush HeaderBackgroundSelected { get; set; }

Property Value

Brush:

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

HeaderForegroundDisabled

Gets or sets the header foreground Brush to use for the pane when it is disabled.

public Brush HeaderForegroundDisabled { get; set; }

Property Value

Brush:

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

HeaderForegroundNormal

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

public Brush HeaderForegroundNormal { get; set; }

Property Value

Brush:

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

HeaderForegroundSelected

Gets or sets the header foreground Brush to use for the pane when it is selected.

public Brush HeaderForegroundSelected { get; set; }

Property Value

Brush:

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

HeaderInnerBorderHover

Gets or sets the header border Brush to use for the pane when the mouse is over it.

public Brush HeaderInnerBorderHover { get; set; }

Property Value

Brush:

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

HeaderInnerBorderHoverSelected

Gets or sets 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:

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

HeaderInnerBorderNormal

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

public Brush HeaderInnerBorderNormal { get; set; }

Property Value

Brush:

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

HeaderInnerBorderSelected

Gets or sets the header border Brush to use for the pane when it is selected.

public Brush HeaderInnerBorderSelected { get; set; }

Property Value

Brush:

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

HeaderOuterBorderHover

Gets or sets the header border Brush to use for the pane when the mouse is over it.

public Brush HeaderOuterBorderHover { get; set; }

Property Value

Brush:

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

HeaderOuterBorderHoverSelected

Gets or sets 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:

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

HeaderOuterBorderNormal

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

public Brush HeaderOuterBorderNormal { get; set; }

Property Value

Brush:

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

HeaderOuterBorderSelected

Gets or sets the header border Brush to use for the pane when it is selected.

public Brush HeaderOuterBorderSelected { get; set; }

Property Value

Brush:

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

ImageSourceLarge

Gets or sets the ImageSource for the 32x32 image to display for the control.

public ImageSource ImageSourceLarge { get; set; }

Property Value

ImageSource:

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

ImageSourceSmall

Gets or sets the ImageSource for the 16x16 image to display for the control.

public ImageSource ImageSourceSmall { get; set; }

Property Value

ImageSource:

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

IsMouseOverPane

Gets or sets whether the pane is currently selected.

public bool IsMouseOverPane { get; }

Property Value

bool:

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

NavigationBar

Gets the NavigationBar that hosts this pane, if any.

public NavigationBar NavigationBar { get; }

Property Value

NavigationBar:

The NavigationBar that hosts this pane, if any.

PopupPadding

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

public Thickness PopupPadding { get; set; }

Property Value

Thickness:

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

Title

Gets or sets 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:

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

VariantSize

Gets or sets the variant size of the pane.

public NavigationPaneVariantSize VariantSize { get; }

Property Value

NavigationPaneVariantSize:

A NavigationPaneVariantSize that specifies the variant size of the pane.

Methods

OnCreateAutomationPeer()

Creates and returns an AutomationPeer object for this type.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The AutomationPeer that was created.

OnMouseLeave(MouseEventArgs)

Occurs when the mouse leaves the control.

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

A MouseEventArgs that contains the event data.

OnMouseMove(MouseEventArgs)

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

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

A MouseEventArgs that contains the event data.

Fields

DefaultSortOrderProperty

Identifies the DefaultSortOrder dependency property. This field is read-only.

public static readonly DependencyProperty DefaultSortOrderProperty

DefaultVisibilityProperty

Identifies the DefaultVisibility dependency property. This field is read-only.

public static readonly DependencyProperty DefaultVisibilityProperty

HeaderBackgroundHighlightHoverProperty

Identifies the HeaderBackgroundHighlightHover dependency property. This field is read-only.

public static readonly DependencyProperty HeaderBackgroundHighlightHoverProperty

HeaderBackgroundHighlightHoverSelectedProperty

Identifies the HeaderBackgroundHighlightHoverSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderBackgroundHighlightHoverSelectedProperty

HeaderBackgroundHighlightSelectedProperty

Identifies the HeaderBackgroundHighlightSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderBackgroundHighlightSelectedProperty

HeaderBackgroundHoverProperty

Identifies the HeaderBackgroundHover dependency property. This field is read-only.

public static readonly DependencyProperty HeaderBackgroundHoverProperty

HeaderBackgroundHoverSelectedProperty

Identifies the HeaderBackgroundHoverSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderBackgroundHoverSelectedProperty

HeaderBackgroundNormalProperty

Identifies the HeaderBackgroundNormal dependency property. This field is read-only.

public static readonly DependencyProperty HeaderBackgroundNormalProperty

HeaderBackgroundSelectedProperty

Identifies the HeaderBackgroundSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderBackgroundSelectedProperty

HeaderForegroundDisabledProperty

Identifies the HeaderForegroundDisabled dependency property. This field is read-only.

public static readonly DependencyProperty HeaderForegroundDisabledProperty

HeaderForegroundNormalProperty

Identifies the HeaderForegroundNormal dependency property. This field is read-only.

public static readonly DependencyProperty HeaderForegroundNormalProperty

HeaderForegroundSelectedProperty

Identifies the HeaderForegroundSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderForegroundSelectedProperty

HeaderInnerBorderHoverProperty

Identifies the HeaderInnerBorderHover dependency property. This field is read-only.

public static readonly DependencyProperty HeaderInnerBorderHoverProperty

HeaderInnerBorderHoverSelectedProperty

Identifies the HeaderInnerBorderHoverSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderInnerBorderHoverSelectedProperty

HeaderInnerBorderNormalProperty

Identifies the HeaderInnerBorderNormal dependency property. This field is read-only.

public static readonly DependencyProperty HeaderInnerBorderNormalProperty

HeaderInnerBorderSelectedProperty

Identifies the HeaderInnerBorderSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderInnerBorderSelectedProperty

HeaderOuterBorderHoverProperty

Identifies the HeaderOuterBorderHover dependency property. This field is read-only.

public static readonly DependencyProperty HeaderOuterBorderHoverProperty

HeaderOuterBorderHoverSelectedProperty

Identifies the HeaderOuterBorderHoverSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderOuterBorderHoverSelectedProperty

HeaderOuterBorderNormalProperty

Identifies the HeaderOuterBorderNormal dependency property. This field is read-only.

public static readonly DependencyProperty HeaderOuterBorderNormalProperty

HeaderOuterBorderSelectedProperty

Identifies the HeaderOuterBorderSelected dependency property. This field is read-only.

public static readonly DependencyProperty HeaderOuterBorderSelectedProperty

ImageSourceLargeProperty

Identifies the ImageSourceLarge dependency property. This field is read-only.

public static readonly DependencyProperty ImageSourceLargeProperty

ImageSourceSmallProperty

Identifies the ImageSourceSmall dependency property. This field is read-only.

public static readonly DependencyProperty ImageSourceSmallProperty

IsMouseOverPaneProperty

Identifies the IsMouseOverPane dependency property. This field is read-only.

public static readonly DependencyProperty IsMouseOverPaneProperty

PopupPaddingProperty

Identifies the PopupPadding dependency property. This field is read-only.

public static readonly DependencyProperty PopupPaddingProperty

TitleProperty

Identifies the Title dependency property. This field is read-only.

public static readonly DependencyProperty TitleProperty

VariantSizeProperty

Identifies the VariantSize dependency property. This field is read-only.

public static readonly DependencyProperty VariantSizeProperty