Click or drag to resize
IWebSiteExtender Interface
The interface for a wrapper around the extension methods exposed in IWebSite. Intended for use by plugins to make life a bit easier for those that want to extend the website.

Namespace: VirtualRadar.Interface.WebSite
Assembly: VirtualRadar.Interface (in VirtualRadar.Interface.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface IWebSiteExtender : IDisposable

The IWebSiteExtender type exposes the following members.

Properties
  NameDescription
Public propertyEnabled
Gets or sets a value indicating whether the extensions are enabled or disabled.
Public propertyInjectContent
Gets or sets a string that will be injected at the end of the HEAD tag for all of the pages in InjectPages.
Public propertyInjectPages
Gets a collection of pages that InjectContent will be injected into. If this is empty then the content will be injected into all pages.
Public propertyPageHandlers
Gets a map of page handler methods keyed by the address that they will handle.
Public propertyPriority
Gets or sets the priority of your plugin relative to the standard Virtual Radar Server web site and other plugins.
Public propertyWebRootSubFolder
Gets or sets the folder under the plugin's installation folder that contains the files to add to the root of the web site.
Top
Methods
  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodInitialise
Initialises the web extender.
Public methodInjectMapPages
Adds the map page addresses to InjectPages. Has no effect if called after Initialise(PluginStartupParameters).
Public methodInjectReportPages
Adds the report page addresses to InjectPages. Has no effect if called after Initialise(PluginStartupParameters).
Public methodProtectFolder
Marks a URL folder as protected. Only administrators may access protected folders.
Public methodRestrictAccessToFolder
Restricts access to a folder based on IP address.
Public methodUnprotectFolder
Marks a URL folder as unprotected. Anyone can access unprotected folders (subject to global authentication rules).
Top
See Also