Skip to end of metadata
Go to start of metadata

Remarks

UXFrame is the core navigation component that acts as the container of navigable content and facilitates the navigation to pages. UXFrame supports navigation to pages in the local assembly or pages in external application package (.xap). Built upon ClientUI Framework, UXFrame delivers consistent and navigation experiences across multiple, nested navigation frames.

Several key features include journal-aware deep navigation, predefined visual transitions, seamless integration with navigation UI through advanced architecture such as routed commands and events, easy MVVM binding, role-based security, busy state management and much more.

For detailed information about the navigation concept, architecture, and how to implement navigation features, see Navigation Overview. To learn more about the advanced navigation features, see Advanced Features in ClientUI Navigation Framework.

Example

The following example shows a XAML page with a static header area for branding, and a dynamic content area to display navigable pages.

 

XAML

Definition

Summary

The following table summarizes the members exposed in this class.

Public Constructors

UXFrame Constructor()Initializes a new instance of the UXFrame class.

Public Properties

AllowCancelDownloadGets or sets a value that indicates whether users are allowed to cancel the download progress for the current navigated source.
AllowNestedFrameNavigationGets or sets a value that indicates whether this frame can host nested frames to support child navigation.
ApplicationIDGets the unique identifier that represents the application associated to this frame.
ApplicationUriGets the unique resource identifier (URI) of the application associated to this frame.
AutoDetectNavigationDirectionGets or sets a value that indicates whether the navigation direction should be automatically detected. When set to true, this property works with page transition and transition effect to automatically determines which transition to be applied based on the navigation direction.
AutoMapApplicationsGets or sets a value that indicates whether this frame should automatically map the current source against the Applications collection defined in global UXShell instance.
BackTransitionEffectGets or sets the transition effect when a back navigation occurs.
BusyIndicatorLatencyGets or sets the latency in seconds to wait before the busy indicator is displayed after the UXFrame is set to true.
BusyIndicatorTemplateGets or sets the template that represents busy indicator when the UXFrame is true.
CornerRadiusRepresents the radius of a border's corner. The radius can't be negative.
CurrentApplicationGets the current ApplicationPackage that loaded to this frame.
DefaultTransitionEffectGets or sets the default transition for this frame. The default transition is used when the frame is unable to determine the navigation mode or direction.
DisplayFragmentInBrowserGets or sets a value that indicates whether this frame should display the fragment of the current journal in the browser.
EnablePageTransitionGets or sets a value that indicates whether visual transition should be applied when a new page navigation occurred.
ErrorStyleSpecifies the style applied in the error page.
ForwardTransitionEffectGets or sets the transition effect when a forward navigation occurs.
FrameLevelGets the depth level of the the UXFrame in the visual hierarchy.
HistoryGets the JournalHistory instance for journal management of this control. This property is applicable only when AllowNestedFrameNavigation property is set to true.
IsAuthenticatedGets a value indicating whether the associated UXFrame is authenticated.
IsAuthenticatingGets or sets a value indicating whether the UXFrame is currently performing authentication process. When the property is set to true, the UXFrame will delay the navigation process until the authentication process is done.
IsBusyGets or sets a value indicating whether the page hosted by this UXFrame is in busy state.
IsInitializingGets or sets a value indicating whether the UXFrame is currently waiting for asynchronous initialization to complete. When the property is set to true, the UXFrame will delay the navigation process until the initialization process is completed.
IsLoadingGets a value that determines whether this frame is currently in loading progress.
IsPrimaryNavigatorGets or sets a value that indicates whether this frame is the primary navigator when multiple frames existed in a page. By default, the navigation bar and commands is bound to the primary navigator when querying the navigation status or when executing navigation commands.
LoaderAppearanceSpecifies the mode that determines the visual appearance of the loader. The loader is shown when the frame is loading an external ApplicationPackage and the ShowLoadingProgress is set to true.
LoaderStyleSpecifies the style applied in the loader page.
LoadingTransitionEffectGets or sets the transition effect when the frame is loading an external source.
NavigationStateGets a value that represents the URI of the current navigation state. The value also combines the URI of the active child navigators, i.e., /Products/Category
NewTransitionEffectGets or sets the transition effect when a new navigation occurs.
OriginalSourceGets a value that represents the original URI of the current source before mapped (for WPF compatibility purpose).
OwnerGets the parent element that owns this frame.
PresenterStyleGets or sets the style to apply to the presenter element.
ProgressTextGets or sets the text displayed during download progress.
RedirectUriGets or sets the uniform resource identifier (URI) that will be navigated when the authentication is requested.
ReloadContentOnChildNavigationGets or sets a value indicating whether the frame's content should be navigated when a child navigation occurred.
RestoreVirtualizedUriDetermines whether virtual Uris should be restored after mapped.
ShowLoadingProgressGets or sets a value that indicates whether the frame should display the loading progress of currently downloaded source.
TransitionDurationGets or sets the duration of the transition effect in seconds. If not specified, the default value is 0.3.
TransitionLatencyGets or sets the time span (in seconds) to wait before the transition is performed. This property only applies when TransitionStrategy is set to WaitContentReady.
TransitionStrategyGets or sets a value that determines how the control handles the transition process.
UriMappingScopeGets or sets a value that determines the URI mapping scope applied to this navigation frame.
UseCachedVisualForTransitionGets or sets a value indicating whether a cached visual should be used instead of the actual element when performing transition.
UseGlobalShellGets or sets a value that indicates whether this frame should use global UXShell instance if available.
UserGets or sets the System.Security.Principal.IPrincipal object representing the user to be authenticated.
VirtualPathsGets a collection of VirtualPath objects that associated to this frame.

Protected Properties

ProductProduct Info.

Fields

AllowCancelDownloadPropertyIdentifies the AllowCancelDownload dependency property.
AllowNestedFrameNavigationPropertyIdentifies the AllowNestedFrameNavigation dependency property.
AutoDetectNavigationDirectionPropertyIdentifies the AutoDetectNavigationDirection dependency property.
AutoMapApplicationsPropertyIdentifies the AutoMapApplications dependency property.
BackTransitionEffectPropertyIdentifies the BackTransitionEffect dependency property.
BusyIndicatorLatencyPropertyIdentifies the BusyIndicatorLatency dependency property.
BusyIndicatorTemplatePropertyIdentifies the BusyIndicator dependency property.
CornerRadiusPropertyIdentifies the CornerRadius dependency property.
DefaultTransitionEffectPropertyIdentifies the DefaultTransitionEffect dependency property.
DisplayFragmentInBrowserPropertyIdentifies the DisplayFragmentInBrowser dependency property.
EnablePageTransitionPropertyIdentifies the EnablePageTransition dependency property.
ErrorStylePropertyIdentifies the ErrorStyle dependency property.
ForwardTransitionEffectPropertyIdentifies the ForwardTransitionEffect dependency property.
IsAuthenticatedPropertyIdentifies the IsAuthenticated dependency property.
IsAuthenticatingPropertyIdentifies the IsAuthenticating dependency property.
IsBusyPropertyIdentifies the IsBusy dependency property.
IsInitializingPropertyIdentifies the IsInitializing dependency property.
IsLoadingChangedEventIdentifies the IsLoadingChanged routed event.
IsLoadingPropertyIdentifies the IsLoading dependency property.
IsPrimaryNavigatorPropertyIdentifies the IsPrimaryNavigator dependency property.
LoaderAppearancePropertyIdentifies the LoaderAppearance dependency property.
LoaderStylePropertyIdentifies the LoaderStyle dependency property.
LoadingTransitionEffectPropertyIdentifies the LoadingTransitionEffect dependency property.
NavigationStatePropertyIdentifies the NavigationState dependency property.
NewTransitionEffectPropertyIdentifies the NewTransitionEffect dependency property.
PresenterStylePropertyIdentifies the PresenterStyle dependency property.
ProgressTextPropertyIdentifies the ProgressText dependency property.
RedirectUriPropertyIdentifies the RedirectUri dependency property.
ReloadContentOnChildNavigationPropertyIdentifies the ReloadContentOnChildNavigation dependency property.
ShowLoadingProgressPropertyIdentifies the ShowLoadingProgress dependency property.
TransitionDurationPropertyIdentifies the TransitionDuration dependency property.
TransitionLatencyPropertyIdentifies the TransitionLatency dependency property.
TransitionStrategyPropertyIdentifies the TransitionStrategy dependency property.
UriMappingScopePropertyIdentifies the UriMappingScope dependency property.
UseCachedVisualForTransitionPropertyIdentifies the PerformTransitionOnLoad dependency property.
UseGlobalShellPropertyIdentifies the UseGlobalShell dependency property.
UserPropertyIdentifies the User dependency property.
VirtualPathsPropertyIdentifies the VirtualPaths dependency property.

Static Methods

GetFrame(int)Gets the UXFrame instance based on the specified frame level.
GetFrameHost(UIElement)Returns the UXFrame instance that hosts the given UIElement.
GetPrimaryNavigator(UIElement)Returns the UXFrame instance which is the first-match primary navigator found in the specified source.
GetResolvedPage(object) 

Public Methods

ClearApplicationSource()Clear the application source previously loaded to the UXFrame instance.
DetachedEventHandlers()Detach built-in event handlers from control templates. Call this method if necessary.
Dispose()Called when the control is disposed.
GetActiveNestedPage(UIElement)Returns the active page instance in the last hierarchy of nested child navigation structure.
GetCurrentPageTitle()Returns the page title of the currently loaded content.
GetPresenterElement()Gets the element that represents the content presenter.
GetShell()Gets the UXShell instance that manages application life cycle for the UXFrame control.
Navigate(Uri, object)Navigates asynchronously to source content located at a uniform resource identifier (URI), and passes an object that contains data to be used for processing during navigation.
OnApplyTemplate()Builds the visual tree for the UXFrame when a new template is applied.
Reset()Reset the UXFrame to the initial navigation state
SetContent(object, bool)Sets the specified content directly to the UXFrame bypassing its navigation state.
StopLoading()Stops the currently loading application. If the application is being downloaded, the download will be cancelled.

Protected Methods

OnUnloaded(object, RoutedEventArgs)Called when the element is unloaded.

Events

AuthenticatingOccurs when the content hosted by the UXFrame is authenticating pages before they are presented to the container.
FragmentNavigationOccurs when navigation to a content fragment begins, which occurs immediately, if the desired fragment is in the current content, or after the source XAML content has been loaded, if the desired fragment is in different content.
IsLoadingChangedOccurs when the IsLoading property value is changed.
LoggedInOccurs when the UXFrame associated to the UXFrame is successfully authenticated.
LoggedOutOccurs when the UXFrame associated to the UXFrame is logged out.
NavigatedOccurs 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.
NavigatingOccurs when a new navigation is requested.
NavigationCancelledOccurs when the navigation progress is cancelled, either by users or through API calls.
NavigationFailedOccurs when an error is raised while navigating to the requested content.
NavigationProgressOccurs periodically during a download to provide navigation progress information.
NavigationStoppedOccurs when the StopLoading method is called, or when a new navigation is requested while a current navigation is in progress.
RequestingAuthenticationOccurs when the content hosted by the UXFrame is requesting authentication.
ResolveNavigationDirectionOccurs when the NavigationDirection property is being resolved.

Public Constructors

public UXFrame()

 

Public Properties

public bool AllowCancelDownload { get; set; }

Gets or sets a value that indicates whether users are allowed to cancel the download progress for the current navigated source.

public bool AllowNestedFrameNavigation { get; set; }

Gets or sets a value that indicates whether this frame can host nested frames to support child navigation.

Remarks

One of the features in UXFrame that makes it a versatile navigation framework is the full support for nested child navigation. Child navigation refers to the use of UXFrame inside a page that already hosted by upper level of frames. More importantly, UXFrame supports browser journal integration for the child level navigation, which is not supported in Silverlight's built-in or other navigation frameworks. For more information on how to implement child navigation using ClientUI Navigation Framework, see Advanced Features in ClientUI Navigation Framework.

 

public object ApplicationID { get; }

Gets the unique identifier that represents the application associated to this frame.

public Uri ApplicationUri { get; }

Gets the unique resource identifier (URI) of the application associated to this frame.

public bool AutoDetectNavigationDirection { get; set; }

Gets or sets a value that indicates whether the navigation direction should be automatically detected. When set to true, this property works with page transition and transition effect to automatically determines which transition to be applied based on the navigation direction.

Remarks

UXFrame provides an advanced mechanism to automatically detect the direction of the current navigation process. Called AutoDetectNavigationDirection, this feature makes it easy for you to determine the position of the target destination relative to the current navigation position, which enables you to perform certain actions based on the navigation direction. For more information, see Navigation Overview.

 

public bool AutoMapApplications { get; set; }

Gets or sets a value that indicates whether this frame should automatically map the current source against the Applications collection defined in global UXShell instance.

public TransitionEffect BackTransitionEffect { get; set; }

Gets or sets the transition effect when a back navigation occurs.

Remarks

This transition will be applied when the frame is navigating backward.

 

public double BusyIndicatorLatency { get; set; }

Gets or sets the latency in seconds to wait before the busy indicator is displayed after the UXFrame is set to true.

Remarks

To enhance the user experiences when using busy state feature, you can customize the latency that determines how long a time span should elapse before the busy indicator is displayed. This feature is particularly useful to avoid user interface flickering that may occur when the busy state is changed too fast. For example, consider the scenario when you click a button to load an item's details which subsequently displays the busy indicator. However, the data may load faster than expected specifically when the network traffic is low. This causes flickering as the busy indicator is shown and hidden immediately. You set the BusyIndicatorLatency property of the UXFrame to a time span measured in seconds. The default value is 1 second, which means that only operations longer than 1 second will show the busy indicator and process the user interface blocking, if UXPage feature in UXPage is enabled. For more information, see Navigation Overview.

 

public DataTemplate BusyIndicatorTemplate { get; set; }

Gets or sets the template that represents busy indicator when the UXFrame is true.

Remarks

To display the user interface that represents busy indicator, you define the XAML template to apply to the BusyIndicatorTemplate of the navigation frame. For more information, see Navigation Overview.

 

public CornerRadius CornerRadius { get; set; }

Represents the radius of a border's corner. The radius can't be negative.

public ApplicationPackage CurrentApplication { get; }

Gets the current ApplicationPackage that loaded to this frame.

public TransitionEffect DefaultTransitionEffect { get; set; }

Gets or sets the default transition for this frame. The default transition is used when the frame is unable to determine the navigation mode or direction.

Remarks

This transition will be applied when navigating to a new page, or when the navigation mode cannot be determined.

 

public bool DisplayFragmentInBrowser { get; set; }

Gets or sets a value that indicates whether this frame should display the fragment of the current journal in the browser.

public bool EnablePageTransition { get; set; }

Gets or sets a value that indicates whether visual transition should be applied when a new page navigation occurred.

Remarks

By default, when you add a new UXFrame to your application, the navigation between pages will be displayed directly. The UXFrame control includes a dozen of predefined animation library which enables you to easily add stunning visual transitions to your navigation frame. To enable transition between page navigation, set the UXFrame property of the frame to true. When the page transition is enabled, you will notice a fading animation while navigating between pages.

 

public Style ErrorStyle { get; set; }

Specifies the style applied in the error page.

Remarks

UXFrame includes streamlined error management by providing a built-in friendly error page. When the navigation frame caught an exception that thrown during the navigation process, for instance, the page not found error, UXFrame shows a friendly error page instead of throwing a Javascript error message to the user. You can customize the error page with your own XAML template by setting the ErrorStyle property of the UXFrame control. For more information on how to customize error style, see Advanced Features in ClientUI Navigation Framework.

 

public TransitionEffect ForwardTransitionEffect { get; set; }

Gets or sets the transition effect when a forward navigation occurs.

Remarks

This transition will be applied when the frame is navigating forward.

 

public int FrameLevel { get; }

Gets the depth level of the the UXFrame in the visual hierarchy.

public JournalHistory History { get; set; }

Gets the JournalHistory instance for journal management of this control. This property is applicable only when AllowNestedFrameNavigation property is set to true.

public bool IsAuthenticated { get; }

Gets a value indicating whether the associated UXFrame is authenticated.

public bool IsAuthenticating { get; set; }

Gets or sets a value indicating whether the UXFrame is currently performing authentication process. When the property is set to true, the UXFrame will delay the navigation process until the authentication process is done.

Remarks

With the nature of Silverlight and WPF as a client-side platform, the user authentication is typically performed through an asynchronous callback to the server-side through web services such WCF RIA Services. In most cases, you want to prevent users to interact with your application while authentication is in progress, such as when login or logout operation is being performed. UXFrame streamlines the authentication process by providing UXFrame property, which makes it easy for you to track when authentication process is being executed. You can use MVVM pattern to manage this property in your ViewModel. When the UXFrame property is set to true, UXFrame automatically blocks the page from user interactions thus preventing users to work with the page while the authentication operation is in progress. More importantly, the UXFrame will hold the current navigation request until the authentication process is completed, which is indicated by the UXFrame property set to false. This behavior is designed to ensure consistent user experience in real-world applications that leverage authentication over the web service. For more information on how to customize error style, see Advanced Features in ClientUI Navigation Framework.

 

public bool IsBusy { get; set; }

Gets or sets a value indicating whether the page hosted by this UXFrame is in busy state.

public bool IsInitializing { get; set; }

Gets or sets a value indicating whether the UXFrame is currently waiting for asynchronous initialization to complete. When the property is set to true, the UXFrame will delay the navigation process until the initialization process is completed.

public bool IsLoading { get; }

Gets a value that determines whether this frame is currently in loading progress.

public bool IsPrimaryNavigator { get; set; }

Gets or sets a value that indicates whether this frame is the primary navigator when multiple frames existed in a page. By default, the navigation bar and commands is bound to the primary navigator when querying the navigation status or when executing navigation commands.

public FrameLoaderStyle LoaderAppearance { get; set; }

Specifies the mode that determines the visual appearance of the loader. The loader is shown when the frame is loading an external ApplicationPackage and the ShowLoadingProgress is set to true.

public Style LoaderStyle { get; set; }

Specifies the style applied in the loader page.

public TransitionEffect LoadingTransitionEffect { get; set; }

Gets or sets the transition effect when the frame is loading an external source.

public Uri NavigationState { get; set; }

Gets a value that represents the URI of the current navigation state. The value also combines the URI of the active child navigators, i.e., /Products/Category

public TransitionEffect NewTransitionEffect { get; set; }

Gets or sets the transition effect when a new navigation occurs.

public Uri OriginalSource { get; }

Gets a value that represents the original URI of the current source before mapped (for WPF compatibility purpose).

public FrameworkElement Owner { get; set; }

Gets the parent element that owns this frame.

public Style PresenterStyle { get; set; }

Gets or sets the style to apply to the presenter element.

public string ProgressText { get; set; }

Gets or sets the text displayed during download progress.

public Uri RedirectUri { get; set; }

Gets or sets the uniform resource identifier (URI) that will be navigated when the authentication is requested.

public bool ReloadContentOnChildNavigation { get; set; }

Gets or sets a value indicating whether the frame's content should be navigated when a child navigation occurred.

public bool RestoreVirtualizedUri { get; set; }

Determines whether virtual Uris should be restored after mapped.

public bool ShowLoadingProgress { get; set; }

Gets or sets a value that indicates whether the frame should display the loading progress of currently downloaded source.

public double TransitionDuration { get; set; }

Gets or sets the duration of the transition effect in seconds. If not specified, the default value is 0.3.

Remarks

By default, the visual transition is set to play for 0.3 seconds. You can customize how long the visual transition should play by setting the frame's TransitionDuration property to the desired value in seconds.

 

public double TransitionLatency { get; set; }

Gets or sets the time span (in seconds) to wait before the transition is performed. This property only applies when TransitionStrategy is set to WaitContentReady.

public TransitionStrategy TransitionStrategy { get; set; }

Gets or sets a value that determines how the control handles the transition process.

public UriMappingScope UriMappingScope { get; set; }

Gets or sets a value that determines the URI mapping scope applied to this navigation frame.

public bool UseCachedVisualForTransition { get; set; }

Gets or sets a value indicating whether a cached visual should be used instead of the actual element when performing transition.

public bool UseGlobalShell { get; set; }

Gets or sets a value that indicates whether this frame should use global UXShell instance if available.

public IPrincipal User { get; set; }

Gets or sets the System.Security.Principal.IPrincipal object representing the user to be authenticated.

public Collection<VirtualPath> VirtualPaths { get; }

Gets a collection of VirtualPath objects that associated to this frame.

Protected Properties

protected ProductInfo Product { get; }

Product Info.

Fields

public static readonly DependencyProperty AllowCancelDownloadProperty

Identifies the AllowCancelDownload dependency property.

public static readonly DependencyProperty AllowNestedFrameNavigationProperty

Identifies the AllowNestedFrameNavigation dependency property.

public static readonly DependencyProperty AutoDetectNavigationDirectionProperty

Identifies the AutoDetectNavigationDirection dependency property.

public static readonly DependencyProperty AutoMapApplicationsProperty

Identifies the AutoMapApplications dependency property.

public static readonly DependencyProperty BackTransitionEffectProperty

Identifies the BackTransitionEffect dependency property.

public static readonly DependencyProperty BusyIndicatorLatencyProperty

Identifies the BusyIndicatorLatency dependency property.

public static readonly DependencyProperty BusyIndicatorTemplateProperty

Identifies the BusyIndicator dependency property.

public static readonly DependencyProperty CornerRadiusProperty

Identifies the CornerRadius dependency property.

public static readonly DependencyProperty DefaultTransitionEffectProperty

Identifies the DefaultTransitionEffect dependency property.

public static readonly DependencyProperty DisplayFragmentInBrowserProperty

Identifies the DisplayFragmentInBrowser dependency property.

public static readonly DependencyProperty EnablePageTransitionProperty

Identifies the EnablePageTransition dependency property.

public static readonly DependencyProperty ErrorStyleProperty

Identifies the ErrorStyle dependency property.

public static readonly DependencyProperty ForwardTransitionEffectProperty

Identifies the ForwardTransitionEffect dependency property.

public static readonly DependencyProperty IsAuthenticatedProperty

Identifies the IsAuthenticated dependency property.

public static readonly DependencyProperty IsAuthenticatingProperty

Identifies the IsAuthenticating dependency property.

public static readonly DependencyProperty IsBusyProperty

Identifies the IsBusy dependency property.

public static readonly DependencyProperty IsInitializingProperty

Identifies the IsInitializing dependency property.

public static readonly RoutedEvent IsLoadingChangedEvent

Identifies the IsLoadingChanged routed event.

public static readonly DependencyProperty IsLoadingProperty

Identifies the IsLoading dependency property.

public static readonly DependencyProperty IsPrimaryNavigatorProperty

Identifies the IsPrimaryNavigator dependency property.

public static readonly DependencyProperty LoaderAppearanceProperty

Identifies the LoaderAppearance dependency property.

public static readonly DependencyProperty LoaderStyleProperty

Identifies the LoaderStyle dependency property.

public static readonly DependencyProperty LoadingTransitionEffectProperty

Identifies the LoadingTransitionEffect dependency property.

public static readonly DependencyProperty NavigationStateProperty

Identifies the NavigationState dependency property.

public static readonly DependencyProperty NewTransitionEffectProperty

Identifies the NewTransitionEffect dependency property.

public static readonly DependencyProperty PresenterStyleProperty

Identifies the PresenterStyle dependency property.

public static readonly DependencyProperty ProgressTextProperty

Identifies the ProgressText dependency property.

public static readonly DependencyProperty RedirectUriProperty

Identifies the RedirectUri dependency property.

public static readonly DependencyProperty ReloadContentOnChildNavigationProperty

Identifies the ReloadContentOnChildNavigation dependency property.

public static readonly DependencyProperty ShowLoadingProgressProperty

Identifies the ShowLoadingProgress dependency property.

public static readonly DependencyProperty TransitionDurationProperty

Identifies the TransitionDuration dependency property.

public static readonly DependencyProperty TransitionLatencyProperty

Identifies the TransitionLatency dependency property.

public static readonly DependencyProperty TransitionStrategyProperty

Identifies the TransitionStrategy dependency property.

public static readonly DependencyProperty UriMappingScopeProperty

Identifies the UriMappingScope dependency property.

public static readonly DependencyProperty UseCachedVisualForTransitionProperty

Identifies the PerformTransitionOnLoad dependency property.

public static readonly DependencyProperty UseGlobalShellProperty

Identifies the UseGlobalShell dependency property.

public static readonly DependencyProperty UserProperty

Identifies the User dependency property.

public static readonly DependencyProperty VirtualPathsProperty

Identifies the VirtualPaths dependency property.

Static Methods

public static UXFrame GetFrame(int level)

Gets the UXFrame instance based on the specified frame level.

Parameters

levelThe frame level to be returned.

Return Types

An UXFrame instance.

 

public static UXFrame GetFrameHost(UIElement source)

Returns the UXFrame instance that hosts the given UIElement.

Parameters

sourceThe source element to query.

Return Types

An UXFrame instance.

 

public static UXFrame GetPrimaryNavigator(UIElement source)

Returns the UXFrame instance which is the first-match primary navigator found in the specified source.

Parameters

sourceThe source element in which the frame should be located.

Return Types

An UXFrame instance.

 

public static Page GetResolvedPage(object element)

 

Parameters

element 

 

Public Methods

public void ClearApplicationSource()

Clear the application source previously loaded to the UXFrame instance.

public void DetachedEventHandlers()

Detach built-in event handlers from control templates. Call this method if necessary.

public void Dispose()

Called when the control is disposed.

public Page GetActiveNestedPage(UIElement page)

Returns the active page instance in the last hierarchy of nested child navigation structure.

Parameters

pageThe element representing the page to be searched from.

Return Types

Returns a Page object.

 

public string GetCurrentPageTitle()

Returns the page title of the currently loaded content.

Return Types

A string object representing the current page title.

 

public ContentTransition GetPresenterElement()

Gets the element that represents the content presenter.

Return Types

A ContentTransition object.

 

public UXShell GetShell()

Gets the UXShell instance that manages application life cycle for the UXFrame control.

Return Types

A UXShell object.

 

public bool Navigate(Uri uri, object extraData)

Navigates asynchronously to source content located at a uniform resource identifier (URI), and passes an object that contains data to be used for processing during navigation.

Parameters

uriA Uri object initialized with the URI for the desired content.
extraDataA Object that contains data to be used for processing during navigation.

Return Types

true if navigation is not canceled; otherwise, false.

 

public void OnApplyTemplate()

Builds the visual tree for the UXFrame when a new template is applied.

public void Reset()

Reset the UXFrame to the initial navigation state

public void SetContent(object content, bool animateIfPossible)

Sets the specified content directly to the UXFrame bypassing its navigation state.

Parameters

contentThe new content to be set onto this control.
animateIfPossibleDetermines whether transition should be used when possible.

 

public void StopLoading()

Stops the currently loading application. If the application is being downloaded, the download will be cancelled.

Protected Methods

protected void OnUnloaded(object sender, RoutedEventArgs e)

Called when the element is unloaded.

Parameters

senderThe sender of the event.
eThe event data for the property change.

 

Events

public event AuthenticatingEventHandler Authenticating

Occurs when the content hosted by the UXFrame is authenticating pages before they are presented to the container.

public event FragmentNavigationEventHandler FragmentNavigation

Occurs when navigation to a content fragment begins, which occurs immediately, if the desired fragment is in the current content, or after the source XAML content has been loaded, if the desired fragment is in different content.

Remarks

Occurs when navigation to a content fragment begins.

 

public event NavigationEventHandler IsLoadingChanged

Occurs when the IsLoading property value is changed.

public event AuthenticationEventHandler LoggedIn

Occurs when the UXFrame associated to the UXFrame is successfully authenticated.

Remarks

This event is raised when a user has been successfully authenticated and logged in, which is notified by the authentication service that bound to the UXFrame property.

 

public event AuthenticationEventHandler LoggedOut

Occurs when the UXFrame associated to the UXFrame is logged out.

Remarks

This event is raised when a user has been logged out from the authentication service.

 

public event NavigationEventHandler 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.

Remarks

Occurs when the page has been located and downloaded.

 

public event NavigatingCancelEventHandler Navigating

Occurs when a new navigation is requested.

Remarks

Occurs when a new navigation is requested. Can be used to cancel the navigation.

 

public event NavigationEventHandler NavigationCancelled

Occurs when the navigation progress is cancelled, either by users or through API calls.

Remarks

Occurs when the navigation is cancelled by user, such as when the Stop command is executed.

 

public event NavigationFailedEventHandler NavigationFailed

Occurs when an error is raised while navigating to the requested content.

Remarks

Occurs when an error is raised while navigating to the requested content.

 

public event NavigationProgressEventHandler NavigationProgress

Occurs periodically during a download to provide navigation progress information.

Remarks

Occurs periodically during a download to provide navigation progress information.

 

public event NavigationEventHandler NavigationStopped

Occurs when the StopLoading method is called, or when a new navigation is requested while a current navigation is in progress.

Remarks

Occurs when the navigation is stopped by calling StopLoading method, or when a new navigation is requested while a current navigation is in progress.

 

public event RequestingAuthenticationEventHandler RequestingAuthentication

Occurs when the content hosted by the UXFrame is requesting authentication.

Remarks

Occurs when the destination page is requesting authentication before the content is displayed.

 

public event NavigationDirectionChangedEventHandler ResolveNavigationDirection

Occurs when the NavigationDirection property is being resolved.

Remarks

Occurs when the navigation framework attempts to resolve the direction of the target page.
  • No labels