Aspose::Words::Fields::FieldChar class

FieldChar class

Base class for nodes that represent field characters in a document. To learn more, visit the Working with Fields documentation article.

class FieldChar : public Aspose::Words::SpecialChar

Methods

Method	Description
Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Accepts a visitor.
Clone(bool)	Creates a duplicate of the node.
get_CustomNodeId() const	Specifies custom node identifier.
virtual get_Document() const	Gets the document to which this node belongs.
get_FieldType() const	Returns the type of the field.
get_Font()	Provides access to the font formatting of this object.
virtual get_IsComposite()	Returns true if this node can contain other nodes.
get_IsDeleteRevision()	Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
get_IsDirty() const	Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
get_IsFormatRevision()	Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
get_IsInsertRevision()	Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
get_IsLocked() const	Gets or sets whether the parent field is locked (should not recalculate its result).
get_IsMoveFromRevision()	Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
get_IsMoveToRevision()	Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
get_NextNode() const
get_NextSibling()	Gets the node immediately following this node.
get_NodeType() const override	Returns SpecialChar.
get_ParentNode()	Gets the immediate parent of this node.
get_ParentParagraph()	Retrieves the parent Paragraph of this node.
get_PreviousSibling()	Gets the node immediately preceding this node.
get_PrevNode() const
get_Range()	Returns a Range object that represents the portion of a document that is contained in this node.
GetAncestor(Aspose::Words::NodeType)	Gets the first ancestor of the specified NodeType.
GetAncestorOf()
GetField()	Returns a field for the field char.
GetText() override	Gets the special character that this node represents.
GetType() const override
Is(const System::TypeInfo&) const override
IsAncestorNode(const System::SharedPtr<Aspose::Words::Node>&)
NextPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Gets next node according to the pre-order tree traversal algorithm.
static NodeTypeToString(Aspose::Words::NodeType)	A utility method that converts a node type enum value into a user friendly string.
PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Gets the previous node according to the pre-order tree traversal algorithm.
Remove()	Removes itself from the parent.
set_CustomNodeId(int32_t)	Setter for Aspose::Words::Node::get_CustomNodeId.
set_IsDirty(bool)	Setter for Aspose::Words::Fields::FieldChar::get_IsDirty.
set_IsLocked(bool)	Setter for Aspose::Words::Fields::FieldChar::get_IsLocked.
set_NextNode(const System::SharedPtr<Aspose::Words::Node>&)
set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&)
SetParent(const System::SharedPtr<Aspose::Words::Node>&)
ToString(Aspose::Words::SaveFormat)	Exports the content of the node into a string in the specified format.
ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&)	Exports the content of the node into a string using the specified save options.
static Type()

Remarks

A complete field in a Microsoft Word document is a complex structure consisting of a field start character, field code, field separator character, field result and field end character. Some fields only have field start, field code and field end.

To easily insert a new field into a document, use the InsertField() method.

Examples

Shows how to work with a FieldStart node.

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

auto field = System::ExplicitCast<FieldDate>(builder->InsertField(FieldType::FieldDate, true));
field->get_Format()->set_DateTimeFormat(u"dddd, MMMM dd, yyyy");
field->Update();

SharedPtr<FieldChar> fieldStart = field->get_Start();

ASSERT_EQ(FieldType::FieldDate, fieldStart->get_FieldType());
ASPOSE_ASSERT_EQ(false, fieldStart->get_IsDirty());
ASPOSE_ASSERT_EQ(false, fieldStart->get_IsLocked());

// Retrieve the facade object which represents the field in the document.
field = System::ExplicitCast<FieldDate>(fieldStart->GetField());

ASPOSE_ASSERT_EQ(false, field->get_IsLocked());
ASSERT_EQ(u" DATE  \\@ \"dddd, MMMM dd, yyyy\"", field->GetFieldCode());

// Update the field to show the current date.
field->Update();

Aspose::Words::Fields::FieldChar class

FieldChar class

Methods

Remarks

Examples

See Also