Class PageBase

This class inherits from System.Web.UI.Page, which has the core functionality for setting up and rendering a standard Web form (.aspx file.) The PageBase class extends the functionality of the Page class with EPiServer-specific features as access to configuration settings (Configuration property), user information (CurrentUser property) and information about the current EPiServer page (CurrentPage property.)

PageBase also implements the IPageSource interface, which enables you to retrieve other EPiServer pages easily.

The options parameter is a bitmap constructed from the OptionFlag of Page plugin classes from the EPiServer.Web.PageExtensions namespace.

The disable bitmap will override enabled options in case of conflicting options.

EPiServer will try to automatically translate texts of Web controls using the built-in translation system. By default this property is initialized to TranslateType.AllControls. If you know that there are no controls that contain text to be translated, set AutomaticTranslation to None to improve performance.

See TranslateType for more information about the behavior of automatic translation.

To enable the context menu you should make sure that ContextMenu.OptionFlag (in namespace EPiServer.Web.PageExtensions) is set for the PageBase constructor parameter.

A little caution is necessary when using CurrentPage in the HTML part of Web forms, as CurrentPage is implemented from IPageSource and UserControlBase also implements IPageSource. This means that CurrentPage will have different meanings in the same Web form depending on whether it's used outside any included EPiServer Web custom control in general and outside any templated EPiServer Web custom control in particular.

The page handler is used to retrieve the current page. By assignig your own implementation to this property you can take control over the process of retrieving the current page.

Parses the query string / form parameters to get the page reference.

This list will be read by the FullRefreshPropertiesMetaData and output as a comma separated list that that will be collected by the edit interface client.

The system will handle a missing id parameter by using the pageStartId value from EPiServer.Configuration.

The property will throw a System.NullReferenceException if SavePageHandler has not been defined.

Will return the static property Current if not set.

The save page handler is responsible for saving the current page. You may create your own implementation of ISavePage if you have very specific needs, but this is not recommended as it is a very complex task.

This method will perform different functions depending on the authentication method in use. If forms authentication is used, then it will redirect the user to the login page as defined in web.config. If windows authentication is used, an Access Denied header (http status 401) will be sent to the client.

This method is primarily intended to be used with a URL read from the PageURL property of a PageData class. In some special cases you may need to retarget the URL to another page or another version of the same page.

This method is called as part of the PageBase.OnInit method. It determines the current user's access level and compares it to the current page. If the user does not have sufficient access, the PageBase.AccessDenied method will be called.

The IPageSource interface is implemented by many classes, such as PageBase (and its descendants), DataFactory, PageControlBase. You typically use the members of this interface to get information about the current page (the CurrentPage property) or use either the GetPage or GetChildren methods to retrieve page data.

IPageSource was created as an interface due to the fact that the GetPage and GetChildren methods normally have the same implementation independently of the class that implements IPageSource. The CurrentPage property has different meanings for different implementations. As an example, CurrentPage on the PageBase class refers to the currently loaded page (based on the ID in the query string).

option is the OptionFlag value for one of the page extensions defined with the [PagePlugIn] attribute.

IsValue can be seen as a safe way to check whether a property exists and has been assigned contents.

We override this method to make sure that EPiServers script manager can render the script blocks needed.

Moves new data from web controls into the property objects or CurrentPage and also triggers the global validators.

Will return the actual access level for the current page, or Read if there is no current page.

This method simply checks that all bits set in RequiredAccess() are set in QueryAccess().

The relativePath will be used as the unique script key.

This is the default implementation that simply requests Read access, regardless of the type of requested operation.

This performs validation logic, and a save. If you must save without validation, use the SavePageHandler directly.

Override this method if you wish to customize the cache policy for a page. The output cache is turned on based on the following criteria:

1. The EPnCachePolicyTimeout in web.config is > 0.

2. The current user must not be logged on, aka Anonymous.

3. The request must be a GET type request. Hence, Postbacks and form postings will not be cached.

4. The current page must be the published version (the WorkID is == 0).

   The cache parameters are fetched from web.config, more specifically the EPsCacheVaryByCustom and EPsCacheVaryByParams settings. Additionally, a dependency to the DataFactoryCache is set. When pages are changed, the cache is flushed. Cache item expiration is set to the HttpCacheExpiration setting, which is the number of seconds the item should reside in the cache, as long as the StopPublish value of the page is not less than the policy timeout (in which case, the StopPublish value is used).

Used to update PagaData values when saving a page.

GetStringByCulture(String, CultureInfo) for more information on the format of the string to translate.

GetStringByCulture(String, CultureInfo) for more information on the format of the string to translate.

GetStringByCulture(String, CultureInfo) for more information on the format of the string to translate.

This method is called as part of the page load process. If a page (as determined by the ID query string parameter on the URL) is accessed with an .aspx file that is not the correct page template file, this method will throw an exception of type EPiServerException. If you have a page type that should be displayed using different page templates, you should override this method and do your custom validation. A validation error should be signalled by throwing an EPiServerException.

Attach to this event to be able to attach your code to specific events in the page lifecycle, allowing for your page extension to extend any page that derives from PageBase with your custom code.