The PageProviderBase type exposes the following members.

Constructors

  NameDescription
PageProviderBase
Initializes a new instance of the PageProviderBase class.

Methods

  NameDescription
AddChildrenListingToCache
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.
AddPageToCache
Add a PageData object to cache with default cache behavior.
ClearProviderPagesFromCache
Remove all pages served from this provider from the cache
ConstructPageReferenceOverloaded.
ConstructPageUri
Creates an URI given a page type and a pagelink
Copy
Copy a page to another container served by the same page provider.
CreateLanguageBranch
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
Delete a page from storage.
DeleteChildren
Delete children of a page. If delete is to be supported this method needs to be overriden.
DeleteLanguageBranch
Delete a language branch for a page.
DeleteVersion
Delete a single version of a page.
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
FindAllPagesWithCriteria
Search for pages that fulfil specific criteria. Will ignore access rights. If the provider is to be searchable this method needs to be overriden.
FindPagesWithCriteria
Search for pages that fulfil specific criteria. If the provider is to be searchable this method needs to be overriden.
GetChildren
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).
GetChildrenReferences
Should return references to all children of the specific page.
GetDefaultPageData
Get a PageData object with default values. Base class implementation will create a new PageData object with properties given by page type.
GetDescendents
Gets all the descendents for the current page (that is at all levels). The base class implementation will do recursive calls to GetChildrenReferences.
GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
GetLanguageBranches
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.
GetLocalPage
Gets the page on the language as specified by the language selector.
GetPage
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)
GetPages
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.
GetPropertyValues
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.
GetReferencesToPageAndDescendents
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 [!:GetReferencesToPages(PageReferenceCollection pageLinks)]. So make sure that your page provider properly imlements that method.
GetReferencesToPages
Gets the references to pages. Override method to get all references to the given page.
GetType
Gets the Type of the current instance.
(Inherited from Object.)
GetUniqueUrlSegment

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.

Initialize
Initializes the provider with configuration seetings. Override this method to do any provider specific initialization.
(Overrides ProviderBase..::.Initialize(String, NameValueCollection).)
InitializePageDataOverloaded.
ListDelayedPublish
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.
ListPublishedVersions
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.
ListVersionsOverloaded.
LoadPublishedVersionOverloaded.
LoadVersion
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.
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Move
Move a page to another container within the provider instance.
MoveToWastebasket
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.
ResetCounters
Reset statistic counters
ResolveLocalPageOverloaded.
Save
Save page to storage with specified action. If save is to be supported this method needs to be overriden
SetCacheSettingsOverloaded.
SetPageStatus
Sets the status of page, e.g. Published
SetPropertyValuesOverloaded.
ToString
Returns a String that represents the current Object.
(Inherited from Object.)

Properties

  NameDescription
Capabilities
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.
Description
Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).
(Inherited from ProviderBase.)
EntryPoint
Gets the entry point which serves as root for this page provider instance.
IconPath
Gets the icon path definied for the page provider.
IsDefaultProvider
Gets a value indicating whether this instance is the default provider.
ListingFetchCacheHits
Counts calls into the PageProviders cache for the children fetching
ListingFetchCount
Counts the total fetching into the database and cache for children pages
ListingFetchDatabaseReads
Counts calls into the PageProvider for the children fetching
Name
Gets the friendly name used to refer to the provider during configuration.
(Overrides ProviderBase..::.Name.)
PageFetchCacheHits
Counts calls into the PageProviders cache for the page fetchings
PageFetchCount
Counts the total fetching into the database and cache for pages
PageFetchDatabaseReads
Counts calls into the PageProvider for page fetchings
PageFolderVirtualPathProvider
Gets or sets the page folder virtual path provider.
Parameters
Gets the configuration parameters for the page provider
ProviderCacheKey
Gets the provider cache key.
ProviderKey
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.
StatisticsCollectedSince
Returns the statistics last start datetime
SupportedVirtualPathProvider
Gets or sets the supported virtual path provider.
WastebasketReference
Gets the reference to the waste basket for the page provider.

See Also