Class PagingHandler

Namespace

Dynamicweb.Modules.Common

Assembly

Dynamicweb.dll

Handles paging of lists

public class PagingHandler

Inheritance

object

PagingHandler

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PagingHandler()

public PagingHandler()

PagingHandler(int)

public PagingHandler(int collectionSize)

Parameters

collectionSize int

Properties

Activated

public bool Activated { get; set; }

Property Value

bool

CollectionSize

public int CollectionSize { get; set; }

Property Value

int

ContentModule

public ContentModule ContentModule { get; set; }

Property Value

ContentModule

EmptyRangeOnPageOverflow

Gets or sets a value indicating whether to return an empty range if current page is out of bounds.

public bool EmptyRangeOnPageOverflow { get; set; }

Property Value

bool

true if empty range is returned for pages out of bounds; otherwise, false.

IgnoreCollectionSizeForRange

Gets or sets a value indicating whether calculate range with the constraint of the collection size.

public bool IgnoreCollectionSizeForRange { get; set; }

Property Value

bool

true if collection size constraint is ignored; otherwise, false. Default is false.

NextButtonImage

public string NextButtonImage { get; set; }

Property Value

string

NextButtonText

public string NextButtonText { get; set; }

Property Value

string

PageNumber

public int PageNumber { get; set; }

Property Value

int

PageNumberVariableName

public string PageNumberVariableName { get; set; }

Property Value

string

PageSize

public int PageSize { get; set; }

Property Value

int

Prefix

public string Prefix { get; set; }

Property Value

string

PreviousButtonImage

public string PreviousButtonImage { get; set; }

Property Value

string

PreviousButtonText

public string PreviousButtonText { get; set; }

Property Value

string

Range

public PagingHandler.PagingRange Range { get; }

Property Value

PagingHandler.PagingRange

ShowLastPage

public bool ShowLastPage { get; set; }

Property Value

bool

TypeOfNextButton

public PagingHandler.ButtonType TypeOfNextButton { get; set; }

Property Value

PagingHandler.ButtonType

TypeOfPreviousButton

public PagingHandler.ButtonType TypeOfPreviousButton { get; set; }

Property Value

PagingHandler.ButtonType

Methods

GetCurrentPageNumber()

Get number of the current page

public int GetCurrentPageNumber()

Returns

int

GetPageCount()

Get count of pages

public int GetPageCount()

Returns

int

LoadProperties(Properties, string)

public void LoadProperties(Properties pagingProperty, string pagingControlId)

Parameters

pagingProperty Properties

pagingControlId string

LoadProperties(string)

public void LoadProperties(string propertiesValues)

Parameters

propertiesValues string

Render(Template)

public void Render(Template template)

Parameters

template Template