Aspose::Words::Fields::FieldNoteRef class

FieldNoteRef class

Implements the NOTEREF field. To learn more, visit the Working with Fields documentation article.

class FieldNoteRef : public Aspose::Words::Fields::Field,
                     public Aspose::Words::Fields::IFieldCodeTokenInfoProvider

Methods

MethodDescription
get_BookmarkName()Gets the name of the bookmark.
get_DisplayResult()Gets the text that represents the displayed field result.
get_End() constGets the node that represents the field end.
get_FieldEnd() constGets the node that represents the field end.
get_FieldStart() constGets the node that represents the start of the field.
get_Format()Gets a FieldFormat object that provides typed access to field’s formatting.
get_InsertHyperlink()Gets whether to insert a hyperlink to the bookmarked paragraph.
get_InsertReferenceMark()Inserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style.
get_InsertRelativePosition()Gets whether to insert a relative position of the bookmarked 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_Result()Gets or sets text that is between the field separator and field end.
get_Separator()Gets the node that represents the field separator. Can be null.
get_Start() constGets the node that represents the start of the field.
virtual get_Type() constGets 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&)Sets the name of the bookmark.
set_InsertHyperlink(bool)Sets whether to insert a hyperlink to the bookmarked paragraph.
set_InsertReferenceMark(bool)Inserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style.
set_InsertRelativePosition(bool)Sets whether to insert a relative position of the bookmarked 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_Result(const System::String&)Setter for Aspose::Words::Fields::Field::get_Result.
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.

See Also