FieldPrintDate Class
Implements the PRINTDATE field.
Inheritance Hierarchy
SystemObject
  Aspose.Words.FieldsField
    Aspose.Words.FieldsFieldPrintDate

Namespace: Aspose.Words.Fields
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 19.11
Syntax
public class FieldPrintDate : Field

The FieldPrintDate type exposes the following members.

Constructors
  NameDescription
Public methodFieldPrintDate
Initializes a new instance of the FieldPrintDate class
Properties
  NameDescription
Public propertyCode exampleDisplayResult
Gets the text that represents the displayed field result.
(Inherited from Field.)
Public propertyCode exampleEnd
Gets the node that represents the field end.
(Inherited from Field.)
Public propertyCode exampleFormat
Gets a FieldFormat object that provides typed access to field's formatting.
(Inherited from Field.)
Public propertyCode exampleIsDirty
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.)
Public propertyCode exampleIsLocked
Gets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field.)
Public propertyCode exampleLocaleId
Gets or sets the LCID of the field.
(Inherited from Field.)
Public propertyCode exampleResult
Gets or sets text that is between the field separator and field end.
(Inherited from Field.)
Public propertyCode exampleSeparator
Gets the node that represents the field separator. Can be null.
(Inherited from Field.)
Public propertyCode exampleStart
Gets the node that represents the start of the field.
(Inherited from Field.)
Public propertyCode exampleType
Gets the Microsoft Word field type.
(Inherited from Field.)
Public propertyCode exampleUseLunarCalendar
Gets or sets whether to use the Hijri Lunar or Hebrew Lunar calendar.
Public propertyCode exampleUseSakaEraCalendar
Gets or sets whether to use the Saka Era calendar.
Public propertyCode exampleUseUmAlQuraCalendar
Gets or sets whether to use the Um-al-Qura calendar.
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodCode exampleGetFieldCode
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.)
Public methodCode exampleGetFieldCode(Boolean)
Returns text between field start and field separator (or field end if there is no separator).
(Inherited from Field.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodNeedStoreOldResultNodes (Inherited from Field.)
Public methodCode exampleRemove
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.)
Public methodToString (Inherited from Object.)
Public methodCode exampleUnlink
Performs the field unlink.
(Inherited from Field.)
Public methodCode exampleUpdate
Performs the field update. Throws if the field is being updated already.
(Inherited from Field.)
Public methodCode exampleUpdate(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 printed. By default, the Gregorian calendar is used.
Examples
Shows to insert a PRINT field.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Write("My paragraph");

// The PRINT field can send instructions to the printer that we use to print our document
FieldPrint field = (FieldPrint)builder.InsertField(FieldType.FieldPrint, true);

// Set the area for the printer to perform instructions over
// In this case it will be the paragraph that contains our PRINT field
field.PostScriptGroup = "para";

// When our document is printed using a printer that supports PostScript,
// this command will turn the entire area that we specified in field.PostScriptGroup white 
field.PrinterInstructions = "erasepage";

Assert.AreEqual(" PRINT  erasepage \\p para", field.GetFieldCode());

builder.InsertParagraph();

// PRINTDATE field will display "0/0/0000" by default
// When a document is printed by a printer or printed as a PDF (but not exported as PDF),
// these fields will display the date/time of the printing operation, in various calendars
FieldPrintDate fieldPrintDate = (FieldPrintDate)builder.InsertField(FieldType.FieldPrintDate, true);
fieldPrintDate.UseLunarCalendar = true;
builder.Writeln();

Assert.AreEqual(" PRINTDATE  \\h", fieldPrintDate.GetFieldCode());

fieldPrintDate = (FieldPrintDate)builder.InsertField(FieldType.FieldPrintDate, true);
fieldPrintDate.UseSakaEraCalendar = true;
builder.Writeln();

Assert.AreEqual(" PRINTDATE  \\s", fieldPrintDate.GetFieldCode());

fieldPrintDate = (FieldPrintDate)builder.InsertField(FieldType.FieldPrintDate, true);
fieldPrintDate.UseUmAlQuraCalendar = true;
builder.Writeln();

Assert.AreEqual(" PRINTDATE  \\u", fieldPrintDate.GetFieldCode());

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.Print.docx");
See Also