search/mag_sel search/close
Public Member Functions | Static Public Member Functions | List of all members
Aspose::Words::Fields::FieldRef Class Reference

Implements the REF field.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

Shows how to create bookmarked text with a SET field, and then display it in the document using a REF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Name bookmarked text with a SET field.
// This field refers to the "bookmark" not a bookmark structure that appears within the text, but a named variable.
auto fieldSet = System::DynamicCast<FieldSet>(builder->InsertField(FieldType::FieldSet, false));
fieldSet->set_BookmarkName(u"MyBookmark");
fieldSet->set_BookmarkText(u"Hello world!");
fieldSet->Update();
ASSERT_EQ(u" SET MyBookmark \"Hello world!\"", fieldSet->GetFieldCode());
// Refer to the bookmark by name in a REF field and display its contents.
auto fieldRef = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
fieldRef->set_BookmarkName(u"MyBookmark");
fieldRef->Update();
ASSERT_EQ(u" REF MyBookmark", fieldRef->GetFieldCode());
ASSERT_EQ(u"Hello world!", fieldRef->get_Result());
doc->Save(ArtifactsDir + u"Field.SET.REF.docx");

#include <Aspose.Words.Cpp/Fields/FieldRef.h>

+ Inheritance diagram for Aspose::Words::Fields::FieldRef:

Public Member Functions

bool CanWorkAsMergeField () override
 
String get_BookmarkName ()
 Gets or sets the referenced bookmark's name. More...
 
SharedPtr< FieldEnd > get_End () override
 Gets the node that represents the field end. More...
 
bool get_IncludeNoteOrComment ()
 Gets or sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text. More...
 
bool get_InsertHyperlink ()
 Gets or sets whether to create a hyperlink to the bookmarked paragraph. More...
 
bool get_InsertParagraphNumber ()
 Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document. More...
 
bool get_InsertParagraphNumberInFullContext ()
 Gets or sets whether to insert the paragraph number of the referenced paragraph in full context. More...
 
bool get_InsertParagraphNumberInRelativeContext ()
 Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context. More...
 
bool get_InsertRelativePosition ()
 Gets or sets whether to insert the relative position of the referenced paragraph. More...
 
String get_NumberSeparator ()
 Gets or sets the character sequence that is used to separate sequence numbers and page numbers. More...
 
SharedPtr< FieldSeparator > get_Separator () override
 Gets the node that represents the field separator. Can be null. More...
 
SharedPtr< FieldStart > get_Start () override
 Gets the node that represents the start of the field. More...
 
bool get_SuppressNonDelimiters ()
 Gets or sets whether to suppress non-delimiter characters. More...
 
String GetMergeFieldName () override
 
FieldSwitchType GetSwitchType (String switchName) override
 
virtual const TypeInfo & GetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
bool IsMergeValueRequired () override
 
void set_BookmarkName (String value)
 Setter for get_BookmarkName. More...
 
void set_IncludeNoteOrComment (bool value)
 Setter for get_IncludeNoteOrComment. More...
 
void set_InsertHyperlink (bool value)
 Setter for get_InsertHyperlink. More...
 
void set_InsertParagraphNumber (bool value)
 Setter for get_InsertParagraphNumber. More...
 
void set_InsertParagraphNumberInFullContext (bool value)
 Setter for get_InsertParagraphNumberInFullContext. More...
 
void set_InsertParagraphNumberInRelativeContext (bool value)
 Setter for get_InsertParagraphNumberInRelativeContext. More...
 
void set_InsertRelativePosition (bool value)
 Setter for get_InsertRelativePosition. More...
 
void set_NumberSeparator (String value)
 Setter for get_NumberSeparator. More...
 
void set_SuppressNonDelimiters (bool value)
 Setter for get_SuppressNonDelimiters. 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

◆ CanWorkAsMergeField()

bool Aspose::Words::Fields::FieldRef::CanWorkAsMergeField ( )
override

◆ get_BookmarkName()

System::String Aspose::Words::Fields::FieldRef::get_BookmarkName ( )

Gets or sets the referenced bookmark's name.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

Shows how to create bookmarked text with a SET field, and then display it in the document using a REF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Name bookmarked text with a SET field.
// This field refers to the "bookmark" not a bookmark structure that appears within the text, but a named variable.
auto fieldSet = System::DynamicCast<FieldSet>(builder->InsertField(FieldType::FieldSet, false));
fieldSet->set_BookmarkName(u"MyBookmark");
fieldSet->set_BookmarkText(u"Hello world!");
fieldSet->Update();
ASSERT_EQ(u" SET MyBookmark \"Hello world!\"", fieldSet->GetFieldCode());
// Refer to the bookmark by name in a REF field and display its contents.
auto fieldRef = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
fieldRef->set_BookmarkName(u"MyBookmark");
fieldRef->Update();
ASSERT_EQ(u" REF MyBookmark", fieldRef->GetFieldCode());
ASSERT_EQ(u"Hello world!", fieldRef->get_Result());
doc->Save(ArtifactsDir + u"Field.SET.REF.docx");

◆ get_End()

System::SharedPtr<Aspose::Words::Fields::FieldEnd> Aspose::Words::Fields::FieldRef::get_End ( )
override

Gets the node that represents the field end.

◆ get_IncludeNoteOrComment()

bool Aspose::Words::Fields::FieldRef::get_IncludeNoteOrComment ( )

Gets or sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

◆ get_InsertHyperlink()

bool Aspose::Words::Fields::FieldRef::get_InsertHyperlink ( )

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

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

◆ get_InsertParagraphNumber()

bool Aspose::Words::Fields::FieldRef::get_InsertParagraphNumber ( )

Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

◆ get_InsertParagraphNumberInFullContext()

bool Aspose::Words::Fields::FieldRef::get_InsertParagraphNumberInFullContext ( )

Gets or sets whether to insert the paragraph number of the referenced paragraph in full context.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

◆ get_InsertParagraphNumberInRelativeContext()

bool Aspose::Words::Fields::FieldRef::get_InsertParagraphNumberInRelativeContext ( )

Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

◆ get_InsertRelativePosition()

bool Aspose::Words::Fields::FieldRef::get_InsertRelativePosition ( )

Gets or sets whether to insert the relative position of the referenced paragraph.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

◆ get_NumberSeparator()

System::String Aspose::Words::Fields::FieldRef::get_NumberSeparator ( )

Gets or sets the character sequence that is used to separate sequence numbers and page numbers.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

◆ get_Separator()

System::SharedPtr<Aspose::Words::Fields::FieldSeparator> Aspose::Words::Fields::FieldRef::get_Separator ( )
override

Gets the node that represents the field separator. Can be null.

◆ get_Start()

System::SharedPtr<Aspose::Words::Fields::FieldStart> Aspose::Words::Fields::FieldRef::get_Start ( )
override

Gets the node that represents the start of the field.

◆ get_SuppressNonDelimiters()

bool Aspose::Words::Fields::FieldRef::get_SuppressNonDelimiters ( )

Gets or sets whether to suppress non-delimiter characters.

Examples

Shows how to insert REF fields to reference bookmarks.

void FieldRef_()
{
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartBookmark(u"MyBookmark");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #1");
builder->Write(u"Text that will appear in REF field");
builder->InsertFootnote(FootnoteType::Footnote, u"MyBookmark footnote #2");
builder->EndBookmark(u"MyBookmark");
builder->MoveToDocumentStart();
// We will apply a custom list format, where the amount of angle brackets indicates the list level we are currently at.
builder->get_ListFormat()->ApplyNumberDefault();
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u"> \x0000");
// Insert a REF field that will contain the text within our bookmark, act as a hyperlink, and clone the bookmark's footnotes.
SharedPtr<FieldRef> field = InsertFieldRef(builder, u"MyBookmark", u"", u"\n");
field->set_IncludeNoteOrComment(true);
field->set_InsertHyperlink(true);
ASSERT_EQ(u" REF MyBookmark \\f \\h", field->GetFieldCode());
// Insert a REF field, and display whether the referenced bookmark is above or below it.
field = InsertFieldRef(builder, u"MyBookmark", u"The referenced paragraph is ", u" this field.\n");
field->set_InsertRelativePosition(true);
ASSERT_EQ(u" REF MyBookmark \\p", field->GetFieldCode());
// Display the list number of the bookmark as it appears in the document.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number is ", u"\n");
field->set_InsertParagraphNumber(true);
ASSERT_EQ(u" REF MyBookmark \\n", field->GetFieldCode());
// Display the bookmark's list number, but with non-delimiter characters, such as the angle brackets, omitted.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's paragraph number, non-delimiters suppressed, is ", u"\n");
field->set_InsertParagraphNumber(true);
field->set_SuppressNonDelimiters(true);
ASSERT_EQ(u" REF MyBookmark \\n \\t", field->GetFieldCode());
// Move down one list level.
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">> \x0001");
// Display the list number of the bookmark and the numbers of all the list levels above it.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's full context paragraph number is ", u"\n");
field->set_InsertParagraphNumberInFullContext(true);
ASSERT_EQ(u" REF MyBookmark \\w", field->GetFieldCode());
builder->InsertBreak(BreakType::PageBreak);
// Display the list level numbers between this REF field, and the bookmark that it is referencing.
field = InsertFieldRef(builder, u"MyBookmark", u"The bookmark's relative paragraph number is ", u"\n");
field->set_InsertParagraphNumberInRelativeContext(true);
ASSERT_EQ(u" REF MyBookmark \\r", field->GetFieldCode());
// At the end of the document, the bookmark will show up as a list item here.
builder->Writeln(u"List level above bookmark");
builder->get_ListFormat()->set_ListLevelNumber(builder->get_ListFormat()->get_ListLevelNumber() + 1);
builder->get_ListFormat()->get_ListLevel()->set_NumberFormat(u">>> \x0002");
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.REF.docx");
}
static SharedPtr<FieldRef> InsertFieldRef(SharedPtr<DocumentBuilder> builder, String bookmarkName, String textBefore, String textAfter)
{
builder->Write(textBefore);
auto field = System::DynamicCast<FieldRef>(builder->InsertField(FieldType::FieldRef, true));
field->set_BookmarkName(bookmarkName);
builder->Write(textAfter);
return field;
}

◆ GetMergeFieldName()

System::String Aspose::Words::Fields::FieldRef::GetMergeFieldName ( )
override

◆ GetSwitchType()

Aspose::Words::Fields::FieldSwitchType Aspose::Words::Fields::FieldRef::GetSwitchType ( System::String  switchName)
override

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Fields::FieldRef::GetType ( ) const
overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ Is()

virtual bool Aspose::Words::Fields::FieldRef::Is ( const System::TypeInfo &  target) const
overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ IsMergeValueRequired()

bool Aspose::Words::Fields::FieldRef::IsMergeValueRequired ( )
override

◆ set_BookmarkName()

void Aspose::Words::Fields::FieldRef::set_BookmarkName ( System::String  value)

Setter for Aspose::Words::Fields::FieldRef::get_BookmarkName.

◆ set_IncludeNoteOrComment()

void Aspose::Words::Fields::FieldRef::set_IncludeNoteOrComment ( bool  value)

Setter for Aspose::Words::Fields::FieldRef::get_IncludeNoteOrComment.

◆ set_InsertHyperlink()

void Aspose::Words::Fields::FieldRef::set_InsertHyperlink ( bool  value)

Setter for Aspose::Words::Fields::FieldRef::get_InsertHyperlink.

◆ set_InsertParagraphNumber()

void Aspose::Words::Fields::FieldRef::set_InsertParagraphNumber ( bool  value)

Setter for Aspose::Words::Fields::FieldRef::get_InsertParagraphNumber.

◆ set_InsertParagraphNumberInFullContext()

void Aspose::Words::Fields::FieldRef::set_InsertParagraphNumberInFullContext ( bool  value)

Setter for Aspose::Words::Fields::FieldRef::get_InsertParagraphNumberInFullContext.

◆ set_InsertParagraphNumberInRelativeContext()

void Aspose::Words::Fields::FieldRef::set_InsertParagraphNumberInRelativeContext ( bool  value)

Setter for Aspose::Words::Fields::FieldRef::get_InsertParagraphNumberInRelativeContext.

◆ set_InsertRelativePosition()

void Aspose::Words::Fields::FieldRef::set_InsertRelativePosition ( bool  value)

Setter for Aspose::Words::Fields::FieldRef::get_InsertRelativePosition.

◆ set_NumberSeparator()

void Aspose::Words::Fields::FieldRef::set_NumberSeparator ( System::String  value)

Setter for Aspose::Words::Fields::FieldRef::get_NumberSeparator.

◆ set_SuppressNonDelimiters()

void Aspose::Words::Fields::FieldRef::set_SuppressNonDelimiters ( bool  value)

Setter for Aspose::Words::Fields::FieldRef::get_SuppressNonDelimiters.

◆ Type()

static const System::TypeInfo& Aspose::Words::Fields::FieldRef::Type ( )
static