Aspose::Words::Fields::FieldPrintDate class
Contents
[
Hide
]FieldPrintDate class
Implements the PRINTDATE field. To learn more, visit the Working with Fields documentation article.
class FieldPrintDate : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider
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. |
| get_UseLunarCalendar() | Gets or sets whether to use the Hijri Lunar or Hebrew Lunar calendar. |
| get_UseSakaEraCalendar() | Gets or sets whether to use the Saka Era calendar. |
| get_UseUmAlQuraCalendar() | Gets or sets whether to use the Um-al-Qura calendar. |
| 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. |
| set_UseLunarCalendar(bool) | Setter for Aspose::Words::Fields::FieldPrintDate::get_UseLunarCalendar. |
| set_UseSakaEraCalendar(bool) | Setter for Aspose::Words::Fields::FieldPrintDate::get_UseSakaEraCalendar. |
| set_UseUmAlQuraCalendar(bool) | Setter for Aspose::Words::Fields::FieldPrintDate::get_UseUmAlQuraCalendar. |
| 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 read PRINTDATE fields.
auto doc = MakeObject<Document>(MyDir + u"Field sample - PRINTDATE.docx");
// When a document is printed by a printer or printed as a PDF (but not exported to PDF),
// PRINTDATE fields will display the print operation's date/time.
// If no printing has taken place, these fields will display "0/0/0000".
auto field = System::ExplicitCast<FieldPrintDate>(doc->get_Range()->get_Fields()->idx_get(0));
ASSERT_EQ(u"3/25/2020 12:00:00 AM", field->get_Result());
ASSERT_EQ(u" PRINTDATE ", field->GetFieldCode());
// Below are three different calendar types according to which the PRINTDATE field
// can display the date and time of the last printing operation.
// 1 - Islamic Lunar Calendar:
field = System::ExplicitCast<FieldPrintDate>(doc->get_Range()->get_Fields()->idx_get(1));
ASSERT_TRUE(field->get_UseLunarCalendar());
ASSERT_EQ(u"8/1/1441 12:00:00 AM", field->get_Result());
ASSERT_EQ(u" PRINTDATE \\h", field->GetFieldCode());
field = System::ExplicitCast<FieldPrintDate>(doc->get_Range()->get_Fields()->idx_get(2));
// 2 - Umm al-Qura calendar:
ASSERT_TRUE(field->get_UseUmAlQuraCalendar());
ASSERT_EQ(u"8/1/1441 12:00:00 AM", field->get_Result());
ASSERT_EQ(u" PRINTDATE \\u", field->GetFieldCode());
field = System::ExplicitCast<FieldPrintDate>(doc->get_Range()->get_Fields()->idx_get(3));
// 3 - Indian National Calendar:
ASSERT_TRUE(field->get_UseSakaEraCalendar());
ASSERT_EQ(u"1/5/1942 12:00:00 AM", field->get_Result());
ASSERT_EQ(u" PRINTDATE \\s", field->GetFieldCode());
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++