Aspose::Words::Fields::FieldTime class

FieldTime class

Implements the TIME field. To learn more, visit the Working with Fields documentation article.

class FieldTime : 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 display the current time using the TIME field.

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

    // By default, time is displayed in the "h:mm am/pm" format.
    SharedPtr<FieldTime> field = InsertFieldTime(builder, u"");

    ASSERT_EQ(u" TIME ", field->GetFieldCode());

    // We can use the \@ flag to change the format of our displayed time.
    field = InsertFieldTime(builder, u"\\@ HHmm");

    ASSERT_EQ(u" TIME \\@ HHmm", field->GetFieldCode());

    // We can adjust the format to get TIME field to also display the date, according to the Gregorian calendar.
    field = InsertFieldTime(builder, u"\\@ \"M/d/yyyy h mm:ss am/pm\"");

    ASSERT_EQ(u" TIME \\@ \"M/d/yyyy h mm:ss am/pm\"", field->GetFieldCode());

    doc->Save(ArtifactsDir + u"Field.TIME.docx");
}

static SharedPtr<FieldTime> InsertFieldTime(SharedPtr<DocumentBuilder> builder, String format)
{
    auto field = System::ExplicitCast<FieldTime>(builder->InsertField(FieldType::FieldTime, true));
    builder->MoveTo(field->get_Separator());
    builder->Write(format);
    builder->MoveTo(field->get_Start()->get_ParentNode());

    builder->InsertParagraph();
    return field;
}

Aspose::Words::Fields::FieldTime class

FieldTime class

Methods

Examples

See Also