Class PageData

Namespace: EPiServer.Core

Assembly: EPiServer.dll

Syntax

[AdministrationSettings(GroupName = "pagetypes", Visible = true, Order = 10)]
public class PageData : ContentData, IInitializableContent, IReadOnly<PageData>, IReadOnly, IContentSecurable, ISecurable, IContent, IContentData, ILocalizable, ILocale, IModifiedTrackable, IVersionable, IResourceable, IChangeTrackable, IRoutable, ICategorizable, IExportable

Remarks

Constructors

PageData()

Declaration

public PageData()

PageData(PageData)

Declaration

public PageData(PageData copy)

Parameters

PageData(PageReference)

Declaration

public PageData(PageReference pageLink)

Parameters

PageData(RawPage)

Declaration

public PageData(RawPage page)

Parameters

PageData(AccessControlList, PropertyDataCollection)

Declaration

public PageData(AccessControlList acl, PropertyDataCollection coll)

Parameters

Properties

ACL

Declaration

public virtual AccessControlList ACL { get; set; }

Property Value

Remarks

Examples

The following code example demonstrates the usage of ToRawACEArray to enumerate the Access Control Entries. The example enumerates the RawACE objects, which together form the Access Control List and check if one of them is the Create permission.

            foreach ( EPiServer.Security.RawACE Ace in CurrentPage.ACL.ToRawACEArray() ) 
    {
        if ( ( Ace.Access & EPiServer.Security.AccessLevel.Create ) == EPiServer.Security.AccessLevel.Create ) 
        {
            // Do something
        }
    }

The following code example demonstrates the usage of QueryDistinctAccess to check specific access for the current user.

            if ( CurrentPage.ACL.QueryDistinctAccess( EPiServer.Security.AccessLevel.Create ) ) 
    {
        // Checks whether the currently logged-on user has
        // create permission for the current page.
    } 

ArchiveLink

Declaration

public virtual PageReference ArchiveLink { get; set; }

Property Value

Remarks

Category

Declaration

public virtual CategoryList Category { get; set; }

Property Value

Remarks

Changed

Declaration

public virtual DateTime Changed { get; set; }

Property Value

Remarks

Examples

The following code example demonstrates the usage of Changed.

string changedDateTime = CurrentPage.Changed.ToString( "r" ); 

ChangedBy

Declaration

public virtual string ChangedBy { get; set; }

Property Value

Remarks

Examples

  The following code example demonstrates the usage of <strong>ChangedBy</strong>.

    Page changed by: <%# CurrentPage.ChangedBy %>

ContentAssetsID

Declaration

public virtual Guid ContentAssetsID { get; set; }

Property Value

ContentGuid

Declaration

public virtual Guid ContentGuid { get; set; }

Property Value

ContentLink

Declaration

public virtual ContentReference ContentLink { get; set; }

Property Value

ContentTypeID

Declaration

public virtual int ContentTypeID { get; set; }

Property Value

Created

Declaration

public virtual DateTime Created { get; set; }

Property Value

Remarks

CreatedBy

Declaration

public virtual string CreatedBy { get; set; }

Property Value

Deleted

Declaration

public virtual DateTime? Deleted { get; set; }

Property Value

DeletedBy

Declaration

public virtual string DeletedBy { get; set; }

Property Value

ExistingLanguages

Declaration

public virtual IEnumerable<CultureInfo> ExistingLanguages { get; set; }

Property Value

ExternalURL

Declaration

public virtual string ExternalURL { get; set; }

Property Value

HasTemplate

Declaration

[Obsolete("Use extension method page.HasTemplate() instead or access the TemplateResolver service")]
public bool HasTemplate { get; set; }

Property Value

IsDeleted

Declaration

public virtual bool IsDeleted { get; set; }

Property Value

Remarks

IsMasterLanguageBranch

Declaration

public virtual bool IsMasterLanguageBranch { get; }

Property Value

IsModified

Declaration

public bool IsModified { get; set; }

Property Value

Remarks

IsPendingPublish

Declaration

public virtual bool IsPendingPublish { get; set; }

Property Value

IsVisibleOnSite

Declaration

[Obsolete("Use extension method page.IsVisibleOnSite() instead")]
public bool IsVisibleOnSite { get; }

Property Value

Remarks

Language

Declaration

public virtual CultureInfo Language { get; set; }

Property Value

LanguageBranch

Declaration

public virtual string LanguageBranch { get; }

Property Value

LanguageID

Declaration

public virtual string LanguageID { get; set; }

Property Value

LinkType

Declaration

public virtual PageShortcutType LinkType { get; set; }

Property Value

LinkURL

Declaration

public virtual string LinkURL { get; set; }

Property Value

Remarks

MasterLanguage

Declaration

public virtual CultureInfo MasterLanguage { get; set; }

Property Value

MasterLanguageBranch

Declaration

public virtual string MasterLanguageBranch { get; set; }

Property Value

Name

Declaration

public virtual string Name { get; set; }

Property Value

PageFolderID

Declaration

[Obsolete("Only used by old Virtual Path Providers")]
public virtual int PageFolderID { get; }

Property Value

PageGuid

Declaration

public virtual Guid PageGuid { get; set; }

Property Value

PageLanguages

Declaration

public virtual ReadOnlyStringList PageLanguages { get; }

Property Value

PageLink

Declaration

public virtual PageReference PageLink { get; set; }

Property Value

Remarks

Examples

The following example demonstrates the usage of PageLink in HTML.

As PageLink is guaranteed to be unique among all pages in a certain EPiServer instances, it is used in the following example to create unique IDs and names for HTML check boxes. The code is used to present the visitor with a selection of pages and allows them to select one or more for further processing.

    <EPiServer:PageList SortBy="PageName" DataSource="<%#PropertySearchControl%>" runat="server" ID="PageListControl">
<ItemTemplate>
    ...
    <input type="checkbox" id="ViewUser<%#Container.CurrentPage.PageLink%>" name="ViewUser<%# Container.CurrentPage.PageLink %>" />
    ...
</ItemTemplate>
</EPiServer:PageList>

PageName

Declaration

public virtual string PageName { get; set; }

Property Value

Remarks

Examples

The following example demonstrates the usage of PageName and LinkURL. The HTML code below produces two HTML table rows for every news item page displayed. The first row displays the content of the property PageStartPublish and the second row is an HTML anchor tag, where PageData.LinkURL is the relative URL for the page and PageData.PageName is used as a new headline. Note that PageData.Item is used twice in this HTML code, as the two attributes PageStartPublish and MainIntro are accessed using the indexer for the PageData property.

    <EPiServer:Newslist ID="Newslistnew" Pagelinkproperty="NewsContainer" runat="server" MaxCount='<%# GetNewsCount() %>'>
<NewsTemplate>
    <tr>
        <td class="DateListingText"><%# Container.CurrentPage[ "PageStartPublish" ] %></td>
    </tr>
    <tr>
        <td>
            <a href="<%# Container.CurrentPage.LinkURL %>" class="StartPageHeading">
            <%# Container.CurrentPage.PageName %></a>&nbsp;<br />
            <span class="Normal">
            <%# Container.CurrentPage[ "MainIntro" ] %>
            </span>
        </td>
    </tr>
</NewsTemplate>
</EPiServer:Newslist>    

PageTypeID

Declaration

public virtual int PageTypeID { get; set; }

Property Value

Remarks

PageTypeName

Declaration

public virtual string PageTypeName { get; set; }

Property Value

Remarks

ParentLink

Declaration

public virtual PageReference ParentLink { get; set; }

Property Value

Remarks

Examples

In the following code example ParentLink is used twice. First make sure it contains a non-empty PageReference and secondly to retrieve the sibling of the current page.

            if ( CurrentPage.ParentLink != EPiServer.Core.PageReference.EmptyReference ) 
    {
        EPiServer.Core.PageDataCollection siblings = GetChildren( CurrentPage.ParentLink );
    } 

The following code example demonstrates the usage of ParentLink. The example results in the name of the parent page being displayed.

    Parent Page Name: <%= GetPage( CurrentPage.ParentLink ).PageName %>     

PendingArchive

Declaration

public virtual bool PendingArchive { get; }

Property Value

Remarks

PendingPublish

Declaration

public virtual bool PendingPublish { get; set; }

Property Value

Saved

Declaration

public virtual DateTime Saved { get; set; }

Property Value

Remarks

SetChangedOnPublish

Declaration

public virtual bool SetChangedOnPublish { get; set; }

Property Value

ShouldBeImplicitlyExported

Declaration

protected virtual bool ShouldBeImplicitlyExported { get; }

Property Value

Remarks

StartPublish

Declaration

public virtual DateTime StartPublish { get; set; }

Property Value

StaticLinkURL

Declaration

public virtual string StaticLinkURL { get; set; }

Property Value

Status

Declaration

public virtual VersionStatus Status { get; set; }

Property Value

StopPublish

Declaration

public virtual DateTime StopPublish { get; set; }

Property Value

Remarks

TargetFrameName

Declaration

public virtual string TargetFrameName { get; }

Property Value

URLSegment

Declaration

public virtual string URLSegment { get; set; }

Property Value

VisibleInMenu

Declaration

public virtual bool VisibleInMenu { get; set; }

Property Value

Remarks

WorkPageID

Declaration

public virtual int WorkPageID { get; set; }

Property Value

Remarks

Methods

CheckPublishedStatus(PagePublishedStatus)

Declaration

public bool CheckPublishedStatus(PagePublishedStatus status)

Parameters

Returns

Remarks

Copy()

Declaration

public PageData Copy()

Returns

Remarks

CreateWritableClone()

Declaration

public PageData CreateWritableClone()

Returns

CreateWriteableCloneImplementation()

Declaration

protected override object CreateWriteableCloneImplementation()

Returns

Overrides

Remarks

GetContentSecurityDescriptor()

Declaration

public virtual IContentSecurityDescriptor GetContentSecurityDescriptor()

Returns

GetSecurityDescriptor()

Declaration

public virtual ISecurityDescriptor GetSecurityDescriptor()

Returns

InitializeData(IList<String>)

Declaration

public virtual void InitializeData(IList<string> pageLanguages)

Parameters

MakeReadOnly()

Declaration

public override void MakeReadOnly()

Overrides

PopulateDynamicProperties()

Declaration

[Obsolete("Not used by the EPiServer Framework any more", true)]
public void PopulateDynamicProperties()

SetDefaultValues(ContentType)

Declaration

public override void SetDefaultValues(ContentType contentType)

Parameters

Overrides

Examples

[ContentType(DisplayName = "Article Page")]
public class Article : PageData
{
public virtual string Heading { get; set; }
public virtual XhtmlString MainBody { get; set; }

public override void SetDefaultValues(ContentType pageType)
{
    base.SetDefaultValues(pageType);

    Heading = "My awesome article";
    MainBody = new XhtmlString("<p>Enter your article text here<p/>");
}
}

ShallowCopy(PageData)

Declaration

protected virtual void ShallowCopy(PageData copy)

Parameters

ToRawPage()

Declaration

public RawPage ToRawPage()

Returns

Remarks

Explicit Interface Implementations

IContent.ParentLink

Declaration

ContentReference IContent.ParentLink { get; set; }

Returns

IModifiedTrackable.IsModified

Declaration

bool IModifiedTrackable.IsModified { get; }

Returns

IModifiedTrackable.ResetModified()

Declaration

void IModifiedTrackable.ResetModified()

IVersionable.StartPublish

Declaration

DateTime? IVersionable.StartPublish { get; set; }

Returns

IVersionable.StopPublish

Declaration

DateTime? IVersionable.StopPublish { get; set; }

Returns

Remarks

IExportable.ShouldBeImplicitlyExported

Declaration

bool IExportable.ShouldBeImplicitlyExported { get; }

Returns

IRoutable.RouteSegment

Declaration

string IRoutable.RouteSegment { get; set; }

Returns

Implements

Extension Methods