Aspose::Words::Fields::FieldRef class
Contents
[
Hide
]FieldRef class
Implements the REF field. To learn more, visit the Working with Fields documentation article.
class FieldRef : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider,
public Aspose::Words::Fields::IMergeFieldSurrogate
Methods
| Method | Description |
|---|---|
| get_BookmarkName() | Gets or sets the referenced bookmark’s name. |
| get_DisplayResult() | Gets the text that represents the displayed field result. |
| get_End() override | Gets the node that represents the field end. |
| get_End() const | Gets the node that represents the field end. |
| get_FieldEnd() const | Gets the node that represents the field end. |
| get_FieldStart() const | Gets the node that represents the start of the field. |
| get_Format() | Gets a FieldFormat object that provides typed access to field’s formatting. |
| get_IncludeNoteOrComment() | Gets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text. |
| get_InsertHyperlink() | Gets whether to create a hyperlink to the bookmarked paragraph. |
| get_InsertParagraphNumber() | Gets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document. |
| get_InsertParagraphNumberInFullContext() | Gets whether to insert the paragraph number of the referenced paragraph in full context. |
| get_InsertParagraphNumberInRelativeContext() | Gets whether to insert the paragraph number of the referenced paragraph in relative context. |
| get_InsertRelativePosition() | Gets whether to insert the relative position of the referenced paragraph. |
| get_IsDirty() | Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| get_IsLocked() | Gets or sets whether the field is locked (should not recalculate its result). |
| get_LocaleId() | Gets or sets the LCID of the field. |
| get_NumberSeparator() | Gets the character sequence that is used to separate sequence numbers and page numbers. |
| get_Result() | Gets or sets text that is between the field separator and field end. |
| get_Separator() override | Gets the node that represents the field separator. Can be null. |
| get_Start() override | Gets the node that represents the start of the field. |
| get_Start() const | Gets the node that represents the start of the field. |
| get_SuppressNonDelimiters() | Gets whether to suppress non-delimiter characters. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| 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. |
| GetFieldCode(bool) | Returns text between field start and field separator (or field end if there is no separator). |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| 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. |
| set_BookmarkName(const System::String&) | Setter for Aspose::Words::Fields::FieldRef::get_BookmarkName. |
| set_IncludeNoteOrComment(bool) | Sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text. |
| set_InsertHyperlink(bool) | Sets whether to create a hyperlink to the bookmarked paragraph. |
| set_InsertParagraphNumber(bool) | Sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document. |
| set_InsertParagraphNumberInFullContext(bool) | Sets whether to insert the paragraph number of the referenced paragraph in full context. |
| set_InsertParagraphNumberInRelativeContext(bool) | Sets whether to insert the paragraph number of the referenced paragraph in relative context. |
| set_InsertRelativePosition(bool) | Sets whether to insert the relative position of the referenced paragraph. |
| set_IsDirty(bool) | Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| set_IsLocked(bool) | Setter for Aspose::Words::Fields::Field::get_IsLocked. |
| set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
| set_NumberSeparator(const System::String&) | Sets the character sequence that is used to separate sequence numbers and page numbers. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| set_SuppressNonDelimiters(bool) | Sets whether to suppress non-delimiter characters. |
| static Type() | |
| Unlink() | Performs the field unlink. |
| Update() | Performs the field update. Throws if the field is being updated already. |
| Update(bool) | Performs a field update. Throws if the field is being updated already. |
Examples
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::ExplicitCast<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::ExplicitCast<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");
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++