Detailed Description

Base class for nodes that represent field characters in a document.

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.

See also: Aspose::Words::Fields::FieldStart; Aspose::Words::Fields::FieldSeparator; Aspose::Words::Fields::FieldEnd

Examples

Shows how to work with a FieldStart node.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
auto field = System::DynamicCast<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::DynamicCast<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();

#include <Aspose.Words.Cpp/Fields/FieldChar.h>

Inheritance diagram for Aspose::Words::Fields::FieldChar:

Public Member Functions
FieldType	get_FieldType () const
	Returns the type of the field. More...

bool	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. More...

bool	get_IsLocked () const
	Gets or sets whether the parent field is locked (should not recalculate its result). More...

SharedPtr< Field >	GetField ()
	Returns a field for the field char. More...

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

void	set_IsDirty (bool value)
	Setter for get_IsDirty. More...

void	set_IsLocked (bool value)
	Setter for get_IsLocked. More...

Public Member Functions inherited from SpecialChar
bool	Accept (SharedPtr< DocumentVisitor > visitor) override
	Accepts a visitor. More...

NodeType	get_NodeType () const override
	Returns NodeType.SpecialChar. More...

String	GetText () override
	Gets the special character that this node represents. More...

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

Public Member Functions inherited from Inline
SharedPtr< Font >	get_Font ()
	Provides access to the font formatting of this object. More...

bool	get_IsDeleteRevision ()
	Returns true if this object was deleted in Microsoft Word while change tracking was enabled. More...

bool	get_IsFormatRevision ()
	Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled. More...

bool	get_IsInsertRevision ()
	Returns true if this object was inserted in Microsoft Word while change tracking was enabled. More...

bool	get_IsMoveFromRevision ()
	Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled. More...

bool	get_IsMoveToRevision ()
	Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled. More...

SharedPtr< Paragraph >	get_ParentParagraph ()
	Retrieves the parent Paragraph of this node. More...

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

Public Member Functions inherited from Node
virtual bool	Accept (SharedPtr< DocumentVisitor > visitor)=0
	Accepts a visitor. More...

SharedPtr< Node >	Clone (bool isCloneChildren)
	Creates a duplicate of the node. More...

int32_t	get_CustomNodeId () const
	Specifies custom node identifier. More...

virtual SharedPtr< DocumentBase >	get_Document () const
	Gets the document to which this node belongs. More...

virtual bool	get_IsComposite ()
	Returns true if this node can contain other nodes. More...

SharedPtr< Node >	get_NextSibling ()
	Gets the node immediately following this node. More...

virtual NodeType	get_NodeType () const =0
	Gets the type of this node. More...

SharedPtr< CompositeNode >	get_ParentNode ()
	Gets the immediate parent of this node. More...

SharedPtr< Node >	get_PreviousSibling ()
	Gets the node immediately preceding this node. More...

SharedPtr< Range >	get_Range ()
	Returns a Range object that represents the portion of a document that is contained in this node. More...

SharedPtr< CompositeNode >	GetAncestor (NodeType ancestorType)
	Gets the first ancestor of the specified NodeType. More...

template<typename T >
T	GetAncestorOf ()

virtual String	GetText ()
	Gets the text of this node and of all its children. More...

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

SharedPtr< Node >	NextPreOrder (const SharedPtr< Node > &rootNode)
	Gets next node according to the pre-order tree traversal algorithm. More...

SharedPtr< Node >	PreviousPreOrder (const SharedPtr< Node > &rootNode)
	Gets the previous node according to the pre-order tree traversal algorithm. More...

void	Remove ()
	Removes itself from the parent. More...

void	set_CustomNodeId (int32_t value)
	Setter for get_CustomNodeId. More...

String	ToString (SaveFormat saveFormat)
	Exports the content of the node into a string in the specified format. More...

String	ToString (const SharedPtr< SaveOptions > &saveOptions)
	Exports the content of the node into a string using the specified save options. More...

Static Public Member Functions
static const TypeInfo &	Type ()

Static Public Member Functions inherited from SpecialChar
static const TypeInfo &	Type ()

Static Public Member Functions inherited from Inline
static const TypeInfo &	Type ()

Static Public Member Functions inherited from Node
static String	NodeTypeToString (NodeType nodeType)
	A utility method that converts a node type enum value into a user friendly string. More...

static const TypeInfo &	Type ()

Member Function Documentation

◆ get_FieldType()

Aspose::Words::Fields::FieldType Aspose::Words::Fields::FieldChar::get_FieldType ( ) const

Returns the type of the field.

Examples

Shows how to work with a FieldStart node.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
auto field = System::DynamicCast<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::DynamicCast<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();

◆ get_IsDirty()

bool Aspose::Words::Fields::FieldChar::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.

Examples

Shows how to work with a FieldStart node.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
auto field = System::DynamicCast<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::DynamicCast<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();

◆ get_IsLocked()

bool Aspose::Words::Fields::FieldChar::get_IsLocked ( ) const

Gets or sets whether the parent field is locked (should not recalculate its result).

Examples

Shows how to work with a FieldStart node.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
auto field = System::DynamicCast<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::DynamicCast<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();

◆ GetField()

System::SharedPtr< Aspose::Words::Fields::Field > Aspose::Words::Fields::FieldChar::GetField ( )

Returns a field for the field char.

Returns: A field for the field char.

Examples

Shows how to work with a FieldStart node.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
auto field = System::DynamicCast<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::DynamicCast<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();