PageNumber Class

Page Number Block.When the object is serialized out as xml, its qualified name is w:pgNum.

Inheritance Hierarchy


Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)


Public Class PageNumber _
    Inherits EmptyType
Dim instance As PageNumber
public class PageNumber : EmptyType


[ISO/IEC 29500-1 1st Edition] pgNum (Page Number Block)

This element specifies the presence of a page number block at the current location in the run content. A page number block is a non-editable region of text which shall display the current page using ascending decimal numbers. [Note: The page number block is a legacy construct used for compatibility with older word processors, and should not be produced unless it was consumed while reading a document – it is recommended that the PAGENUM field is used in its place. end note]

A page number block shall be displayed using ascending decimal numbers, regardless of the languages specified in the parent run’s lang property (§

[Example: Consider a WordprocessingML run with the following run content:

<w:t xml:space="preserve">This is the current page: </w:t>
<w:pgNum />

This run specifies that a page number block must be placed after the text string literal This is the current page: in the document. Assuming that this content is on the first page, this run would be displayed as follows:

This is the current page: 1

end example]

Parent Elements

r (§; r (§

[Note: The W3C XML Schema definition of this element’s content model (CT_Empty) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also


PageNumber Members

DocumentFormat.OpenXml.Wordprocessing Namespace