Interface IWindowManager

Defines the interface for a Window Manager.

Namespace: Phoenix.Views

Assembly: Phoenix.Abstractions.Views.dll

Syntax

public interface IWindowManager

Properties

AutoFocusActivatedTabs

Gets a value indicating whether the user is allowing Phoenix to auto-focus tabs.

Declaration

bool AutoFocusActivatedTabs { get; }

Property Value

Type	Description
System.Boolean

Shell

Gets the shell being used by this manager.

Declaration

IPhoenixShell Shell { get; }

Property Value

Type	Description
IPhoenixShell

ViewContractNames

Gets all the currently loaded contract names.

Declaration

IEnumerable<string> ViewContractNames { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>

WindowingControl

Declaration

IWindowingControl WindowingControl { get; }

Property Value

Type	Description
IWindowingControl

Methods

CloseViewWithContract(String)

Closes a view if it is open.

Declaration

void CloseViewWithContract(string contractName)

Parameters

Type	Name	Description
System.String	contractName	The contract name of the view to close.

FocusViewWithName(String)

Focuses the tab control to a specific view based on HeaderName.

Declaration

void FocusViewWithName(string headerName)

Parameters

Type	Name	Description
System.String	headerName	HeaderName to focus the control to.

NotifyForceExit()

Forces the window manager to call the Closed event.

Declaration

void NotifyForceExit()

Remarks

This is only meant to be called from the shell when an unhandled exception happens and we need to exit quickly and call the close event.

OpenViewWithContract(String)

Opens a view with the specific name.

Declaration

void OpenViewWithContract(string contractName)

Parameters

Type	Name	Description
System.String	contractName	The contract name of the view to open.

RegisterForCloseNotification(IClosingNotification)

Registers an object to be notified of Phoenix closing.

Declaration

void RegisterForCloseNotification(IClosingNotification closingNotification)

Parameters

Type	Name	Description
IClosingNotification	closingNotification	The object to register with the window manager for close notification.

ToggleViewInteractionState(String, Boolean)

Toggles the state of view interactions. This will either disable or enable any interactions with the view to include keyboard or mouse focus.

Declaration

void ToggleViewInteractionState(string viewHeaderName, bool shouldEnable)

Parameters

Type	Name	Description
System.String	viewHeaderName	Name of the view header.
System.Boolean	shouldEnable	Flag to determine whether the view interactions should be enabled or not.