Aspose::Words::Fields::FieldStyleRef class

FieldStyleRef class

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

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

Methods

MethodDescription
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_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_Result()Gets or sets text that is between the field separator and field end.
get_SearchFromBottom()Gets whether to search from the bottom of the current page, rather from the top.
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.
get_StyleName()Gets the name of the style by which the text to search for is formatted.
get_SuppressNonDelimiters()Gets whether to suppress non-delimiter characters.
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_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_Result(const System::String&)Setter for Aspose::Words::Fields::Field::get_Result.
set_SearchFromBottom(bool)Sets whether to search from the bottom of the current page, rather from the top.
set_StyleName(const System::String&)Sets the name of the style by which the text to search for is formatted.
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.

See Also