GrapeCity.Documents.Word.Fields.PageRefFieldOptions

PageRefFieldOptions Class

Represents PAGEREF field options.

A PAGEREF field inserts the number of the page containing the bookmark for a cross-reference.

PageRefFieldOptions

public class PageRefFieldOptions : FieldFormatOptions, IFieldOptions

Public Class PageRefFieldOptions
    Inherits FieldFormatOptions
    Implements IFieldOptions

Name	Description
PageRefFieldOptions(ComplexField)	Initializes a new instance of the PageRefFieldOptions class.
PageRefFieldOptions(DocumentBase, string)	Initializes a new instance of the PageRefFieldOptions class.
PageRefFieldOptions(SimpleField)	Initializes a new instance of the PageRefFieldOptions class.

Name	Description
Bookmark	Gets or sets the bookmark name for a cross-reference.
DisplayRelative	Gets or sets a value indicating whether to display the position relative to the source bookmark. Default value is false. If the PAGEREF field is on the same page as the bookmark, it omits "on page #" and returns "above" or "below" only. If the PAGEREF field is not on the same page as the bookmark, the string "on page #" is used.
Hyperlink	Gets or sets a value indicating whether to create a hyperlink to the bookmarked paragraph. The default value is false.

Name

Description

Bookmark

Gets or sets the bookmark name for a cross-reference.

DisplayRelative

Gets or sets a value indicating whether to display the position relative to the source bookmark.

Default value is false.

If the PAGEREF field is on the same page as the bookmark, it omits "on page #" and returns "above" or "below" only.

If the PAGEREF field is not on the same page as the bookmark, the string "on page #" is used.

Hyperlink

Gets or sets a value indicating whether to create a hyperlink to the bookmarked paragraph.

The default value is false.

Name	Description
Save(ComplexField)	Saves options to a ComplexField.
Save(SimpleField)	Saves options to a SimpleField.