Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption Class Reference

Paging options. More...

Public Member Functions

 PageOption (string code)
 Constructor. More...
 

Static Public Member Functions

static string Parse (string option)
 Returns the option associated with a given type code. More...
 

Public Attributes

const string Refresh = "R"
 Refresh the current page. More...
 
const string Next = "N"
 Move to next page. More...
 
const string Prior = "P"
 Move to prior page. More...
 
const string First = "F"
 Move to first page. More...
 
const string Last = "L"
 Move to last page. More...
 

Properties

string Code [get, set]
 The code corresponding to the page option. More...
 

Detailed Description

Paging options.

Constructor & Destructor Documentation

PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption.PageOption ( string  code)

Constructor.

Parameters
code

Member Function Documentation

static string PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption.Parse ( string  option)
static

Returns the option associated with a given type code.

Parameters
optionOption type code (case insensitive).
Returns
The option, or null if not valid.

Member Data Documentation

const string PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption.First = "F"

Move to first page.

const string PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption.Last = "L"

Move to last page.

const string PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption.Next = "N"

Move to next page.

If no next page then this has the same effect as 'Refresh'.

const string PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption.Prior = "P"

Move to prior page.

If no prior page then this has the same effect as 'Refresh'.

const string PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption.Refresh = "R"

Refresh the current page.

Property Documentation

string PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.PageOption.Code
getset

The code corresponding to the page option.