FieldEditTime

FieldEditTime class

Implements the EDITTIME field.

public class FieldEditTime : Field

Constructors

Name Description
FieldEditTime() The default constructor.

Properties

Name Description
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

Name Description
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).
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

Retrieves the total editing time, in minutes, since the document was created.

Examples

Shows how to use the EDITTIME field.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// The EDITTIME field will show, in minutes,
// the time spent with the document open in a Microsoft Word window.
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.Write("You've been editing this document for ");
FieldEditTime field = (FieldEditTime)builder.InsertField(FieldType.FieldEditTime, true);
builder.Writeln(" minutes.");

// This built in document property tracks the minutes. Microsoft Word uses this property
// to track the time spent with the document open. We can also edit it ourselves.
doc.BuiltInDocumentProperties.TotalEditingTime = 10;
field.Update();

Assert.AreEqual(" EDITTIME ", field.GetFieldCode());
Assert.AreEqual("10", field.Result);

// The field does not update itself in real-time, and will also have to be
// manually updated in Microsoft Word anytime we need an accurate value.
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.EDITTIME.docx");

See Also