NavigationFrame Class

Displays Page instances, supports navigation to new pages, and maintains a navigation history to support forward and backward navigation.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        System.WindowsUIElement
          System.WindowsFrameworkElement
            System.Windows.ControlsControl
              System.Windows.ControlsContentControl
                Cauldron.XAML.ControlsNavigationFrame

Namespace: Cauldron.XAML.Controls
Assembly: Cauldron.Win32.WPF (in Cauldron.Win32.WPF.dll) Version: 3.2.0.1 (3.2.0.1)

Syntax

Copy

public class NavigationFrame : ContentControl

The NavigationFrame type exposes the following members.

Constructors

	Name	Description
	NavigationFrame	Initializes a new instance of NavigationFrame

Top

Properties

	Name	Description
	BackStack	Gets a collection of PageStackEntry instances representing the backward navigation history of the NavigationFrame.
	CanGoBack	Gets or sets the CanGoBack Property
	CanGoForward	Gets or sets the CanGoForward Property
	ForwardStack	Gets a collection of PageStackEntry instances representing the forward navigation history of the NavigationFrame.
	MaxStackSize	Gets or sets the MaxStackSize Property

Top

Methods

	Name	Description
	ClearStack	Resets the navigation history of the NavigationFrame
	GoBack	Navigates to the most recent item in back navigation history, if a Frame manages its own navigation history.
	GoBack(NavigationType)	Navigates to the most recent item in back navigation history, if a Frame manages its own navigation history.
	GoForward	Gets a collection of PageStackEntry instances representing the forward navigation history of the Frame.
	GoForward(NavigationType)	Gets a collection of PageStackEntry instances representing the forward navigation history of the Frame.
	Navigate(Type)	Causes the NavigationFrame to load content represented by the specified IViewModel, also passing a parameter to be used to construct the view model.
	Navigate(Type, Object)	Causes the NavigationFrame to load content represented by the specified IViewModel, also passing a parameter to be used to construct the view model.
	NavigateTViewModel(Object, FuncTask)	Create a new ContentDialog or Flyout with the view defined by the view model, depending on the views definition.
	NavigateTViewModel, TResult(Object, FuncTResult, Task)	Create a new ContentDialog or Flyout with the view defined by the view model, depending on the views definition.
	Reload	Reloads the current view and viewmodel
	TryClose	Tries to close all dialog Window s
	TryClose(IViewModel)	Tries to close a view model associated Window

Top

Events

	Name	Description
	BackRequested	Occures when back navigation is requested
	Navigated	Occurs when the content that is being navigated to has been found and is available from the Content property, although it may not have completed loading.

Top

Fields

	Name	Description
	CanGoBackProperty	Identifies the CanGoBack dependency property
	CanGoForwardProperty	Identifies the CanGoForward dependency property
	MaxStackSizeProperty	Identifies the MaxStackSize dependency property

Top

Extension Methods

	Name	Description
	As(Type)	Overloaded. Converts a type using the implicit or explicit operators. If both fails it will try to convert the value with ChangeType(Object, Type). (Defined by ExtensionsConvertions.)
	As(Type, Type)	Overloaded. Converts a type using the implicit or explicit operators. If both fails it will try to convert the value with ChangeType(Object, Type). (Defined by ExtensionsConvertions.)
	AsT	Overloaded. Performs a cast between compatible reference types. If a convertion is not possible then null is returned. As a last resort it will use ChangeType(Object, Type). Tries to use the implicit and explicit operators if exists when convertion with 'as' returns null. (Defined by ExtensionsConvertions.)
	AsBitmapImage	Draws the visuals of a FrameworkElement to a BitmapImage (Defined by Extensions.)
	CreateTypeT	Creates a new Type that implements the properties of an interface defined by T and copies all value of anon to the new object. (Defined by ExtensionsInterception.)
	FindVisualChildByName	Searches for a specified visual element in the child tree by name (Defined by Extensions.)
	FindVisualChildren(Type)	Overloaded. Returns all visual childs and sub child (recursively) of the element that matches the given type (Defined by Extensions.)
	FindVisualChildrenT	Overloaded. Returns all visual childs and sub child (recursively) of the element that matches the given type (Defined by Extensions.)
	FindVisualChildrenT(FuncFrameworkElement, Boolean)	Overloaded. Returns all visual childs and sub child (recursively) of the element that matches the predicate. (Defined by Extensions.)
	FindVisualParent(Type)	Overloaded. Returns the parent object of the specified object by processing the visual tree. (Defined by Extensions.)
	FindVisualParentT	Overloaded. Returns the parent object of the specified object by processing the visual tree. The difference to FindVisualParent(DependencyObject, Type) is that this also consider sub-classes. (Defined by Extensions.)
	FindVisualRootElement	Climbs up the visual tree and returns the top most visual parent (Defined by Extensions.)
	GetDependencyProperties	Returns all DependendencyProperty fields in UWP and Desktop (Defined by Extensions.)
	GetInheritanceContext	Returns the InheritanceContext of the current DependencyObject (Defined by Extensions.)
	GetPropertyNonPublicValueT	Searches for the specified property, using the specified binding constraints and returns its value. Default BindingFlags are Instance and NonPublic (Defined by ExtensionsReflection.)
	GetPropertyValue(String, BindingFlags)	Overloaded. Searches for the specified property, using the specified binding constraints and returns its value. (Defined by ExtensionsReflection.)
	GetPropertyValueT(String)	Overloaded. Searches for the specified property, using the specified binding constraints and returns its value. Default BindingFlags are Instance and Public (Defined by ExtensionsReflection.)
	GetPropertyValueT(String, BindingFlags)	Overloaded. Searches for the specified property, using the specified binding constraints and returns its value. (Defined by ExtensionsReflection.)
	GetValueFromBindingOrProperty	Gets the value of the FrameworkElement's DependencyProperty. If the DependencyProperty is binded, then it will return the value of the binding source. If it is not binded, then it will return the value of the DependencyProperty. (Defined by Extensions.)
	GetVisualChildren	Gets the direct visual children of the element (Defined by Extensions.)
	GetVisualParent	Returns the parent object of the specified object by processing the visual tree. (Defined by Extensions.)
	MapToT	Maps all properties and fields of an instance to another instance. The Clone() method is used to copy an instance if exist. Mapping fails on jagged and multidimensional array. Classes without parameterless constructor will stay null. (Defined by ExtensionsCloning.)
	SaveVisualAsPngAsync	Saves the visuals of a FrameworkElement to a png file (Defined by Extensions.)
	SetBinding	Attaches a binding to a FrameworkElement, using the provided binding object. (Defined by Extensions.)
	ToLong	Tries to convert a Object to an Int64. Returns MinValue if target cannot be parsed. (Defined by ExtensionsConvertions.)
	ToStringEx(String)	Overloaded. Converts the value of this instance to its equivalent string representation, using the specified format. The following custom formatter are already added: ByteSizeFormatter, MetricUnitFormatter (Defined by Extensions.)
	ToStringEx(String, CultureInfo)	Overloaded. Converts the value of this instance to its equivalent string representation, using the specified format. The following custom formatter are already added: ByteSizeFormatter, MetricUnitFormatter (Defined by Extensions.)
	TryDispose	Tries to performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. This will dispose an object if it implements the IDisposable interface. (Defined by Extensions.)

Top

Reference

Cauldron.XAML.Controls Namespace