Aspose::Words::Fields::FieldIncludeText class

FieldIncludeText class

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

class FieldIncludeText : public Aspose::Words::Fields::Field,
                         public Aspose::Words::Fields::IFieldCodeTokenInfoProvider,
                         public Aspose::Words::Fields::IFieldIncludeTextCode

Methods

MethodDescription
get_BookmarkName() overrideGets the name of the bookmark in the document to include.
get_DisplayResult()Gets the text that represents the displayed field result.
get_Encoding()Gets the encoding applied to the data within the referenced file.
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_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_LockFields() overrideGets whether to prevent fields in the included document from being updated.
get_MimeType()Gets the MIME type of the referenced file.
get_NamespaceMappings() overrideGets the namespace mappings for XPath queries.
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_SourceFullName() overrideGets the location of the document using an IRI.
get_Start() constGets the node that represents the start of the field.
get_TextConverter() overrideGets the name of the text converter for the format of the included file.
virtual get_Type() constGets the Microsoft Word field type.
get_XPath() overrideGets XPath for the desired portion of the XML file.
get_XslTransformation() overrideGets the location of XSL Transformation to format XML data.
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 in the document to include.
set_Encoding(const System::String&)Sets the encoding applied to the data within the referenced file.
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_LockFields(bool)Sets whether to prevent fields in the included document from being updated.
set_MimeType(const System::String&)Sets the MIME type of the referenced file.
set_NamespaceMappings(const System::String&)Sets the namespace mappings for XPath queries.
set_Result(const System::String&)Setter for Aspose::Words::Fields::Field::get_Result.
set_SourceFullName(const System::String&)Sets the location of the document using an IRI.
set_TextConverter(const System::String&)Sets the name of the text converter for the format of the included file.
set_XPath(const System::String&)Sets XPath for the desired portion of the XML file.
set_XslTransformation(const System::String&)Sets the location of XSL Transformation to format XML data.
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