Aspose::Words::Fields::FieldInclude class

FieldInclude class

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

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

Methods

Method	Description
get_BookmarkName() override	Gets or sets the name of the bookmark in the document to include.
get_DisplayResult()	Gets the text that represents the displayed field result.
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_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() override	Gets or sets whether to prevent fields in the included document from being updated.
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() override	Gets or sets the location of the document.
get_Start() const	Gets the node that represents the start of the field.
get_TextConverter() override	Gets or sets the name of the text converter for the format of the included file.
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::FieldInclude::get_BookmarkName.
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)	Setter for Aspose::Words::Fields::FieldInclude::get_LockFields.
set_Result(const System::String&)	Setter for Aspose::Words::Fields::Field::get_Result.
set_SourceFullName(const System::String&)	Setter for Aspose::Words::Fields::FieldInclude::get_SourceFullName.
set_TextConverter(const System::String&)	Setter for Aspose::Words::Fields::FieldInclude::get_TextConverter.
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 an INCLUDE field, and set its properties.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);

// We can use an INCLUDE field to import a portion of another document in the local file system.
// The bookmark from the other document that we reference with this field contains this imported portion.
auto field = System::ExplicitCast<FieldInclude>(builder->InsertField(FieldType::FieldInclude, true));
field->set_SourceFullName(MyDir + u"Bookmarks.docx");
field->set_BookmarkName(u"MyBookmark1");
field->set_LockFields(false);
field->set_TextConverter(u"Microsoft Word");

ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(field->GetFieldCode(), u" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\"")->get_Success());

doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.INCLUDE.docx");

Aspose::Words::Fields::FieldInclude class

FieldInclude class

Methods

Examples

See Also