Aspose::Words::Fields::FieldDate class
Contents
[
Hide
]FieldDate class
Implements the DATE field. To learn more, visit the Working with Fields documentation article.
class FieldDate : 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_UseLastFormat() | Gets or sets whether to use a format last used by the hosting application when inserting a new DATE field. |
| 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_UseLastFormat(bool) | Setter for Aspose::Words::Fields::FieldDate::get_UseLastFormat. |
| set_UseLunarCalendar(bool) | Setter for Aspose::Words::Fields::FieldDate::get_UseLunarCalendar. |
| set_UseSakaEraCalendar(bool) | Setter for Aspose::Words::Fields::FieldDate::get_UseSakaEraCalendar. |
| set_UseUmAlQuraCalendar(bool) | Setter for Aspose::Words::Fields::FieldDate::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 how to use DATE fields to display dates according to different kinds of calendars.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// If we want the text in the document always to display the correct date, we can use a DATE field.
// Below are three types of cultural calendars that a DATE field can use to display a date.
// 1 - Islamic Lunar Calendar:
auto field = System::ExplicitCast<FieldDate>(builder->InsertField(FieldType::FieldDate, true));
field->set_UseLunarCalendar(true);
ASSERT_EQ(u" DATE \\h", field->GetFieldCode());
builder->Writeln();
// 2 - Umm al-Qura calendar:
field = System::ExplicitCast<FieldDate>(builder->InsertField(FieldType::FieldDate, true));
field->set_UseUmAlQuraCalendar(true);
ASSERT_EQ(u" DATE \\u", field->GetFieldCode());
builder->Writeln();
// 3 - Indian National Calendar:
field = System::ExplicitCast<FieldDate>(builder->InsertField(FieldType::FieldDate, true));
field->set_UseSakaEraCalendar(true);
ASSERT_EQ(u" DATE \\s", field->GetFieldCode());
builder->Writeln();
// Insert a DATE field and set its calendar type to the one last used by the host application.
// In Microsoft Word, the type will be the most recently used in the Insert -> Text -> Date and Time dialog box.
field = System::ExplicitCast<FieldDate>(builder->InsertField(FieldType::FieldDate, true));
field->set_UseLastFormat(true);
ASSERT_EQ(u" DATE \\l", field->GetFieldCode());
builder->Writeln();
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.DATE.docx");
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++