Aspose::Words::Fields::FieldTC class

FieldTC class

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

class FieldTC : public Aspose::Words::Fields::Field,
                public Aspose::Words::Fields::IFieldCodeTokenInfoProvider,
                public Aspose::Words::Fields::ITocEntry

Methods

MethodDescription
FieldTC()
get_DisplayResult()Gets the text that represents the displayed field result.
get_End() constGets the node that represents the field end.
get_EntryLevel()Gets the level of the entry.
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_IsDirty()Gets or sets 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_OmitPageNumber() overrideGets whether page number in TOC should be omitted for this 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.
get_Text()Gets the text of the entry.
virtual get_Type() constGets the Microsoft Word field type.
get_TypeIdentifier()Gets a type identifier for this field (which is typically a letter).
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_EntryLevel(const System::String&)Sets the level of the entry.
set_IsDirty(bool)Setter for Aspose::Words::Fields::Field::get_IsDirty.
set_IsLocked(bool)Setter for Aspose::Words::Fields::Field::get_IsLocked.
set_LocaleId(int32_t)Setter for Aspose::Words::Fields::Field::get_LocaleId.
set_OmitPageNumber(bool)Sets whether page number in TOC should be omitted for this field.
set_Result(const System::String&)Setter for Aspose::Words::Fields::Field::get_Result.
set_Text(const System::String&)Sets the text of the entry.
set_TypeIdentifier(const System::String&)Sets a type identifier for this field (which is typically a letter).
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