WindowsUIView Members

Presents a DocumentManager's content in the Microsoft Windows 10-like style.

Constructors

Name Description
WindowsUIView() Initializes a new instance of the WindowsUIView class with the default settings.
WindowsUIView(IContainer) Initializes a new instance of the WindowsUIView class with the specified container.

Properties

Name Description
ActionButtonBackgroundImages Gets or sets the object that stores images used as custom background images for Navigation Bar actions.
ActiveContentContainer Gets the content container currently displayed within the current WindowsUIView.
ActiveDocument Gets the active document. Inherited from BaseView.
ActiveFloatDocument Gets the active floating document. Inherited from BaseView.
ActiveFlyoutContainer Gets the currently displayed Flyout.
AddTileWhenCreatingDocument Gets or sets whether a corresponding Tile should be automatically generated each time a new Document is added to the current WindowsUIView.
AllowCaptionDragMove Gets or sets whether end-users can drag the WindowsUIView's caption area to move the parent form.
AllowHotkeyNavigation This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class.
AllowResetLayout Gets or sets whether the current DocumentManager's layout can be reset to default. Inherited from BaseView.
Appearance Contains appearance settings for the current View. Inherited from BaseView.
AppearanceActionsBar Provides access to appearance settings used to paint the current WindowsUIView's navigation bars.
AppearanceActionsBarButton Provides access to appearance settings used to paint the current WindowsUIView's navigation bar actions.
AppearanceCaption Provides access to appearance settings used to paint the current WindowsUIView's caption.
AppearanceSearchPanel Provides access to the Search Panel appearance settings.
AppearanceSplashScreen Provides access to appearance settings of the current WindowsUIView's splash screen.
BackgroundImage Gets or sets the current DocumentManager's background image. Inherited from BaseView.
BackgroundImageLayoutMode Gets or sets the background image layout as defined in the ImageLayoutMode enumeration. Inherited from BaseView.
BackgroundImageStretchMargins Gets or sets stretching margins for a DocumentManager's background image in a View. Inherited from BaseView.
Bounds Gets the visual bounds of the current object. Inherited from BaseView.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Caption Gets or sets the current WindowsUIView's caption.
Container Gets the IContainer that contains the Component. Inherited from Component.
ContentContainerActions Provides access to Custom Navigation Bar Actions common to all Content Containers within the current WindowsUIView.
ContentContainers Provides access to the Content Containers collection used within the current WindowsUIView.
Controller Provides access to the current WindowsUIView's Controller.
CustomResizeZoneThickness Gets or sets the resize zone thickness. Inherited from BaseView.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DetailContainerProperties Provides access to properties of content containers that display individual documents, hosted within all SplitGroup and SlideGroup content containers that belong to this WindowsUIView.
DocumentProperties Provides access to properties common to all documents within the current View. Inherited from BaseView.
Documents Stores all documents displayed within the View. Inherited from BaseView.
DocumentSelectorProperties Provides access to appearance settings used for a Document Selector within the current view. Inherited from BaseView.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
FloatDocuments Provides access to floating documents. Inherited from BaseView.
FloatingDocumentContainer This member supports the internal infrastructure, and is not intended to be used directly from your code.
FloatPanels This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseView.
FlyoutProperties Provides access to general settings common to all Flyouts within the WindowsUIView.
IsDisposing Gets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent.
IsDocumentSelectorVisible Gets if a document selector for this BaseView is currently visible. Inherited from BaseView.
IsEmpty Gets whether a View is empty. Inherited from BaseView.
IsFocused Gets whether any document within the current View has focus. Inherited from BaseView.
IsInitialized Indicates whether or not the BaseComponent object has been fully initialized. Inherited from BaseComponent.
IsInitializing Returns whether or not the BaseComponent object is currently being initialized. Inherited from BaseComponent.
IsLoaded Gets whether the current object has been loaded. Inherited from BaseView.
IsLoading Gets whether the current object is being loaded. Inherited from BaseView.
IsLoadingAnimationInProgress Gets whether loading indicator animation is currently running within this View. Inherited from BaseView.
IsTransitionAnimationInProgress Gets whether transition animation is currently running within this WindowsUIView.
IsUpdateLocked Returns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent.
Items This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseView.
LoadingIndicatorProperties Provides access to appearance settings used for a loading indicator within the current BaseView. Inherited from BaseView.
Manager Gets a DocumentManager that owns the current View. Inherited from BaseView.
OptionsLayout Gets the object containing properties related to the current View's layout. Inherited from BaseView.
OverviewContainerProperties Provides access to settings common for all Overview Screens within the current WindowsUIView.
PageGroupProperties Provides access to settings used for all PageGroups within the current WindowsUIView.
PageProperties Provides access to properties common to all Pages within the current WindowsUIView.
SearchPanelProperties Provides access to the Search Panel properties.
Site Gets or sets the ISite of the Component. Inherited from Component.
SlideGroupProperties Provides access to settings common for all SlideGroups within the current WindowsUIView.
SplashScreenProperties Provides access to detailed settings of the current WindowsUIView's splash screen.
SplitGroupProperties Provides access to settings common for all SplitGroups within the current WindowsUIView.
Style Gets or sets the View style. Inherited from BaseView.
TabbedGroupProperties Provides access to properties common to all TabbedGroup containers within this WindowsUIView.
TileContainerProperties Provides access to settings common for all TileContainers within the current WindowsUIView.
TileProperties Provides access to settings common for all Tiles within the current WindowsUIView.
Tiles Provides zero-based indexed access to a collection of Tiles contained within the current WindowsUIView.
Type Gets the current WindowsUIView's type.
UseDocumentSelector The Document Selector is not supported for WindowsUIView.
UseLoadingIndicator Gets or sets if a loading indicator for deferred load should be used. Inherited from BaseView.
UseSnappingEmulation Gets or sets whether this BaseView uses snapping emulation for its child documents. Inherited from BaseView.
UseSplashScreen Gets or sets if a splash screen on the application start-up is used.
UseTransitionAnimation Gets or sets whether animation is enabled when navigating through Documents.
WindowsDialogProperties Gets an object containing settings related to the current DocumentManager's Windows dialog. Inherited from BaseView.
ZoomLevel Gets the type of the currently displayed WindowsUIView's screen.

Methods

Name Description
ActivateContainer(IContentContainer) Activates a specific Content Container within the WindowsUIView.
ActivateDocument(BaseDocument) Activates a specific Document within the WindowsUIView.
ActivateDocument(Control) Activates the document that displays the specified control. Inherited from BaseView.
ActivateTile(BaseTile) Activates the specific Tile and navigates to its Activation Target.
AddDocument(String, String) Adds an empty Document with specified BaseDocument.Caption and BaseDocument.ControlName properties to the current View. Inherited from BaseView.
AddDocument(Control) Adds a Document containing the specific control as content to the current BaseView. Inherited from BaseView.
AddFloatDocument(Control) Creates a new floating document that will display the specified control/form. Inherited from BaseView.
AddFloatDocument(Control, Point) Creates the floating document that hosts the target control and is displayed at the given position. Inherited from BaseView.
AddFloatDocument(Control, Point, Size) Creates a floating document that hosts the target control, has the required size, and is displayed in the given location. Inherited from BaseView.
AddFloatingDocumentsHost(BaseDocument) Creates a documents host window that contains the specified document. This method is in effect in the DocumentsHost mode. Inherited from BaseView.
AddFloatingDocumentsHost(BaseDocument[]) Creates a floating documents host (container) that will contain the specific BaseDocument objects collection. Inherited from BaseView.
AddFloatingDocumentsHost(Control) Creates a documents host window that contains a newly created document wrapping the specified control. This method is in effect in the DocumentsHost mode. Inherited from BaseView.
AddOrActivateDocument(Predicate<BaseDocument>, Func<Control>) Activates an existing document that contains the specific control. If no such document was found, a new document is created and added to this View. Inherited from BaseView.
BeginUpdate() Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. Inherited from BaseComponent.
CancelUpdate() Unlocks the BaseComponent object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseComponent.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
EndUpdate() Unlocks the BaseComponent object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseComponent.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
HideFlyout() Hides the currently displayed Flyout.
HideFlyout(DialogResult) Closes the currently displayed flyout with the specific outcome.
HideSearchPanel() Closes the Search Panel.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
LayoutChanged() Updates the element. Inherited from BaseComponent.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ReleaseDeferredLoadControl(BaseDocument) Disposes a specific deferred load Document within the current View. Inherited from BaseView.
ReleaseDeferredLoadControl(BaseDocument, Boolean) Fires the BaseView.ControlReleasing event with the specified parameter for the specified document. Inherited from BaseView.
ReleaseDeferredLoadControl(BaseDocument, Boolean, Boolean) Fires the BaseView.ControlReleasing event with the specified parameters for the specified document. Inherited from BaseView.
ReleaseDeferredLoadControls() Disposes all deferred load Documents within the current view. Inherited from BaseView.
ReleaseDeferredLoadControls(Boolean) Fires the BaseView.ControlReleasing event with the specified parameter for all documents with unreleased content in the current BaseView. Inherited from BaseView.
ReleaseDeferredLoadControls(Boolean, Boolean) Fires the BaseView.ControlReleasing event with the specified parameters for all documents with unreleased content in the current BaseView. Inherited from BaseView.
RemoveDocument(Control) Removes a document whose BaseDocument.Control property's value matches the specified control object. Inherited from BaseView.
RestoreLayoutFromRegistry(String) Restores the layout from a specific registry key. Inherited from BaseView.
RestoreLayoutFromStream(Stream) Restores the layout from a stream that contains data in binary format. Inherited from BaseView.
RestoreLayoutFromStream(Stream, Boolean) Restores the layout from a stream that contains data in a specific format. Inherited from BaseView.
RestoreLayoutFromXml(Stream) Restores the layout from a specific stream that contains data in XML format. Inherited from BaseView.
RestoreLayoutFromXml(String) Restores the layout from a specific XML file. Inherited from BaseView.
SaveLayoutToRegistry(String) Saves the layout in the system registry. Inherited from BaseView.
SaveLayoutToStream(Stream) Saves the layout in a specific stream in binary format. Inherited from BaseView.
SaveLayoutToStream(Stream, Boolean) Saves the layout in a specific stream in binary format. Inherited from BaseView.
SaveLayoutToXml(Stream) Saves the layout in a specific stream in XML format. Inherited from BaseView.
SaveLayoutToXml(String) Saves the layout in a specific file in XML format. Inherited from BaseView.
ShowFlyoutDialog(Flyout) Displays the specific Flyout as a modal window.
ShowSearchPanel() Displays the Search Panel.
ToString() Gets the text representation of the BaseView object. Inherited from BaseView.
UpdateDocumentActions() Refreshes document actions displayed within this WindowsUIView's child Content Containers.
UpdateNavigationBars() Updates all currently visible Navigation Bars.

Events

Name Description
BackButtonClick Fires when an end-user clicks a 'Back' button within a Navigation Bar.
BeginDocking Allows you to cancel docking a document onto the current control. Inherited from BaseView.
BeginDocumentsHostDocking Occurs whenever a Floating Documents Container starts docking to this BaseView. Inherited from BaseView.
BeginFloating Fires when an end-user starts to drag a docked document, so that it is transformed into a floating window. Inherited from BaseView.
BeginSizing Occurs when a resizing of the current View's layout begins. Inherited from BaseView.
ContentContainerActionCustomization Allows you to customize default Navigation Bar Actions.
ContentContainerActivated Fires when a Content Container gets activated.
ContentContainerAdded Fires when a Content Container is being added to the WindowsUIView.ContentContainers collection.
ContentContainerDeactivated Fires when a Content Container gets deactivated.
ContentContainerHeaderClick Occurs when an end-user clicks a Document header within any Content Container in this WindowsUIView.
ContentContainerRemoved Fires when a Content Container is being removed from the WindowsUIView.ContentContainers collection.
ControlLoaded Occurs after a control has been loaded to a Document within this BaseView. Inherited from BaseView.
ControlReleased Fires after the previously selected document is disposed. Inherited from BaseView.
ControlReleasing Occurs when a document is deselected and allows you to unbind the document from its content and dispose of the content. This event is in effect in Deferred Load mode. Inherited from BaseView.
ControlShown Fires when an empty document is loaded and displayed. Inherited from BaseView.
CustomDocumentsHostWindow Allows you to replace the default container for floating documents. Handle this event only when the BaseView.FloatingDocumentContainer property equals DocumentsHost. Inherited from BaseView.
CustomDrawBackButton Fires whenever the Back button needs to be displayed and allows you to manually draw this button.
CustomDrawBackground Occurs when the current View's background becomes visible to an end-user. Inherited from BaseView.
CustomizeSearchItems Occurs when the search panel is invoked. Allows you to customize search results and manually specify the content within which the search panel should look for the entered text.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DocumentActivated Fires when the View's BaseView.ActiveDocument property changes. Inherited from BaseView.
DocumentAdded Fires when a new document is added to the current View. Inherited from BaseView.
DocumentClosed Fires after a document has been closed. Inherited from BaseView.
DocumentClosing Fires when a document is about to be closed. Inherited from BaseView.
DocumentDeactivated Fires when a document is deactivated. Inherited from BaseView.
DocumentRemoved Fires when a document is removed from the BaseView.Documents collection. Inherited from BaseView.
DocumentSelectorCustomSortItems Allows you to manually sort documents and dock panels displayed within the Document Selector. Inherited from BaseView.
DocumentSelectorHidden Fires when a document selector is closed. Inherited from BaseView.
DocumentSelectorShown Fires when a document selector is displayed. Inherited from BaseView.
EmptyDocumentsHostWindow Fires when the last floating document in the documents host window is closed or the control it contains is disposed, allowing you to specify whether to keep open the empty documents host window. Inherited from BaseView.
EndDocking Fires after a document has been docked to the control. Inherited from BaseView.
EndDocumentsHostDocking Occurs when a Floating Document Container with all its child Documents is docked to a View. Inherited from BaseView.
EndFloating Fires after an end-user drops a floating document. Inherited from BaseView.
EndSizing Occurs when resizing the current View's layout is complete. Inherited from BaseView.
Floating Fires when a docked document becomes floating. Inherited from BaseView.
FlyoutHidden Occurs when a Flyout within the WindowsUIView is completely closed.
FlyoutHiding Occurs when a Flyout within the WindowsUIView is to be closed.
FlyoutShowing Occurs when a Flyout is to be displayed.
FlyoutShown Occurs after a Flyout within the WindowsUIView is completely displayed.
GotFocus Fires when focus is moved to any document within the current View. Inherited from BaseView.
HierarchyChanged Occurs when the application's hierarchy (navigation tree) has been changed.
Layout Occurs whenever the current DocumentManager's layout is being modified. Inherited from BaseView.
LayoutReset Fires after a DocumentManager's layout was reset. Inherited from BaseView.
LayoutResetting Occurs when the current BaseView's layout is to be reset. Inherited from BaseView.
LayoutUpgrade Occurs after a layout whose version doesn't match the current layout's version has been loaded from storage (a stream, xml file or system registry). Inherited from BaseView.
LoadingIndicatorShowing Occurs when the loading indicator is shown within this BaseView. Inherited from BaseView.
LostFocus Fires when focus is moved from the current View's document to any external control (for instance, to an external DockPanel). Inherited from BaseView.
NavigatedFrom Occurs when a current Content Container is deactivated.
NavigatedTo Occurs when a new Content Container is activated.
NavigationBarsButtonClick Occurs when an end-user clicks an action within a Navigation Bar.
NavigationBarsHidden Fires when navigation bars are hidden.
NavigationBarsShowing Occurs when Navigation Bars are to be displayed.
NavigationBarsShown Fires when navigation bars are shown.
NextDocument Fires when an end-user tries to switch to the next or previous document by pressing CTRL+TAB or CTRL+SHIFT+TAB. Inherited from BaseView.
Paint Occurs when the BaseView is redrawn. Inherited from BaseView.
PopupMenuShowing Fires when a context menu is about to be displayed. Inherited from BaseView.
QueryControl Occurs when a document is to be displayed and allows you to assign content to this document. This event is in effect in Deferred Load mode. Inherited from BaseView.
QueryDocumentActions Allows you to add How To: Create Custom Document Actions to Content Containers within the current WindowsUIView.
QueryFlyoutActionsControl Allows you to assign content for popup container actions.
QueryStartupContentContainer Fires at the WindowsUIView application start-up.
RegisterDocumentsHostWindow Fires when a document is made floating and provides access to the created documents host window. This allows subscribing its DocumentManager to existing event handlers. This event is in effect in the DocumentsHost mode. Inherited from BaseView.
SearchItemClick Occurs when end-users click any item displayed by the WindowsUIView's Search Panel.
SearchPanelHidden Occurs after the Search Panel is completely closed.
SearchPanelShowing Occurs when the Search Panel is about to be displayed.
SearchPanelShown Occurs after the Search Panel is displayed.
ShowingDockGuides Allows you to hide dock guides and hints that appear when a user drags a Document or a DockPanel. Inherited from BaseView.
TileAdded Occurs when a Tile is added to the current WindowsUIView.
TileCheckedChanged Occurs when the checked state for any Tile within the current WindowsUIView was changed.
TileClick Occurs when any Tile within the current WindowsUIView is clicked.
TilePress Occurs when any Tile within the WindowsUIView is pressed.
TileRemoved Occurs when a Tile is removed from the current WindowsUIView.
UnregisterDocumentsHostWindow Fires when a documents host window is closed and allows you to unsubscribe event handlers from its DocumentManager. Inherited from BaseView.
See Also