Show / Hide Table of Contents

Class Frame

Represents a content control that supports navigation.

Inheritance
System.Object
DependencyObject
UIElement
FrameworkElement
Control
ContentControl
Frame
Implements
INavigate
Inherited Members
ContentControl.Content
ContentControl.ContentProperty
ContentControl.ContentTemplate
ContentControl.ContentTemplateProperty
ContentControl.OnContentChanged(Object, Object)
ContentControl.LogicalChildren
Control.EnableBaseControlHandlingOfVisualStates
Control.ManageIsEnabled(Boolean)
Control.Background
Control.BackgroundProperty
Control.BorderBrush
Control.BorderBrushProperty
Control.BorderThickness
Control.BorderThicknessProperty
Control.FontWeight
Control.FontWeightProperty
Control.FontStyle
Control.FontStyleProperty
Control.Foreground
Control.ForegroundProperty
Control.FontFamily
Control.FontFamilyProperty
Control.FontSize
Control.FontSizeProperty
Control.TextDecorations
Control.TextDecorationsProperty
Control.Padding
Control.PaddingProperty
Control.HorizontalContentAlignment
Control.HorizontalContentAlignmentProperty
Control.VerticalContentAlignment
Control.VerticalContentAlignmentProperty
Control.TabIndex
Control.TabIndexProperty
Control.IsTabStop
Control.IsTabStopProperty
Control.TabNavigation
Control.TabNavigationProperty
Control.Template
Control.TemplateProperty
Control.ApplyTemplate()
Control.GetTemplateChild(String)
Control.Focus()
Control.HandlesScrolling
Control.OnGotFocus(RoutedEventArgs)
Control.OnLostFocus(RoutedEventArgs)
Control.CreateDomElement(Object, Object)
Control.CharacterSpacingProperty
Control.CharacterSpacing
Control.FontStretchProperty
Control.FontStretch
Control.OnDrop(DragEventArgs)
Control.OnDragEnter(DragEventArgs)
Control.OnDragLeave(DragEventArgs)
Control.OnTextInputUpdate(TextCompositionEventArgs)
Control.MeasureOverride(Size)
Control.ArrangeOverride(Size)
FrameworkElement.LayoutUpdated
FrameworkElement.SizeChanged
FrameworkElement.ResourceLookupMode
FrameworkElement.StyleProperty
FrameworkElement.Style
FrameworkElement.DefaultStyleKeyProperty
FrameworkElement.DefaultStyleKey
FrameworkElement.OverridesDefaultStyleProperty
FrameworkElement.OverridesDefaultStyle
FrameworkElement.OnVisualParentChanged(DependencyObject)
FrameworkElement.VisualChildrenCount
FrameworkElement.GetVisualChild(Int32)
FrameworkElement.Parent
FrameworkElement.AddLogicalChild(Object)
FrameworkElement.RemoveLogicalChild(Object)
FrameworkElement.TemplatedParent
FrameworkElement.Resources
FrameworkElement.IsLoaded
FrameworkElement.SetBinding(DependencyProperty, BindingBase)
FrameworkElement.SetBinding(DependencyProperty, Binding)
FrameworkElement.GetBindingExpression(DependencyProperty)
FrameworkElement.Cursor
FrameworkElement.CursorProperty
FrameworkElement.FindName(String)
FrameworkElement.Name
FrameworkElement.NameProperty
FrameworkElement.DataContext
FrameworkElement.DataContextProperty
FrameworkElement.DataContextChanged
FrameworkElement.Triggers
FrameworkElement.FlowDirectionProperty
FrameworkElement.FlowDirection
FrameworkElement.LanguageProperty
FrameworkElement.Language
FrameworkElement.OnPropertyChanged(DependencyPropertyChangedEventArgs)
FrameworkElement.Tag
FrameworkElement.TagProperty
FrameworkElement.LoadedEvent
FrameworkElement.Loaded
FrameworkElement.Unloaded
FrameworkElement.BindingValidationError
FrameworkElement.ContextMenuProperty
FrameworkElement.ContextMenu
FrameworkElement.ContextMenuOpening
FrameworkElement.ToolTipProperty
FrameworkElement.ToolTip
FrameworkElement.INTERNAL_OnDetachedFromVisualTree()
FrameworkElement.INTERNAL_OnAttachedToVisualTree()
FrameworkElement.Height
FrameworkElement.HeightProperty
FrameworkElement.Width
FrameworkElement.WidthProperty
FrameworkElement.HorizontalAlignment
FrameworkElement.HorizontalAlignmentProperty
FrameworkElement.VerticalAlignment
FrameworkElement.VerticalAlignmentProperty
FrameworkElement.Margin
FrameworkElement.MarginProperty
FrameworkElement.MinHeight
FrameworkElement.MinHeightProperty
FrameworkElement.MinWidth
FrameworkElement.MinWidthProperty
FrameworkElement.MaxHeight
FrameworkElement.MaxHeightProperty
FrameworkElement.MaxWidth
FrameworkElement.MaxWidthProperty
FrameworkElement.ActualWidthProperty
FrameworkElement.ActualWidth
FrameworkElement.ActualHeightProperty
FrameworkElement.ActualHeight
UIElement.TransformToVisual(UIElement)
UIElement.RenderSize
UIElement.DesiredSize
UIElement.InvalidateMeasure()
UIElement.InvalidateArrange()
UIElement.Measure(Size)
UIElement.Arrange(Rect)
UIElement.UpdateLayout()
UIElement.DragEnter
UIElement.DragLeave
UIElement.Drop
UIElement.DragOver
UIElement.CacheMode
UIElement.CacheModeProperty
UIElement.Projection
UIElement.ProjectionProperty
UIElement.VisualParent
UIElement.AddVisualChild(UIElement)
UIElement.RemoveVisualChild(UIElement)
UIElement.OnVisualChildrenChanged(DependencyObject, DependencyObject)
UIElement.XamlSourcePath
UIElement.ClipToBounds
UIElement.ClipToBoundsProperty
UIElement.ClipProperty
UIElement.Clip
UIElement.IsEnabledProperty
UIElement.IsEnabled
UIElement.IsEnabledChanged
UIElement.EffectProperty
UIElement.Effect
UIElement.RenderTransformProperty
UIElement.RenderTransform
UIElement.RenderTransformOriginProperty
UIElement.RenderTransformOrigin
UIElement.UseLayoutRounding
UIElement.UseLayoutRoundingProperty
UIElement.Visibility
UIElement.VisibilityProperty
UIElement.IsVisibleProperty
UIElement.IsVisible
UIElement.IsVisibleChanged
UIElement.OpacityProperty
UIElement.Opacity
UIElement.OpacityMaskProperty
UIElement.OpacityMask
UIElement.IsHitTestVisible
UIElement.IsHitTestVisibleProperty
UIElement.AllowDrop
UIElement.AllowDropProperty
UIElement.CaptureMouse()
UIElement.IsMouseCaptured
UIElement.ReleaseMouseCapture()
UIElement.AllowScrollOnTouchMove
UIElement.AllowScrollOnTouchMoveProperty
UIElement.AddHandler(RoutedEvent, Delegate, Boolean)
UIElement.RemoveHandler(RoutedEvent, Delegate)
UIElement.MouseMoveEvent
UIElement.MouseMove
UIElement.OnMouseMove(MouseEventArgs)
UIElement.MouseLeftButtonDownEvent
UIElement.MouseLeftButtonDown
UIElement.OnMouseLeftButtonDown(MouseButtonEventArgs)
UIElement.MouseRightButtonDownEvent
UIElement.MouseRightButtonDown
UIElement.OnMouseRightButtonDown(MouseButtonEventArgs)
UIElement.MouseWheelEvent
UIElement.MouseWheel
UIElement.OnMouseWheel(MouseWheelEventArgs)
UIElement.MouseLeftButtonUpEvent
UIElement.MouseLeftButtonUp
UIElement.OnMouseLeftButtonUp(MouseButtonEventArgs)
UIElement.MouseEnterEvent
UIElement.MouseEnter
UIElement.OnMouseEnter(MouseEventArgs)
UIElement.MouseLeaveEvent
UIElement.MouseLeave
UIElement.OnMouseLeave(MouseEventArgs)
UIElement.TextInputStartEvent
UIElement.TextInputStart
UIElement.OnTextInputStart(TextCompositionEventArgs)
UIElement.TextInputEvent
UIElement.TextInput
UIElement.OnTextInput(TextCompositionEventArgs)
UIElement.TextInputUpdateEvent
UIElement.TextInputUpdate
UIElement.TappedEvent
UIElement.Tapped
UIElement.OnTapped(TappedRoutedEventArgs)
UIElement.MouseRightButtonUpEvent
UIElement.MouseRightButtonUp
UIElement.OnMouseRightButtonUp(MouseButtonEventArgs)
UIElement.KeyDownEvent
UIElement.KeyDown
UIElement.OnKeyDown(KeyEventArgs)
UIElement.KeyUpEvent
UIElement.KeyUp
UIElement.OnKeyUp(KeyEventArgs)
UIElement.GotFocusEvent
UIElement.GotFocus
UIElement.LostFocusEvent
UIElement.LostFocus
UIElement.LostMouseCapture
UIElement.OnLostMouseCapture(MouseEventArgs)
UIElement.INTERNAL_AttachToDomEvents()
UIElement.INTERNAL_DetachFromDomEvents()
DependencyObject.GetValue(DependencyProperty)
DependencyObject.SetCurrentValue(DependencyProperty, Object)
DependencyObject.ReadLocalValue(DependencyProperty)
DependencyObject.SetValue(DependencyProperty, Object)
DependencyObject.SetValue(DependencyPropertyKey, Object)
DependencyObject.CoerceValue(DependencyProperty)
DependencyObject.Dispatcher
DependencyObject.ClearValue(DependencyProperty)
DependencyObject.ClearValue(DependencyPropertyKey)
DependencyObject.CheckAccess()
DependencyObject.GetAnimationBaseValue(DependencyProperty)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: System.Windows.Controls
Assembly: OpenSilver.Controls.Navigation.dll
Syntax
[TemplatePart(Name = "NextButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PrevButton", Type = typeof(ButtonBase))]
public class Frame : ContentControl, IControl, IFrameworkElement, IUIElement, IDependencyObject, INavigate

Constructors

| Improve this Doc View Source

Frame()

Initializes a new instance of the Frame class.

Declaration
public Frame()

Fields

| Improve this Doc View Source

CacheSizeProperty

The DependencyProperty for the CacheSize property.

Declaration
public static readonly DependencyProperty CacheSizeProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

CanGoBackProperty

The DependencyProperty for the CanGoBack property.

Declaration
public static readonly DependencyProperty CanGoBackProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

CanGoForwardProperty

The DependencyProperty for the CanGoForward property.

Declaration
public static readonly DependencyProperty CanGoForwardProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

ContentLoaderProperty

The DependencyProperty for the ContentLoader property.

Declaration
public static readonly DependencyProperty ContentLoaderProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

CurrentSourceProperty

The DependencyProperty for the CurrentSource property.

Declaration
public static readonly DependencyProperty CurrentSourceProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

JournalOwnershipProperty

The DependencyProperty for the JournalOwnership property.

Declaration
public static readonly DependencyProperty JournalOwnershipProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

SourceProperty

The DependencyProperty for the Source property.

Declaration
public static readonly DependencyProperty SourceProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

UriMapperProperty

The DependencyProperty for the UriMapper property.

Declaration
public static readonly DependencyProperty UriMapperProperty
Field Value
Type Description
DependencyProperty

Properties

| Improve this Doc View Source

CacheSize

Gets or sets the number of pages that can be cached for the frame.

Declaration
public int CacheSize { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

CanGoBack

Gets a value that indicates whether there is at least one entry in the back navigation history.

Declaration
public bool CanGoBack { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CanGoForward

Gets a value that indicates whether there is at least one entry in the forward navigation history.

Declaration
public bool CanGoForward { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ContentLoader

Gets or sets whether a frame is responsible for managing its own navigation history, or whether it integrates with the web browser journal.

Declaration
public INavigationContentLoader ContentLoader { get; set; }
Property Value
Type Description
INavigationContentLoader
| Improve this Doc View Source

CurrentSource

Gets the uniform resource identifier (URI) of the content that was last navigated to.

Declaration
public Uri CurrentSource { get; }
Property Value
Type Description
System.Uri
Remarks

This value may be different from Source if you set Source and the navigation has not yet completed. CurrentSource reflects the page currently in the frame at all times, even when an async loading operation is in progress.

| Improve this Doc View Source

JournalOwnership

Gets or sets whether a frame is responsible for managing its own navigation history, or whether it integrates with the web browser journal.

Declaration
public JournalOwnership JournalOwnership { get; set; }
Property Value
Type Description
JournalOwnership
| Improve this Doc View Source

Source

Gets or sets the uniform resource identifier (URI) of the current content or the content that is being navigated to.

Declaration
public Uri Source { get; set; }
Property Value
Type Description
System.Uri
Remarks

This value may be different from CurrentSource if you set Source and the navigation has not yet completed. CurrentSource reflects the page currently in the frame at all times, even when an async loading operation is in progress.

| Improve this Doc View Source

UriMapper

Gets or sets the object to manage converting a uniform resource identifier (URI) to another URI for this frame.

Declaration
public UriMapperBase UriMapper { get; set; }
Property Value
Type Description
UriMapperBase

Methods

| Improve this Doc View Source

GoBack()

Navigates to the most recent entry in the back navigation history, if one exists.

Declaration
public void GoBack()
| Improve this Doc View Source

GoForward()

Navigates to the most recent entry in the forward navigation history, if one exists.

Declaration
public void GoForward()
| Improve this Doc View Source

Navigate(Uri)

Navigates to the content specified by the uniform resource identifier (URI).

Declaration
public bool Navigate(Uri source)
Parameters
Type Name Description
System.Uri source

The URI representing a page to display in the frame.

Returns
Type Description
System.Boolean

Always returns true.

| Improve this Doc View Source

OnApplyTemplate()

Called when the template generation for the visual tree is created.

Declaration
public override void OnApplyTemplate()
Overrides
Control.OnApplyTemplate()
| Improve this Doc View Source

OnCreateAutomationPeer()

Returns a FrameAutomationPeer for use by the Silverlight automation infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type Description
AutomationPeer

A FrameAutomationPeer for the Frame object.

Overrides
UIElement.OnCreateAutomationPeer()
| Improve this Doc View Source

Refresh()

Refreshes the current page

Declaration
public void Refresh()
| Improve this Doc View Source

StopLoading()

Stops further downloading of content for the current navigation request.

Declaration
public void StopLoading()

Events

| Improve this Doc View Source

FragmentNavigation

Occurs when navigation to a content fragment begins.

Declaration
public event FragmentNavigationEventHandler FragmentNavigation
Event Type
Type Description
FragmentNavigationEventHandler
| Improve this Doc View Source

Navigated

Occurs when the content that is being navigated to has been found and is available.

Declaration
public event NavigatedEventHandler Navigated
Event Type
Type Description
NavigatedEventHandler
| Improve this Doc View Source

Navigating

Occurs when a new navigation is requested.

Declaration
public event NavigatingCancelEventHandler Navigating
Event Type
Type Description
NavigatingCancelEventHandler
| Improve this Doc View Source

NavigationFailed

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

Declaration
public event NavigationFailedEventHandler NavigationFailed
Event Type
Type Description
NavigationFailedEventHandler
| Improve this Doc View Source

NavigationStopped

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

Declaration
public event NavigationStoppedEventHandler NavigationStopped
Event Type
Type Description
NavigationStoppedEventHandler

Implements

INavigate

Extension Methods

DependencyObjectHelper.GetSelfAndAncestors(DependencyObject)
UIElementExtendedRoutedEventExtensions.AddHandler(UIElement, ExtendedRoutedEvent, Delegate, Boolean)
UIElementExtendedRoutedEventExtensions.RemoveHandler(UIElement, ExtendedRoutedEvent, Delegate)
VisualTreeExtensions.GetVisualAncestors(DependencyObject)
VisualTreeExtensions.GetVisualAncestorsAndSelf(DependencyObject)
VisualTreeExtensions.GetVisualChildren(DependencyObject)
VisualTreeExtensions.GetVisualChildrenAndSelf(DependencyObject)
VisualTreeExtensions.GetVisualDescendants(DependencyObject)
VisualTreeExtensions.GetVisualDescendantsAndSelf(DependencyObject)
VisualTreeExtensions.GetVisualSiblings(DependencyObject)
VisualTreeExtensions.GetVisualSiblingsAndSelf(DependencyObject)
VisualTreeExtensions.GetBoundsRelativeTo(FrameworkElement, UIElement)
VisualTreeExtensions.InvokeOnLayoutUpdated(FrameworkElement, Action)

See Also

Page
  • Improve this Doc
  • View Source