The LocalPageProvider type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| LocalPageProvider | Initializes a new instance of the LocalPageProvider class |
Methods
| Name | Description | |
|---|---|---|
| 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.
(Inherited from PageProviderBase.) | |
| AddPageToCache |
Add a PageData object to cache with default cache behavior.
(Inherited from PageProviderBase.) | |
| AllocateUniquePageFolderId |
Decides whether a unique page folder id should be assigned for the page. This method is called both when a new page is created
through DataFactory.Instance.GetDefaultPageData and when an external page is initalized through call to InitializePageData.
Parameter pageLink can be used to decide which case method is called from.
(Inherited from PageProviderBase.)Default implementation returns true if provider has capability PageFolder else false. | |
| ClearProviderPagesFromCache |
Remove all pages served from this provider from the cache
(Inherited from PageProviderBase.) | |
| ConstructLocalPageReference | Overloaded. | |
| ConstructPageReference | Overloaded. | |
| ConstructPageUri |
Creates an URI given a page type and a pagelink
(Inherited from PageProviderBase.) | |
| Copy |
Copy a page to another container.
(Overrides PageProviderBase..::.Copy(PageReference, PageReference, Boolean, Boolean).) | |
| 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.
(Inherited from PageProviderBase.) | |
| Delete |
Delete a page from database
(Overrides PageProviderBase..::.Delete(PageReference, Boolean).) | |
| DeleteChildren |
Delete children of a page from database.
(Overrides PageProviderBase..::.DeleteChildren(PageReference, Boolean).) | |
| DeleteLanguageBranch |
Delete a page language from database
(Overrides PageProviderBase..::.DeleteLanguageBranch(PageReference, String).) | |
| DeleteVersion |
Delete a single version of a page
(Overrides PageProviderBase..::.DeleteVersion(PageReference).) | |
| Equals | (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. It will perfrom a database search
(Overrides PageProviderBase..::.FindAllPagesWithCriteria(PageReference, PropertyCriteriaCollection, String, ILanguageSelector).) | |
| FindPagesWithCriteria |
Search for pages that fulfil specific criteria.
If the provider is to be searchable this method needs to be overriden.
(Inherited from PageProviderBase.) | |
| 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).
(Inherited from PageProviderBase.) | |
| GetChildrenReferences | Overloaded. | |
| GetDefaultPageData |
Get a PageData object with default values.
Base class implementation will create a new PageData object with properties given by page type.
(Inherited from PageProviderBase.) | |
| GetDescendents |
Gets all the descendents for the current page (that is at all levels).
(Overrides PageProviderBase..::.GetDescendents(PageReference).) | |
| 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.
(Inherited from PageProviderBase.) | |
| GetLocalPage |
Returns the PageData object for the specified reference on the specified language
(Overrides PageProviderBase..::.GetLocalPage(PageReference, ILanguageSelector).) | |
| GetNextAvailablePageFolderId |
Gets the next available page folder id if [!:PageFolderSupportEnabled] is true.
(Inherited from PageProviderBase.) | |
| 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)
(Inherited from PageProviderBase.) | |
| GetPages |
Returns the PageData objects for the specified references on specified language.
(Overrides PageProviderBase..::.GetPages(PageReferenceCollection, ILanguageSelector).) | |
| GetParentPageReferences | (Overrides PageProviderBase..::.GetParentPageReferences(PageReference).) | |
| 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.
(Inherited from PageProviderBase.) | |
| GetReferencesToPageAndDescendents |
Gets the references to page and descendents.
(Overrides PageProviderBase..::.GetReferencesToPageAndDescendents(PageReference, PageReferenceCollection%).) | |
| GetReferencesToPages |
Gets the references to pages.
(Overrides PageProviderBase..::.GetReferencesToPages(PageReferenceCollection).) | |
| 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. | |
| HasCapability |
Determines whether current provider has specified capabilities.
(Inherited from PageProviderBase.) | |
| Initialize |
Initializes the provider with configuration seetings.
Override this method to do any provider specific initialization.
(Inherited from PageProviderBase.) | |
| InitializePageData | Overloaded. | |
| ListDelayedPublish |
Lists all pages that are set to delayed publish.
(Overrides PageProviderBase..::.ListDelayedPublish()()().) | |
| ListPublishedVersions |
Lists the published versions for a page
(Overrides PageProviderBase..::.ListPublishedVersions(PageReference).) | |
| ListVersions | Overloaded. | |
| LoadPublishedVersion | Overloaded. | |
| LoadVersion |
Loads the version.
(Overrides PageProviderBase..::.LoadVersion(PageReference).) | |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Move |
Move a page to another container
(Overrides PageProviderBase..::.Move(PageReference, PageReference).) | |
| MoveToWastebasket |
Move a page to the Wastebasket
(Overrides PageProviderBase..::.MoveToWastebasket(PageReference).) | |
| ResetCounters |
Reset statistic counters
(Inherited from PageProviderBase.) | |
| ResolveLocalPage | Overloaded. | |
| ResolvePageFolder |
Resolves which pages that is associated with given pageFolderId.
(Overrides PageProviderBase..::.ResolvePageFolder(Int32).) | |
| Save |
Save page to database and specify required access level manually.
(Overrides PageProviderBase..::.Save(PageData, SaveAction).) | |
| SetCacheSettings | Overloaded. | |
| SetPageStatus |
Sets the status of page, e.g. Published
(Inherited from PageProviderBase.) | |
| SetPropertyValues | Overloaded. | |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
| 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.
(Inherited from PageProviderBase.) | |
| 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.
(Inherited from PageProviderBase.) | |
| IconPath |
Gets the icon path definied for the page provider.
(Inherited from PageProviderBase.) | |
| IsDefaultProvider |
Gets a value indicating whether this instance is the default provider.
(Inherited from PageProviderBase.) | |
| ListingFetchCacheHits |
Counts calls into the PageProviders cache for the children fetching
(Inherited from PageProviderBase.) | |
| ListingFetchCount |
Counts the total fetching into the database and cache for children pages
(Inherited from PageProviderBase.) | |
| ListingFetchDatabaseReads |
Counts calls into the PageProvider for the children fetching
(Inherited from PageProviderBase.) | |
| Name |
Gets the friendly name used to refer to the provider during configuration.
(Inherited from PageProviderBase.) | |
| PageFetchCacheHits |
Counts calls into the PageProviders cache for the page fetchings
(Inherited from PageProviderBase.) | |
| PageFetchCount |
Counts the total fetching into the database and cache for pages
(Inherited from PageProviderBase.) | |
| PageFetchDatabaseReads |
Counts calls into the PageProvider for page fetchings
(Inherited from PageProviderBase.) | |
| PageFolderVirtualPathProvider |
Gets or sets the page folder virtual path provider.
(Inherited from PageProviderBase.) | |
| Parameters |
Gets the configuration parameters for the page provider
(Inherited from PageProviderBase.) | |
| ProviderCacheKey |
Gets the provider cache key.
(Inherited from PageProviderBase.) | |
| 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.
(Inherited from PageProviderBase.) | |
| StatisticsCollectedSince |
Returns the statistics last start datetime
(Inherited from PageProviderBase.) | |
| SupportedVirtualPathProvider |
Gets or sets the supported virtual path provider.
(Inherited from PageProviderBase.) | |
| WastebasketReference |
Gets the reference to the waste basket for the page provider.
(Inherited from PageProviderBase.) |