Class ViewProviderInfo

Contains information about the dock state of a specific view.

Inheritance
System.Object
ViewProviderInfo
Inherited Members
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: Phoenix.WindowManagement
Assembly: Phoenix.Core.dll
Syntax
public class ViewProviderInfo

Constructors

View Source

ViewProviderInfo(Type, String, Boolean, Boolean, ViewRegion)

Declaration
public ViewProviderInfo(Type viewProviderType, string menuName, bool isClosable = true, bool isDockable = true, ViewRegion viewRegion = ViewRegion.Plugins)
Parameters
Type Name Description
System.Type viewProviderType
System.String menuName
System.Boolean isClosable
System.Boolean isDockable
ViewRegion viewRegion

Properties

View Source

ContractName

Gets the contract name for the view provider.

Declaration
public string ContractName { get; }
Property Value
Type Description
System.String
View Source

IsClosable

Gets a value indicating whether this view can be closed.

Declaration
public bool IsClosable { get; }
Property Value
Type Description
System.Boolean
View Source

IsClosed

Gets a value indicating whether this view is closed or not.

Declaration
public bool IsClosed { get; }
Property Value
Type Description
System.Boolean
View Source

IsDockable

Gets a value indicating whether this view can be docked.

Declaration
public bool IsDockable { get; }
Property Value
Type Description
System.Boolean
View Source

IsDocked

Gets or sets a value indicating whether this view is docked or not.

Declaration
public bool IsDocked { get; set; }
Property Value
Type Description
System.Boolean
View Source

MenuName

Gets the menu name for this view provider.

Declaration
public string MenuName { get; }
Property Value
Type Description
System.String
View Source

ProviderInstance

Gets the instance of this provider.

Declaration
public IViewProvider ProviderInstance { get; }
Property Value
Type Description
IViewProvider
View Source

ViewProviderType

Gets the type of this ViewProvider.

Declaration
public Type ViewProviderType { get; }
Property Value
Type Description
System.Type
View Source

ViewRegion

Gets the region this view occupies when docked.

Declaration
public ViewRegion ViewRegion { get; }
Property Value
Type Description
ViewRegion

Methods

View Source

CheckClosingProvider()

Sends Closing event to the current view provider.

Declaration
public bool CheckClosingProvider()
Returns
Type Description
System.Boolean

True if the closing was allowed (not canceled), otherwise false.
View Source

CloseProvider()

Closes and releases the current view provider, notifying the view that it has closed.

Declaration
public void CloseProvider()
View Source

OpenProvider(IServiceProvider)

Declaration
public IViewProvider OpenProvider(IServiceProvider serviceProvider)
Parameters
Type Name Description
System.IServiceProvider serviceProvider
Returns
Type Description
IViewProvider