IWebMatrixHost Interface

Applies to v2.

Defines a method for interacting with the WebMatrix host.

Namespace:  Microsoft.WebMatrix.Extensibility
Assembly:  Microsoft.WebMatrix.Extensibility (in Microsoft.WebMatrix.Extensibility.dll)

Syntax

'Declaration
Public Interface IWebMatrixHost
'Usage
Dim instance As IWebMatrixHost
public interface IWebMatrixHost
public interface class IWebMatrixHost
type IWebMatrixHost =  interface end
public interface IWebMatrixHost

The IWebMatrixHost type exposes the following members.

Properties

  Name Description
Public property DefaultWebSitePath Gets the default path for storing web sites.
Public property HostCommands Gets an object that exposes commands supported by the host.
Public property Version Gets the user-friendly version of the host.
Public property WebSite Gets the current web site.
Public property Workspace Gets or sets the current workspace.
Public property Workspaces Gets a collection of available workspaces.

Top

Methods

  Name Description
Public method ApplyPathProtection Applies a set of IProtectPathInfo rules to the site's files.
Public method CreateWaitDialog Creates a wait dialog.
Public method GetExtensionSpecificPreferences Provides access to a global preferences access, each extension should pass a unique GUID.
Public method GetSiteItem Gets an ISiteItem from a HierarchyId.
Public method ShowDialog(String, String, DialogSize, MessageBoxButton, MessageBoxResult, ICommand()) Indicates a value whether the command will show a dialog command.
Public method ShowDialog(String, UIElement, DialogSize, MessageBoxButton, MessageBoxResult, ICommand()) Indicates a value whether the command will show a dialog command.
Public method ShowExceptionMessage Shows a message as a result of an exception.
Public method ShowFolderDialog Opens the appropriate folder browsing dialog box, depending on the operating system version.
Public method ShowNotification Shows a notification message and an actionable link for a brief period of time.

Top

Events

  Name Description
Public event ContextMenuOpening Occurs when the user opens a context menu for an item in the tree view.
Public event TreeItemCreated Occurs when an item is added to the file tree.
Public event TreeItemRemoved Occurs when an item is removed from the file tree.
Public event WebSiteChanged Occurs when the current web site changes.
Public event WorkspaceChanged Occurs when the current workspace changes.

Top

See Also

Reference

Microsoft.WebMatrix.Extensibility Namespace