Aspose::Words::Fields::FieldRevNum class
Contents
[
Hide
]FieldRevNum class
Implements the REVNUM field. To learn more, visit the Working with Fields documentation article.
class FieldRevNum : public Aspose::Words::Fields::Field
Methods
| Method | Description |
|---|---|
| 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_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() const | Gets the node that represents the start of the field. |
| 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_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_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| 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 work with REVNUM fields.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"Current revision #");
// Insert a REVNUM field, which displays the document's current revision number property.
auto field = System::ExplicitCast<FieldRevNum>(builder->InsertField(FieldType::FieldRevisionNum, true));
ASSERT_EQ(u" REVNUM ", field->GetFieldCode());
ASSERT_EQ(u"1", field->get_Result());
ASSERT_EQ(1, doc->get_BuiltInDocumentProperties()->get_RevisionNumber());
// This property counts how many times a document has been saved in Microsoft Word,
// and is unrelated to tracked revisions. We can find it by right clicking the document in Windows Explorer
// via Properties -> Details. We can update this property manually.
doc->get_BuiltInDocumentProperties()->set_RevisionNumber(doc->get_BuiltInDocumentProperties()->get_RevisionNumber() + 1);
field->Update();
ASSERT_EQ(u"2", field->get_Result());
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++