FieldSaveDate Class

Implements the SAVEDATE field.

Inheritance Hierarchy

SystemObject
Aspose.Words.FieldsField
Aspose.Words.FieldsFieldSaveDate

Namespace: Aspose.Words.Fields
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 20.3

Syntax

C++

public class FieldSaveDate : Field

Public Class FieldSaveDate
	Inherits Field

public ref class FieldSaveDate : public Field

type FieldSaveDate =  
    class
        inherit Field
    end

The FieldSaveDate type exposes the following members.

Constructors

	Name	Description
	FieldSaveDate	Initializes a new instance of the FieldSaveDate class

Properties

	Name	Description
	DisplayResult	Gets the text that represents the displayed field result. (Inherited from Field.)
	End	Gets the node that represents the field end. (Inherited from Field.)
	Format	Gets a FieldFormat object that provides typed access to field's formatting. (Inherited from Field.)
	IsDirty	Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field.)
	IsLocked	Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field.)
	LocaleId	Gets or sets the LCID of the field. (Inherited from Field.)
	Result	Gets or sets text that is between the field separator and field end. (Inherited from Field.)
	Separator	Gets the node that represents the field separator. Can be null. (Inherited from Field.)
	Start	Gets the node that represents the start of the field. (Inherited from Field.)
	Type	Gets the Microsoft Word field type. (Inherited from Field.)
	UseLunarCalendar	Gets or sets whether to use the Hijri Lunar or Hebrew Lunar calendar.
	UseSakaEraCalendar	Gets or sets whether to use the Saka Era calendar.
	UseUmAlQuraCalendar	Gets or sets whether to use the Um-al-Qura calendar.

Methods

	Name	Description
	Equals	(Inherited from Object.)
	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. (Inherited from Field.)
	GetFieldCode(Boolean)	Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	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. (Inherited from Field.)
	ToString	(Inherited from Object.)
	Unlink	Performs the field unlink. (Inherited from Field.)
	Update	Performs the field update. Throws if the field is being updated already. (Inherited from Field.)
	Update(Boolean)	Performs a field update. Throws if the field is being updated already. (Inherited from Field.)

Remarks

Retrieves the date and time on which the document was last saved. By default, the Gregorian calendar is used.

Examples

Shows how to insert SAVEDATE fields the date and time a document was last saved.

// Open an existing document and move a document builder to the end
Document doc = new Document(MyDir + "Document.docx");
DocumentBuilder builder = new DocumentBuilder(doc);
builder.MoveToDocumentEnd();
builder.Writeln(" Date this document was last saved:");

// Insert a SAVEDATE field and display, using the Lunar Calendar, the date the document was last saved
builder.Write("According to the Lunar Calendar - ");
FieldSaveDate fieldSaveDate = (FieldSaveDate)builder.InsertField(FieldType.FieldSaveDate, true);
fieldSaveDate.UseLunarCalendar = true;
Assert.AreEqual(" SAVEDATE  \\h", fieldSaveDate.GetFieldCode());
builder.Writeln();

// Display the date using the Umm al-Qura Calendar
builder.Write("According to the Umm al-Qura calendar - ");
fieldSaveDate = (FieldSaveDate)builder.InsertField(FieldType.FieldSaveDate, true);
fieldSaveDate.UseUmAlQuraCalendar = true;
Assert.AreEqual(" SAVEDATE  \\u", fieldSaveDate.GetFieldCode());
builder.Writeln();

// Display the date using the Indian National Calendar
builder.Write("According to the Indian National calendar - ");
fieldSaveDate = (FieldSaveDate)builder.InsertField(FieldType.FieldSaveDate, true);
fieldSaveDate.UseSakaEraCalendar = true;
Assert.AreEqual(" SAVEDATE  \\s", fieldSaveDate.GetFieldCode());
builder.Writeln();

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.SAVEDATE.docx");

Reference

Aspose.Words.Fields Namespace