The PageProviderBase type exposes the following members.
This method is typically not needed to call explicitly, the base class implementation will take care of adding the listing to cache after the listing has been delivered from GetChildrenReferences.
Add a PageData object to cache with default cache behavior.
Remove all pages served from this provider from the cache
Creates an URI given a page type and a pagelink
Copy a page to another container served by the same page provider.
Create a page language in storage. Base class implentation will return a writable PageData object initialized for the specified language and the page type given by the master language version of the page.
Delete a page from storage.
Delete children of a page. If delete is to be supported this method needs to be overriden.
Delete a language branch for a page.
Delete a single version of a page.
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.(Inherited from Object.)
Search for pages that fulfil specific criteria. Will ignore access rights. If the provider is to be searchable this method needs to be overriden.
Search for pages that fulfil specific criteria. If the provider is to be searchable this method needs to be overriden.
Retrieves the children for a specific page. The base class implementation will check for the list of references in the cache. If not found it will call GetChildrenReferences(PageReference, String). It will then try to load the pages from cache. For those pages not found in cache it will call GetPages(PageReferenceCollection, ILanguageSelector).
Should return references to all children of the specific page.
Get a PageData object with default values. Base class implementation will create a new PageData object with properties given by page type.
Gets all the descendents for the current page (that is at all levels). The base class implementation will do recursive calls to GetChildrenReferences.
Serves as a hash function for a particular type.(Inherited from Object.)
Get all language branches for a page. The base class implemenation will first load the master page. Then look for existing languages in PageLanguages and load all languages.
Gets the page on the language as specified by the language selector.
Read a single page from the storage. The default implementation will check for the page in the cache. If it is not found there it will call into method GetLocalPage(PageReference, ILanguageSelector)
The base class implementation will call GetPage(PageReference, ILanguageSelector) for each PageReference. If overriden the implementation should return all requested pages. A suggested implementation is to call SetInitializedLanguageBranch(LanguageSelectorContext) and then return pages in the language given by the passed in LanguageSelectorContext property SelectedLanguage, if the page does not exist in the specified language the page in master language branch should be returned.
Extract the properties (name and value) from a PageData instance. The properties returned is depending on parameter propertyTypes: It will always return all language specific properties and optionally more depending on passed in PropertyTypes. PageProviderBase..::.PropertyTypes is a bitwise enum which makes it possible to combine several bits to get the desired properties.
Gets the references to page and descendents. Override method to get references to this page and/or it's descendents, and get descendents for the page. The base class implementation will get descendents to the page(pageLink) passed in argument and then call into. So make sure that your page provider properly imlements that method.
Gets the references to pages. Override method to get all references to the given page.
Gets the Type of the current instance.(Inherited from Object.)
Ensures that a page has a unique URL segment (means it is unique among all its siblings on the same language).
This method will make sure that the UrlSegment is unique.
Initializes the provider with configuration seetings. Override this method to do any provider specific initialization.(Overrides ProviderBase..::.Initialize(String, NameValueCollection).)
Lists all pages that are set to delayed publish. Base class implementation does not support this method but returns new PageDataCollection(). If delay publishing is to be supported this method should be overriden.
Lists the published versions Default base class implementation has no versioning support so it uses GetLanguageBranches(PageReference) to get pages. If versioning is to be supported this method should be overriden.
Loads the specified version. Default base class implementation has no versioning support so it uses GetPage(PageReference, ILanguageSelector) to get page. If versioning is to be supported this method should be overriden.
Creates a shallow copy of the current Object.(Inherited from Object.)
Move a page to another container within the provider instance.
Move a page to the Wastebasket. Base class implementation calls Move(page, WastebasketReference). A suggested implementation is to set WastebasketReference as parent and set property "PageDeleted" to true.
Reset statistic counters
Save page to storage with specified action. If save is to be supported this method needs to be overriden
Sets the status of page, e.g. Published
Gets the capabilities that this page provider instance support. The base class implementation will during it's initialization read the passed in configuration values (Parse them to enum PageProviderCapabilities) and set the capabilities for the provider instance according to the passed in configuration values.
Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).(Inherited from ProviderBase.)
Gets the entry point which serves as root for this page provider instance.
Gets the icon path definied for the page provider.
Gets a value indicating whether this instance is the default provider.
Counts calls into the PageProviders cache for the children fetching
Counts the total fetching into the database and cache for children pages
Counts calls into the PageProvider for the children fetching
Gets the friendly name used to refer to the provider during configuration.(Overrides ProviderBase..::.Name.)
Counts calls into the PageProviders cache for the page fetchings
Counts the total fetching into the database and cache for pages
Counts calls into the PageProvider for page fetchings
Gets or sets the page folder virtual path provider.
Gets the configuration parameters for the page provider
Gets the provider cache key.
Gets the provider key that this PageProvider instance has. It is unique for the EPiServer instance. This is the value that is set on RemoteSite on each PageReference served by this provider instance.
Returns the statistics last start datetime
Gets or sets the supported virtual path provider.
Gets the reference to the waste basket for the page provider.