GrapeCity.Documents.Word.PageNumbering

Class PageNumbering

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents page numbering settings for all page numbers that appear in the contents of a section.

public class PageNumbering

Inheritance

object

PageNumbering

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

ChapterPageSeparator

Gets or sets the separator character used between the chapter number and the page number.

If the HeadingLevelForChapter property is 0, or its specified heading level does not have an associated numbering format, this value is ignored, since no chapter number is output by the field.

public ChapterSeparator ChapterPageSeparator { get; set; }

Property Value

ChapterSeparator

HeadingLevelForChapter

Gets or sets the one-based index of the heading style applied to chapter titles in the document, to be used as chapter headings in all page numbers for a section, by locating the nearest heading of that style and extracting the numbering information.

Can be a number from 0 through 8, corresponding to heading levels 1 through 9.

public byte HeadingLevelForChapter { get; set; }

Property Value

byte

Remarks

If the specified heading style does not exist in the current section, or does not have a numbering format, then any previous level heading format shall be used as needed as the specified chapter number. If no heading has numbering information and/or is used in the section, then the chapter and chapter separator shall be omitted from the page numbering data.

IncludeChapterNumber

Gets or sets a value indicating whether a chapter number is included with page numbers or a caption label.

public bool IncludeChapterNumber { get; set; }

Property Value

bool

NumberStyle

Gets or sets the page number format.

public NumberStyle NumberStyle { get; set; }

Property Value

NumberStyle

RestartPageNumbering

Gets or sets a value indicating whether page numbering restarts at the beginning of a section.

If false, overrides the StartingNumber property so that page numbering can continue from the previous section.

public bool RestartPageNumbering { get; set; }

Property Value

bool

StartingNumber

Gets or sets the starting page number of a section.

The RestartPageNumbering property, if set to false, will override this property so that page numbering can continue from the previous section.

public int StartingNumber { get; set; }

Property Value

int

Methods

ClearFormatting()

Resets page numbering to default values.

public void ClearFormatting()