Syntax

Smartsite SXML	Copy Code
locator this.location(enum position) locator this.location(enum position, string pagingQueryVar) locator this.location(integer pageNumber) locator this.location(integer pageNumber, string pagingQueryVar)

Smartsite SXML

Copy Code

locator this.location(enum position)
locator this.location(enum position, string pagingQueryVar)
locator this.location(integer pageNumber)
locator this.location(integer pageNumber, string pagingQueryVar)

Extension Viper Syntax

Smartsite SXML	Copy Code
locator page.<id>.location(enum position) locator page.<id>.location(enum position, string pagingQueryVar) locator page.<id>.location(integer pageNumber) locator page.<id>.location(integer pageNumber, string pagingQueryVar)

Smartsite SXML

Copy Code

locator page.<id>.location(enum position)
locator page.<id>.location(enum position, string pagingQueryVar)
locator page.<id>.location(integer pageNumber)
locator page.<id>.location(integer pageNumber, string pagingQueryVar)

Parameters

Name	Data Type	Description
position	Enum	The position. Enum values: First First page. Previous Previous page. Next Next page. Last Last page.
pagingQueryVar	String	The paging querystring variable to use.
pageNumber	Integer	The page number.

Return Value

Data Type	Description
Locator	Hyperlink

Used in

Macro	Description
Paging	Paging macro. Holds state for paging through large datasets. Can be used in combination with existing datatables to page through large datasets. Use in combination with macros/vipers that return datatables.

Example

SqlQuery integrated paging with custom navigation display.

This example shows how easy it is to integrate paging in an SqlQuery macro (using the PagingId parameter).

Using the PagingId parameter makes the SqlQuery macro convert the Sql given to a paging query, thus selecting only the data needed from the database source (paging at the source). You can see that by monitoring the database activity using a trace.
This is very different from storing a datatable in cache, then paging through the cached datatable, in terms of resources needed and performance.
You have to always make the design decision what the best way is in any given scenario.

Also, in this example, paging navigation links are displayed in a custom fashion, using this.location(). This provides maximum flexibility.

Smartsite SXML	Copy Code
<se:hidden> <se:pagetranslations localid="helpers"> <se:collection> <se:member name="link(nr, text)"><a href="{translation.arg(nr)}">{translation.arg(2)}</a></se:member> </se:collection> </se:pagetranslations> <se:paging pagesize="10" queryprefix="p1" /> {buffer.set(cur, scope.paging.current())} {buffer.set(range, 6)} {buffer.set(start, math.max(scope.paging.current()-($range/2),1))} </se:hidden> <se:sqlquery pagingid="paging" sql="select nr, title, description from {channel.view()} where parent={cms.getitemnumber(MACROS)} order by title" whitespace="remove"> <se:parameters> <se:parameter name="format"> <se:rowformat> {char.tab()}<li><a href="{this.location()}">{this.field(title)}</a> <div><span></span>{this.field(description)}</div></li>{char.crlf()} </se:rowformat> </se:parameter> <se:parameter name="resultformat"> <ul>{char.crlf()}{this.result()}</ul>{char.crlf()} </se:parameter> </se:parameters> </se:sqlquery> <se:for from="{buffer.get(start)}" to="{math.min($start+$range, scope.paging.count())}" whitespace="remove"> {buffer.set(n, this.index())} <div class="{string.concat(paging, sys.iif($n==$cur, ' currentpage'))}"> <se:if expression="$cur!=$n" trim="both"> <se:then> {translation.helpers.link(scope.paging.location($n), $n)} </se:then> <se:else> {buffer.get(n)} </se:else> </se:if> </div>{char.crlf()} </se:for>

Smartsite SXML

Copy Code

<se:hidden>
    <se:pagetranslations localid="helpers">
        <se:collection>
            <se:member name="link(nr, text)"><a href="{translation.arg(nr)}">{translation.arg(2)}</a></se:member>
        </se:collection>
    </se:pagetranslations>
    
    <se:paging pagesize="10" queryprefix="p1" />
    
    {buffer.set(cur, scope.paging.current())}
    {buffer.set(range, 6)}
    {buffer.set(start, math.max(scope.paging.current()-($range/2),1))}
    
</se:hidden>
<se:sqlquery pagingid="paging"
    sql="select nr, title, description from {channel.view()} where parent={cms.getitemnumber(MACROS)} order by title" 
    whitespace="remove">
    <se:parameters>
        <se:parameter name="format">
            <se:rowformat>
                {char.tab()}<li><a href="{this.location()}">{this.field(title)}</a>
                <div><span></span>{this.field(description)}</div></li>{char.crlf()}
            </se:rowformat>
        </se:parameter>
        <se:parameter name="resultformat">
            <ul>{char.crlf()}{this.result()}</ul>{char.crlf()}
        </se:parameter>
    </se:parameters>
</se:sqlquery>

<se:for from="{buffer.get(start)}" to="{math.min($start+$range, scope.paging.count())}" whitespace="remove">
    {buffer.set(n, this.index())}
    <div class="{string.concat(paging, sys.iif($n==$cur, ' currentpage'))}">
        <se:if expression="$cur!=$n" trim="both">
            <se:then>
                {translation.helpers.link(scope.paging.location($n), $n)} 
            </se:then>
            <se:else>
                {buffer.get(n)}
            </se:else>
        </se:if>
    </div>{char.crlf()}
</se:for>

SXML