FrameDocumentUIService Members

Allows you to show documents in a NavigationFrame.

Constructors

Name Description
FrameDocumentUIService() Initializes a new instance of the FrameDocumentUIService class.

Fields

Name Description
ActiveDocumentProperty static Identifies the FrameDocumentUIService.ActiveDocument dependency property.
ActiveViewProperty static Identifies the FrameDocumentUIService.ActiveView dependency property.
FrameProperty static Identifies the FrameNavigationService.Frame dependency property. Inherited from FrameNavigationService.
PageAdornerControlStyleProperty static Identifies the FrameDocumentUIService.PageAdornerControlStyle dependency property.
PageAdornerControlStyleSelectorProperty static Identifies the FrameDocumentUIService.PageAdornerControlStyleSelector dependency property.
PrefetchedSourcesProperty static Identifies the FrameNavigationService.PrefetchedSources dependency property. Inherited from FrameNavigationService.
ShowSplashScreenProperty static Identifies the FrameNavigationService.ShowSplashScreen dependency property. Inherited from FrameNavigationService.
SourceProperty static Identifies the FrameNavigationService.Source dependency property. Inherited from FrameNavigationService.
SplashScreenServiceProperty static Identifies the FrameNavigationService.SplashScreenService dependency property. Inherited from FrameNavigationService.
UnregisterOnUnloadedProperty static Identifies the ServiceBase.UnregisterOnUnloaded dependency property. Inherited from ServiceBase.
ViewLocatorProperty static Identifies the ViewServiceBase.ViewLocator dependency property. Inherited from ViewServiceBase.
ViewTemplateProperty static Identifies the ViewServiceBase.ViewTemplate dependency property. Inherited from ViewServiceBase.
ViewTemplateSelectorProperty static Identifies the ViewServiceBase.ViewTemplateSelector dependency property. Inherited from ViewServiceBase.

Properties

Name Description
ActiveDocument Gets or sets the active document. This is a dependency property.
ActiveView Gets the active view.
CanFreeze Gets a value that indicates whether the object can be made unmodifiable. Inherited from Freezable.
CanGoBack Returns whether backward navigation can be performed. Inherited from NavigationServiceBase.
CanGoForward Returns whether forward navigation can be performed. Inherited from NavigationServiceBase.
CanNavigate Gets a value indicating whether a NavigationFrame associated with the current service can navigate. Inherited from NavigationServiceBase.
Current Returns the current ViewModel. Inherited from NavigationServiceBase.
DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
Dispatcher Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
Documents Gets the collection of existing documents. Inherited from NavigationServiceBase.
Frame Gets or sets the Frame to which the current service is associated. Inherited from FrameNavigationService.
HasAnimatedProperties Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. Inherited from Animatable.
IsFrozen Gets a value that indicates whether the object is currently modifiable. Inherited from Freezable.
IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
PageAdornerControlStyle Gets or sets the style applied to a document's container (a PageAdornerControl object). This is a dependency property.
PageAdornerControlStyleSelector Gets or sets an object that chooses a style applied to a document's container (a PageAdornerControl object). This is a dependency property.
PrefetchedSources Gets or sets the collection of the predefined objects to display within the associated frame. Inherited from FrameNavigationService.
ShowSplashScreen Gets or sets whether this FrameNavigationService should display a splash screen when loading. This is a dependency property. Inherited from FrameNavigationService.
Source Gets or sets the View, initially displayed by the NavigationFrame, related to this FrameNavigationService. Inherited from FrameNavigationService.
SplashScreenService Gets or sets a splash screen service associated with this FrameNavigationService. This is a dependency property. Inherited from FrameNavigationService.
UnregisterOnUnloaded Inherited from ServiceBase.
ViewLocator Specifies the view locator. Inherited from ViewServiceBase.
ViewTemplate Specifies the view template. Inherited from ViewServiceBase.
ViewTemplateSelector Specifies the template selector that chooses a view template based on the passed view model. Inherited from ViewServiceBase.

Methods

Name Description
ApplyAnimationClock(DependencyProperty, AnimationClock) Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. Inherited from Animatable.
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. Inherited from Animatable.
BeginAnimation(DependencyProperty, AnimationTimeline) Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. Inherited from Animatable.
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. Inherited from Animatable.
CheckAccess() Determines whether the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
ClearCache() Clears the navigation cache. Inherited from NavigationServiceBase.
ClearNavigationHistory() Clears the navigation history. Inherited from NavigationServiceBase.
ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. Inherited from DependencyObject.
ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. Inherited from DependencyObject.
Clone() Creates a modifiable clone of this Animatable, making deep copies of this object's values. When copying this object's dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Inherited from Animatable.
CloneCore(Freezable) protected Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
CloneCurrentValue() Creates a modifiable clone (deep copy) of the Freezable using its current values. Inherited from Freezable.
CloneCurrentValueCore(Freezable) protected Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. Inherited from Freezable.
CoerceValue(DependencyProperty) Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. Inherited from DependencyObject.
CreateInstance() protected Initializes a new instance of the Freezable class. Inherited from Freezable.
Equals(Object) Determines whether a provided DependencyObject is equivalent to the current DependencyObject. Inherited from DependencyObject.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Freeze() Makes the current object unmodifiable and sets its IsFrozen property to true. Inherited from Freezable.
Freeze(Freezable, Boolean) protected static If the isChecking parameter is true, this method indicates whether the specified Freezable can be made unmodifiable. If the isChecking parameter is false, this method attempts to make the specified Freezable unmodifiable and indicates whether the operation succeeded. Inherited from Freezable.
GetAnimationBaseValue(DependencyProperty) Returns the non-animated value of the specified DependencyProperty. Inherited from Animatable.
GetAsFrozen() Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetAsFrozenCore(Freezable) protected Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
GetCurrentValueAsFrozen() Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetCurrentValueAsFrozenCore(Freezable) protected Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. Inherited from Freezable.
GetHashCode() Gets a hash code for this DependencyObject. Inherited from DependencyObject.
GetLocalValueEnumerator() Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. Inherited from DependencyObject.
GetType() Gets the Type of the current instance. Inherited from Object.
GetValue(DependencyProperty) Returns the current effective value of a dependency property on this instance of a DependencyObject. Inherited from DependencyObject.
GoBack() Navigates to the previous View if there is one in the navigation history. Inherited from NavigationServiceBase.
GoBack(Object) Navigates back to the previously selected screen (view). Inherited from NavigationServiceBase.
GoForward() Navigates to the next View if there is one in the navigation history. Inherited from NavigationServiceBase.
GoForward(Object) Navigates forward to the next screen (view). Inherited from NavigationServiceBase.
InvalidateProperty(DependencyProperty) Re-evaluates the effective value for the specified dependency property. Inherited from DependencyObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
Navigate(String, Object, Object) Navigates to a View with specific parameters. Inherited from NavigationServiceBase.
Navigate(String, Object, Object, Boolean) Navigates to a View with specific parameters. Allows you to skip writing an entry about this navigation to the Frame's Journal. Inherited from NavigationServiceBase.
Navigate(String, Object, Object, Object, Boolean) Performs navigation to the target View. Inherited from NavigationServiceBase.
OnChanged() protected Called when the current Freezable object is modified. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject) protected Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) protected This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. Inherited from Freezable.
OnPropertyChanged(DependencyPropertyChangedEventArgs) protected Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. Inherited from Freezable.
ReadLocalValue(DependencyProperty) Returns the local value of a dependency property, if it exists. Inherited from DependencyObject.
ReadPreamble() protected Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. Inherited from Freezable.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SetCurrentValue(DependencyProperty, Object) Sets the value of a dependency property without changing its value source. Inherited from DependencyObject.
SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. Inherited from DependencyObject.
SetValue(DependencyPropertyKey, Object) Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. Inherited from DependencyObject.
ShouldSerializeProperty(DependencyProperty) protected Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. Inherited from DependencyObject.
ShouldSerializeStoredWeakReference(DependencyObject) static Specifies whether a dependency object should be serialized. Inherited from Animatable.
ToString() Returns a string that represents the current object. Inherited from Object.
UpdateThemeName(FrameworkElement, FrameworkElement) static Inherited from ViewServiceBase.
VerifyAccess() Enforces that the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
WritePostscript() protected Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. Inherited from Freezable.
WritePreamble() protected Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. Inherited from Freezable.

Events

Name Description
ActiveDocumentChanged Fires after the service's active document has been successfully changed.
Changed Occurs when the Freezable or an object it contains is modified. Inherited from Freezable.
See Also