Class PageControlBase

Namespace: EPiServer.Web.WebControls

Assembly: EPiServer.dll

Syntax

public abstract class PageControlBase : Control, IEnumerable, IPageSource, INotifyPropertyChanged, IPageControl

Remarks

Examples

  Simple example showing how data is read and displayed on a page. 
  The PageLink specifies which page the list will be retrieved from.

    <episerver:PageList MaxCount="1" PageLink="<%#CurrentPage.PageLink%>" runat="server" ID="PageList2">
<ItemTemplate>
<episerver:property PropertyName="PageName" runat="server"/>
<br/>
</ItemTemplate>
</episerver:PageList>

        Illustrates how data from one control can be used by several other controls, in this
        example it is only PageList1 that delivers data and the others are only used for presentation.

    <episerver:PageList PageLink="<%#CurrentPage.PageLink%>" runat="server" ID="PageList1"/>

<episerver:PageList MaxCount="1" DataSource="<%#PageList1%>" runat="server" ID="PageList3">
<ItemTemplate>
<episerver:property ID="Property1" PropertyName="PageName" runat="server"/>
<br/>
</ItemTemplate>
</episerver:PageList>

<episerver:PageList MaxCount="2" SkipCount="1" DataSource="<%#PageList1%>" runat="server" ID="PageList4">
<ItemTemplate>
<episerver:property ID="Property2" PropertyName="PageName" runat="server"/>
<br/>
</ItemTemplate>
</episerver:PageList>

<asp:Repeater DataSource="<%#PageList1%>" runat="server" ID="Repeater1">
<ItemTemplate>
<%#DataBinder.Eval(Container.DataItem,"PageName")%>
<br/>
</ItemTemplate>
</asp:Repeater>

Constructors

PageControlBase()

Declaration

protected PageControlBase()

Properties

AutoBind

Declaration

public bool AutoBind { get; set; }

Property Value

CurrentPage

Declaration

public PageData CurrentPage { get; }

Property Value

DataCount

Declaration

public virtual int DataCount { get; }

Property Value

DataSource

Declaration

public virtual object DataSource { get; set; }

Property Value

Remarks

PageLink

Declaration

public virtual PageReference PageLink { get; set; }

Property Value

Examples

This example shows how to assign a value to the PageLink property of the PageTree control through code. This code is a modified version of the UserControl prefix.ascx.cs code-behind file in the EPiServer sample site.

We cannot assign to the PageLink property in the Page_Load event as it will be to late for the control to see it. Instead we use the Control.Init event.

        private void Page_Init(object sender, System.EventArgs e)
{
    // Set the tree to start at the site start page
    PageDataTree.PageLink = EPiServer.Core.PageReference.StartPage;
}

private void Page_Load(object sender, System.EventArgs e)
{
    //if (((EPiServer.PageBase)Page).CurrentPage["ListingContainer"] == null)
    //    MainBodyWidth = 410 + 170;
    // This is too late, we need to change the PageLink property in the Page_Init method
    // Pagedatatree1.PageLink = ((EPiServer.PageBase)Page).Configuration.StartPage;
}

private void InitializeComponent()
{
    this.Load += new System.EventHandler(this.Page_Load);
    this.Init += new System.EventHandler(this.Page_Init);
}

PageLinkProperty

Declaration

public virtual string PageLinkProperty { get; set; }

Property Value

Remarks

Examples

This code snippet assumes that CalendarContainer is defined as a page type property of type Page reference.

<episerver:Calendar PageLinkProperty="CalendarContainer" runat="server" ID="Calendar1" />

PageSource

Declaration

public virtual IPageSource PageSource { get; set; }

Property Value

Remarks

PropertyResolver

Declaration

protected Injected<PropertyResolver> PropertyResolver { get; set; }

Property Value

PublishedStatus

Declaration

public PagePublishedStatus PublishedStatus { get; set; }

Property Value

Remarks

RemoteSite

Declaration

public virtual string RemoteSite { get; set; }

Property Value

Remarks

RequiredAccess

Declaration

public AccessLevel RequiredAccess { get; set; }

Property Value

Remarks

Methods

CreatePostSortFilters()

Declaration

protected abstract void CreatePostSortFilters()

Remarks

CreatePreSortFilters()

Declaration

protected abstract void CreatePreSortFilters()

Remarks

CreateSortFilters()

Declaration

protected abstract void CreateSortFilters()

Remarks

DataBind()

Declaration

public override void DataBind()

ExecFilters(PageDataCollection)

Declaration

protected void ExecFilters(PageDataCollection pages)

Parameters

GetChildren(PageReference)

Declaration

public virtual PageDataCollection GetChildren(PageReference pageLink)

Parameters

Returns

Remarks

GetChildren(PageReference, PageDataCollection)

Declaration

public virtual void GetChildren(PageReference pageLink, PageDataCollection pages)

Parameters

Remarks

GetEnumerator()

Declaration

public virtual IEnumerator GetEnumerator()

Returns

Remarks

GetPage(PageReference)

Declaration

public virtual PageData GetPage(PageReference pageLink)

Parameters

Returns

GetPages()

Declaration

protected PageDataCollection GetPages()

Returns

OnPreRender(EventArgs)

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

OnPropertyChanged(String)

Declaration

protected virtual void OnPropertyChanged(string propertyName)

Parameters

PopulatePages(PageDataCollection)

Declaration

protected abstract void PopulatePages(PageDataCollection pages)

Parameters

Remarks

Examples

Example how a list control may choose to implement this method

protected override void PopulatePages(PageDataCollection pages)
{
    if(PageLink.ID!=0)
        GetChildren(PageLink,pages);
}

Events

Filter

Declaration

public event FilterEventHandler Filter

Event Type

Remarks

PropertyChanged

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Implements

Extension Methods