Class PagingOptions

Keeps track of paging options.

Inheritance

System.Object

PagingOptions

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Moraware.JobTrackerAPI5

Assembly: JobTrackerAPI5.dll

Syntax

public class PagingOptions

Constructors

PagingOptions(Int32, Int32, Boolean)

Constructs an object used to keep track of paging.

Declaration

public PagingOptions(int firstRecord_ = 0, int pageSize_ = 30, bool calculateTotalRecords_ = false)

Parameters

Type	Name	Description
System.Int32	firstRecord_	Zero-based index of the first record to return.
System.Int32	pageSize_	Maximum number of records to return.
System.Boolean	calculateTotalRecords_	If True, JobTrackerAPI methods that accept this object will update the TotalRecords property with the total number of records available.

Properties

FirstRecord

Zero-based index of the first record to be retrieved.

Declaration

public int FirstRecord { get; set; }

Property Value

Type	Description
System.Int32

PageSize

Size of each page of records to be retrieved.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
System.Int32

TotalRecords

If this object was constructed with the calculateTotalRecords_ option set to True, this property will indicate the total number of records available through a paged query. Otherwise, it will be null.

Declaration

public int? TotalRecords { get; }

Property Value

Type	Description
System.Nullable<System.Int32>