FieldTime

FieldTime class

Implements the TIME field.

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

public class FieldTime : Field

Constructors

NameDescription
FieldTime()The default constructor.

Properties

NameDescription
DisplayResult { get; }Gets the text that represents the displayed field result.
End { get; }Gets the node that represents the field end.
Format { get; }Gets a FieldFormat object that provides typed access to field’s formatting.
IsDirty { get; set; }Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
IsLocked { get; set; }Gets or sets whether the field is locked (should not recalculate its result).
LocaleId { get; set; }Gets or sets the LCID of the field.
Result { get; set; }Gets or sets text that is between the field separator and field end.
Separator { get; }Gets the node that represents the field separator. Can be null.
Start { get; }Gets the node that represents the start of the field.
virtual Type { get; }Gets the Microsoft Word field type.

Methods

NameDescription
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).
virtual 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.
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.

Remarks

Inserts the current date and time.

Examples

Shows how to display the current time using the TIME field.

public void FieldTime()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

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

    Assert.That(field.GetFieldCode(), Is.EqualTo(" TIME "));

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

    Assert.That(field.GetFieldCode(), Is.EqualTo(" TIME \\@ HHmm"));

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

    Assert.That(field.GetFieldCode(), Is.EqualTo(" TIME \\@ \"M/d/yyyy h mm:ss am/pm\""));

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

/// <summary>
/// Use a document builder to insert a TIME field, insert a new paragraph and return the field.
/// </summary>
private static FieldTime InsertFieldTime(DocumentBuilder builder, string format)
{
    FieldTime field = (FieldTime)builder.InsertField(FieldType.FieldTime, true);
    builder.MoveTo(field.Separator);
    builder.Write(format);
    builder.MoveTo(field.Start.ParentNode);

    builder.InsertParagraph();
    return field;
}

See Also

FieldTemplate Class FieldTitle Class