API Reference
Class
WordPageNumber
Represents a page-numbering building block.
Inheritance
- Object
- WordPageNumber
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method WordFooter.AddPageNumber
- Method WordHeader.AddPageNumber
Constructors
WordPageNumber 2 overloads
public WordPageNumber(WordDocument wordDocument, WordHeader wordHeader, WordPageNumberStyle wordPageNumberStyle) #Initializes a new instance of WordPageNumber and appends it to the specified header.
Parameters
- wordDocument OfficeIMO.Word.WordDocument
- Document where the page number will be inserted.
- wordHeader OfficeIMO.Word.WordHeader
- Header that will contain the page number.
- wordPageNumberStyle OfficeIMO.Word.WordPageNumberStyle
- Style applied to the page number.
Methods
public WordParagraph AppendText(String text) #Returns:
WordParagraphAppends text to the last paragraph of the page number.
Parameters
- text System.String
- Text to append.
Returns
The paragraph that received the text.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public Nullable<WordParagraphAlignment> ParagraphAlignment { get; set; } #Gets or sets the alignment of the page-number paragraph.
public WordParagraph Paragraph { get; } #Gets the primary paragraph containing the page number field.
public IReadOnlyList<WordParagraph> Paragraphs { get; } #Gets all paragraphs that make up the page number content.
public WordField Field { get; } #Gets the underlying field representing the page number.
public Nullable<Int32> Number { get; } #Gets the numeric value from the field text if available.
public String CustomFormat { get; set; } #Gets or sets the custom format of the page number field.