|
Aspose::Words::Fields::FieldPageRef Class Reference
Implements the PAGEREF field.
- Examples
Shows to insert PAGEREF fields to display the relative location of bookmarks.
void FieldPageRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
InsertAndNameBookmark(builder, u"MyBookmark1");
// Insert a PAGEREF field that displays what page a bookmark is on.
// Set the InsertHyperlink flag to make the field also function as a clickable link to the bookmark.
ASSERT_EQ(u" PAGEREF MyBookmark3 \\h", InsertFieldPageRef(builder, u"MyBookmark3", true, false, u"Hyperlink to Bookmark3, on page: ")->GetFieldCode());
// We can use the \p flag to get the PAGEREF field to display
// the bookmark's position relative to the position of the field.
// Bookmark1 is on the same page and above this field, so this field's displayed result will be "above".
ASSERT_EQ(u" PAGEREF MyBookmark1 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark1", true, true, u"Bookmark1 is ")->GetFieldCode());
// Bookmark2 will be on the same page and below this field, so this field's displayed result will be "below".
ASSERT_EQ(u" PAGEREF MyBookmark2 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark2", true, true, u"Bookmark2 is ")->GetFieldCode());
// Bookmark3 will be on a different page, so the field will display "on page 2".
ASSERT_EQ(u" PAGEREF MyBookmark3 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark3", true, true, u"Bookmark3 is ")->GetFieldCode());
InsertAndNameBookmark(builder, u"MyBookmark2");
builder->InsertBreak(BreakType::PageBreak);
InsertAndNameBookmark(builder, u"MyBookmark3");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.PAGEREF.docx");
}
static SharedPtr<FieldPageRef> InsertFieldPageRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, bool insertHyperlink,
bool insertRelativePosition, String textBefore)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldPageRef>(builder->InsertField(FieldType::FieldPageRef, true));
field->set_BookmarkName(bookmarkName);
field->set_InsertHyperlink(insertHyperlink);
field->set_InsertRelativePosition(insertRelativePosition);
builder->Writeln();
return field;
}
static void InsertAndNameBookmark(SharedPtr<DocumentBuilder> builder, String bookmarkName)
{
builder->StartBookmark(bookmarkName);
builder->Writeln(String::Format(u"Contents of bookmark \"{0}\".", bookmarkName));
builder->EndBookmark(bookmarkName);
}
#include <Aspose.Words.Cpp/Fields/FieldPageRef.h>
Inheritance diagram for Aspose::Words::Fields::FieldPageRef:
Public Member Functions | |
| String | get_BookmarkName () |
| Gets or sets the name of the bookmark. More... | |
| bool | get_InsertHyperlink () |
| Gets or sets whether to insert a hyperlink to the bookmarked paragraph. More... | |
| bool | get_InsertRelativePosition () |
| Gets or sets whether to insert a relative position of the bookmarked paragraph. More... | |
| FieldSwitchType | GetSwitchType (String switchName) override |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_BookmarkName (String value) |
| Setter for get_BookmarkName. More... | |
| void | set_InsertHyperlink (bool value) |
| Setter for get_InsertHyperlink. More... | |
| void | set_InsertRelativePosition (bool value) |
| Setter for get_InsertRelativePosition. More... | |
| Public Member Functions inherited from Field | |
| String | get_DisplayResult () |
| Gets the text that represents the displayed field result. More... | |
| SharedPtr< FieldEnd > | get_End () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldEnd > | get_FieldEnd () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldStart > | get_FieldStart () const |
| Gets the node that represents the start of the field. More... | |
| SharedPtr< FieldFormat > | get_Format () |
| Gets a FieldFormat object that provides typed access to field's formatting. More... | |
| bool | get_IsDirty () |
| Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. More... | |
| bool | get_IsLocked () |
| Gets or sets whether the field is locked (should not recalculate its result). More... | |
| int32_t | get_LocaleId () |
| Gets or sets the LCID of the field. More... | |
| String | get_Result () |
| Gets or sets text that is between the field separator and field end. More... | |
| SharedPtr< FieldSeparator > | get_Separator () |
| Gets the node that represents the field separator. Can be null. More... | |
| SharedPtr< FieldStart > | get_Start () const |
| Gets the node that represents the start of the field. More... | |
| virtual FieldType | get_Type () |
| Gets the Microsoft Word field type. More... | |
| String | GetFieldCode () |
| Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. More... | |
| String | GetFieldCode (bool includeChildFieldCodes) |
| Returns text between field start and field separator (or field end if there is no separator). More... | |
| SharedPtr< Node > | Remove () |
| Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null. More... | |
| void | set_IsDirty (bool value) |
| Setter for get_IsDirty. More... | |
| void | set_IsLocked (bool value) |
| Setter for get_IsLocked. More... | |
| void | set_LocaleId (int32_t value) |
| Setter for get_LocaleId. More... | |
| void | set_Result (String value) |
| Setter for get_Result. More... | |
| bool | Unlink () |
| Performs the field unlink. More... | |
| void | Update () |
| Performs the field update. Throws if the field is being updated already. More... | |
| void | Update (bool ignoreMergeFormat) |
| Performs a field update. Throws if the field is being updated already. More... | |
Static Public Member Functions | |
| static const TypeInfo & | Type () |
| Static Public Member Functions inherited from Field | |
| static const TypeInfo & | Type () |
Member Function Documentation
◆ get_BookmarkName()
| System::String Aspose::Words::Fields::FieldPageRef::get_BookmarkName | ( | ) |
Gets or sets the name of the bookmark.
- Examples
Shows to insert PAGEREF fields to display the relative location of bookmarks.
void FieldPageRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
InsertAndNameBookmark(builder, u"MyBookmark1");
// Insert a PAGEREF field that displays what page a bookmark is on.
// Set the InsertHyperlink flag to make the field also function as a clickable link to the bookmark.
ASSERT_EQ(u" PAGEREF MyBookmark3 \\h", InsertFieldPageRef(builder, u"MyBookmark3", true, false, u"Hyperlink to Bookmark3, on page: ")->GetFieldCode());
// We can use the \p flag to get the PAGEREF field to display
// the bookmark's position relative to the position of the field.
// Bookmark1 is on the same page and above this field, so this field's displayed result will be "above".
ASSERT_EQ(u" PAGEREF MyBookmark1 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark1", true, true, u"Bookmark1 is ")->GetFieldCode());
// Bookmark2 will be on the same page and below this field, so this field's displayed result will be "below".
ASSERT_EQ(u" PAGEREF MyBookmark2 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark2", true, true, u"Bookmark2 is ")->GetFieldCode());
// Bookmark3 will be on a different page, so the field will display "on page 2".
ASSERT_EQ(u" PAGEREF MyBookmark3 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark3", true, true, u"Bookmark3 is ")->GetFieldCode());
InsertAndNameBookmark(builder, u"MyBookmark2");
builder->InsertBreak(BreakType::PageBreak);
InsertAndNameBookmark(builder, u"MyBookmark3");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.PAGEREF.docx");
}
static SharedPtr<FieldPageRef> InsertFieldPageRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, bool insertHyperlink,
bool insertRelativePosition, String textBefore)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldPageRef>(builder->InsertField(FieldType::FieldPageRef, true));
field->set_BookmarkName(bookmarkName);
field->set_InsertHyperlink(insertHyperlink);
field->set_InsertRelativePosition(insertRelativePosition);
builder->Writeln();
return field;
}
static void InsertAndNameBookmark(SharedPtr<DocumentBuilder> builder, String bookmarkName)
{
builder->StartBookmark(bookmarkName);
builder->Writeln(String::Format(u"Contents of bookmark \"{0}\".", bookmarkName));
builder->EndBookmark(bookmarkName);
}
◆ get_InsertHyperlink()
| bool Aspose::Words::Fields::FieldPageRef::get_InsertHyperlink | ( | ) |
Gets or sets whether to insert a hyperlink to the bookmarked paragraph.
- Examples
Shows to insert PAGEREF fields to display the relative location of bookmarks.
void FieldPageRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
InsertAndNameBookmark(builder, u"MyBookmark1");
// Insert a PAGEREF field that displays what page a bookmark is on.
// Set the InsertHyperlink flag to make the field also function as a clickable link to the bookmark.
ASSERT_EQ(u" PAGEREF MyBookmark3 \\h", InsertFieldPageRef(builder, u"MyBookmark3", true, false, u"Hyperlink to Bookmark3, on page: ")->GetFieldCode());
// We can use the \p flag to get the PAGEREF field to display
// the bookmark's position relative to the position of the field.
// Bookmark1 is on the same page and above this field, so this field's displayed result will be "above".
ASSERT_EQ(u" PAGEREF MyBookmark1 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark1", true, true, u"Bookmark1 is ")->GetFieldCode());
// Bookmark2 will be on the same page and below this field, so this field's displayed result will be "below".
ASSERT_EQ(u" PAGEREF MyBookmark2 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark2", true, true, u"Bookmark2 is ")->GetFieldCode());
// Bookmark3 will be on a different page, so the field will display "on page 2".
ASSERT_EQ(u" PAGEREF MyBookmark3 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark3", true, true, u"Bookmark3 is ")->GetFieldCode());
InsertAndNameBookmark(builder, u"MyBookmark2");
builder->InsertBreak(BreakType::PageBreak);
InsertAndNameBookmark(builder, u"MyBookmark3");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.PAGEREF.docx");
}
static SharedPtr<FieldPageRef> InsertFieldPageRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, bool insertHyperlink,
bool insertRelativePosition, String textBefore)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldPageRef>(builder->InsertField(FieldType::FieldPageRef, true));
field->set_BookmarkName(bookmarkName);
field->set_InsertHyperlink(insertHyperlink);
field->set_InsertRelativePosition(insertRelativePosition);
builder->Writeln();
return field;
}
static void InsertAndNameBookmark(SharedPtr<DocumentBuilder> builder, String bookmarkName)
{
builder->StartBookmark(bookmarkName);
builder->Writeln(String::Format(u"Contents of bookmark \"{0}\".", bookmarkName));
builder->EndBookmark(bookmarkName);
}
◆ get_InsertRelativePosition()
| bool Aspose::Words::Fields::FieldPageRef::get_InsertRelativePosition | ( | ) |
Gets or sets whether to insert a relative position of the bookmarked paragraph.
- Examples
Shows to insert PAGEREF fields to display the relative location of bookmarks.
void FieldPageRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
InsertAndNameBookmark(builder, u"MyBookmark1");
// Insert a PAGEREF field that displays what page a bookmark is on.
// Set the InsertHyperlink flag to make the field also function as a clickable link to the bookmark.
ASSERT_EQ(u" PAGEREF MyBookmark3 \\h", InsertFieldPageRef(builder, u"MyBookmark3", true, false, u"Hyperlink to Bookmark3, on page: ")->GetFieldCode());
// We can use the \p flag to get the PAGEREF field to display
// the bookmark's position relative to the position of the field.
// Bookmark1 is on the same page and above this field, so this field's displayed result will be "above".
ASSERT_EQ(u" PAGEREF MyBookmark1 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark1", true, true, u"Bookmark1 is ")->GetFieldCode());
// Bookmark2 will be on the same page and below this field, so this field's displayed result will be "below".
ASSERT_EQ(u" PAGEREF MyBookmark2 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark2", true, true, u"Bookmark2 is ")->GetFieldCode());
// Bookmark3 will be on a different page, so the field will display "on page 2".
ASSERT_EQ(u" PAGEREF MyBookmark3 \\h \\p", InsertFieldPageRef(builder, u"MyBookmark3", true, true, u"Bookmark3 is ")->GetFieldCode());
InsertAndNameBookmark(builder, u"MyBookmark2");
builder->InsertBreak(BreakType::PageBreak);
InsertAndNameBookmark(builder, u"MyBookmark3");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.PAGEREF.docx");
}
static SharedPtr<FieldPageRef> InsertFieldPageRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, bool insertHyperlink,
bool insertRelativePosition, String textBefore)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldPageRef>(builder->InsertField(FieldType::FieldPageRef, true));
field->set_BookmarkName(bookmarkName);
field->set_InsertHyperlink(insertHyperlink);
field->set_InsertRelativePosition(insertRelativePosition);
builder->Writeln();
return field;
}
static void InsertAndNameBookmark(SharedPtr<DocumentBuilder> builder, String bookmarkName)
{
builder->StartBookmark(bookmarkName);
builder->Writeln(String::Format(u"Contents of bookmark \"{0}\".", bookmarkName));
builder->EndBookmark(bookmarkName);
}
◆ GetSwitchType()
|
override |
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_BookmarkName()
| void Aspose::Words::Fields::FieldPageRef::set_BookmarkName | ( | System::String | value | ) |
◆ set_InsertHyperlink()
| void Aspose::Words::Fields::FieldPageRef::set_InsertHyperlink | ( | bool | value | ) |
◆ set_InsertRelativePosition()
| void Aspose::Words::Fields::FieldPageRef::set_InsertRelativePosition | ( | bool | value | ) |
◆ Type()
|
static |