PageStartSavingArgs

PageStartSavingArgs class

Info for a page starts saving process.

class PageStartSavingArgs extends PageSavingArgs;

Constructors

ConstructorDescription
constructor(PageSavingArgs)Constructs from a parent object convertible to this.

Properties

PropertyTypeDescription
isToOutputbooleanGets or sets a value indicating whether the page should be output. The default value is true.
pageIndexnumberReadonly. Current page index, zero based.
pageCountnumberReadonly. Total page count.

Methods

MethodDescription
isToOutput()@deprecated. Please use the ‘isToOutput’ property instead. Gets or sets a value indicating whether the page should be output. The default value is true.
setIsToOutput(boolean)@deprecated. Please use the ‘isToOutput’ property instead. Gets or sets a value indicating whether the page should be output. The default value is true.
isNull()Checks whether the implementation object is null.
getPageIndex()@deprecated. Please use the ‘pageIndex’ property instead. Current page index, zero based.
getPageCount()@deprecated. Please use the ‘pageCount’ property instead. Total page count.

constructor(PageSavingArgs)

Constructs from a parent object convertible to this.

constructor(obj: PageSavingArgs);

Parameters:

ParameterTypeDescription
objPageSavingArgsThe parent object.

isToOutput

Gets or sets a value indicating whether the page should be output. The default value is true.

isToOutput : boolean;

pageIndex

Readonly. Current page index, zero based.

pageIndex : number;

pageCount

Readonly. Total page count.

pageCount : number;

isToOutput()

@deprecated. Please use the ‘isToOutput’ property instead. Gets or sets a value indicating whether the page should be output. The default value is true.

isToOutput() : boolean;

setIsToOutput(boolean)

@deprecated. Please use the ‘isToOutput’ property instead. Gets or sets a value indicating whether the page should be output. The default value is true.

setIsToOutput(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getPageIndex()

@deprecated. Please use the ‘pageIndex’ property instead. Current page index, zero based.

getPageIndex() : number;

getPageCount()

@deprecated. Please use the ‘pageCount’ property instead. Total page count.

getPageCount() : number;