CPageNumField Class Reference

class CPageNumField : public CPageFieldBase

A field which evaluates to the current page number in the document.

Before the page number field can be evaluated, it must be passed a pointer to an object which implements the UpdateFieldPageNum() function.

Inherits from

Member Functions Documentation

SetPageNumInfo(MFieldPageNumInfo *)

voidSetPageNumInfo(MFieldPageNumInfo *aInfo)[inline]

Sets the object which implements UpdateFieldPageNum(), to get the current page number. SetPageNumInfo() must be called before the page number field can be evaluated.

Parameters

MFieldPageNumInfo * aInfoPointer to an object which implements UpdateFieldPageNum().

Type()

IMPORT_C TUidType()const [virtual]

Returns the field's type UID.

Value(TPtr &)

IMPORT_C TIntValue(TPtr &aValueText)[virtual]

Sets aValueText to the current field value if the buffer is large enough. If not, aValueText is not changed, and the function returns the length which is required to hold the field's value.

Parameters

TPtr & aValueTextDescriptor which on return contains the field's updated value.

Member Data Documentation

MFieldPageNumInfo * iPageNumInfo

MFieldPageNumInfo *iPageNumInfo[protected]