com.aspose.words

Class FieldPrintDate

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldPrintDate

public class FieldPrintDate
extends Field

Implements the PRINTDATE field.

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

Remarks:

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

Examples:

Shows read PRINTDATE fields.

 
 Document doc = new Document(getMyDir() + "Field sample - PRINTDATE.docx");

 // When a document is printed by a printer or printed as a PDF (but not exported to PDF),
 // PRINTDATE fields will display the print operation's date/time.
 // If no printing has taken place, these fields will display "0/0/0000".
 FieldPrintDate field = (FieldPrintDate) doc.getRange().getFields().get(0);

 Assert.assertEquals("3/25/2020 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE ", field.getFieldCode());

 // Below are three different calendar types according to which the PRINTDATE field
 // can display the date and time of the last printing operation.
 // 1 -  Islamic Lunar Calendar:
 field = (FieldPrintDate) doc.getRange().getFields().get(1);

 Assert.assertTrue(field.getUseLunarCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\h", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(2);

 // 2 -  Umm al-Qura calendar:
 Assert.assertTrue(field.getUseUmAlQuraCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\u", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(3);

 // 3 -  Indian National Calendar:
 Assert.assertTrue(field.getUseSakaEraCalendar());
 Assert.assertEquals("1/5/1942 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\s", field.getFieldCode());
 
 

Method Summary

Modifier and Type	Method and Description
int	getSwitchType(java.lang.String switchName)
boolean	getUseLunarCalendar() Gets whether to use the Hijri Lunar or Hebrew Lunar calendar.
boolean	getUseSakaEraCalendar() Gets whether to use the Saka Era calendar.
boolean	getUseUmAlQuraCalendar() Gets whether to use the Um-al-Qura calendar.
void	setUseLunarCalendar(boolean value) Sets whether to use the Hijri Lunar or Hebrew Lunar calendar.
void	setUseSakaEraCalendar(boolean value) Sets whether to use the Saka Era calendar.
void	setUseUmAlQuraCalendar(boolean value) Sets whether to use the Um-al-Qura calendar.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUseLunarCalendar

public boolean getUseLunarCalendar()

Gets whether to use the Hijri Lunar or Hebrew Lunar calendar.

Examples:

Shows read PRINTDATE fields.

 
 Document doc = new Document(getMyDir() + "Field sample - PRINTDATE.docx");

 // When a document is printed by a printer or printed as a PDF (but not exported to PDF),
 // PRINTDATE fields will display the print operation's date/time.
 // If no printing has taken place, these fields will display "0/0/0000".
 FieldPrintDate field = (FieldPrintDate) doc.getRange().getFields().get(0);

 Assert.assertEquals("3/25/2020 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE ", field.getFieldCode());

 // Below are three different calendar types according to which the PRINTDATE field
 // can display the date and time of the last printing operation.
 // 1 -  Islamic Lunar Calendar:
 field = (FieldPrintDate) doc.getRange().getFields().get(1);

 Assert.assertTrue(field.getUseLunarCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\h", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(2);

 // 2 -  Umm al-Qura calendar:
 Assert.assertTrue(field.getUseUmAlQuraCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\u", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(3);

 // 3 -  Indian National Calendar:
 Assert.assertTrue(field.getUseSakaEraCalendar());
 Assert.assertEquals("1/5/1942 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\s", field.getFieldCode());
 
 

Returns:

Whether to use the Hijri Lunar or Hebrew Lunar calendar.

setUseLunarCalendar

public void setUseLunarCalendar(boolean value)
                         throws java.lang.Exception

Sets whether to use the Hijri Lunar or Hebrew Lunar calendar.

Examples:

Shows read PRINTDATE fields.

 
 Document doc = new Document(getMyDir() + "Field sample - PRINTDATE.docx");

 // When a document is printed by a printer or printed as a PDF (but not exported to PDF),
 // PRINTDATE fields will display the print operation's date/time.
 // If no printing has taken place, these fields will display "0/0/0000".
 FieldPrintDate field = (FieldPrintDate) doc.getRange().getFields().get(0);

 Assert.assertEquals("3/25/2020 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE ", field.getFieldCode());

 // Below are three different calendar types according to which the PRINTDATE field
 // can display the date and time of the last printing operation.
 // 1 -  Islamic Lunar Calendar:
 field = (FieldPrintDate) doc.getRange().getFields().get(1);

 Assert.assertTrue(field.getUseLunarCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\h", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(2);

 // 2 -  Umm al-Qura calendar:
 Assert.assertTrue(field.getUseUmAlQuraCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\u", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(3);

 // 3 -  Indian National Calendar:
 Assert.assertTrue(field.getUseSakaEraCalendar());
 Assert.assertEquals("1/5/1942 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\s", field.getFieldCode());
 
 

Parameters:

value - Whether to use the Hijri Lunar or Hebrew Lunar calendar.

Throws:

java.lang.Exception

getUseSakaEraCalendar

public boolean getUseSakaEraCalendar()

Gets whether to use the Saka Era calendar.

Examples:

Shows read PRINTDATE fields.

 
 Document doc = new Document(getMyDir() + "Field sample - PRINTDATE.docx");

 // When a document is printed by a printer or printed as a PDF (but not exported to PDF),
 // PRINTDATE fields will display the print operation's date/time.
 // If no printing has taken place, these fields will display "0/0/0000".
 FieldPrintDate field = (FieldPrintDate) doc.getRange().getFields().get(0);

 Assert.assertEquals("3/25/2020 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE ", field.getFieldCode());

 // Below are three different calendar types according to which the PRINTDATE field
 // can display the date and time of the last printing operation.
 // 1 -  Islamic Lunar Calendar:
 field = (FieldPrintDate) doc.getRange().getFields().get(1);

 Assert.assertTrue(field.getUseLunarCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\h", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(2);

 // 2 -  Umm al-Qura calendar:
 Assert.assertTrue(field.getUseUmAlQuraCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\u", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(3);

 // 3 -  Indian National Calendar:
 Assert.assertTrue(field.getUseSakaEraCalendar());
 Assert.assertEquals("1/5/1942 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\s", field.getFieldCode());
 
 

Returns:

Whether to use the Saka Era calendar.

setUseSakaEraCalendar

public void setUseSakaEraCalendar(boolean value)
                           throws java.lang.Exception

Sets whether to use the Saka Era calendar.

Examples:

Shows read PRINTDATE fields.

 
 Document doc = new Document(getMyDir() + "Field sample - PRINTDATE.docx");

 // When a document is printed by a printer or printed as a PDF (but not exported to PDF),
 // PRINTDATE fields will display the print operation's date/time.
 // If no printing has taken place, these fields will display "0/0/0000".
 FieldPrintDate field = (FieldPrintDate) doc.getRange().getFields().get(0);

 Assert.assertEquals("3/25/2020 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE ", field.getFieldCode());

 // Below are three different calendar types according to which the PRINTDATE field
 // can display the date and time of the last printing operation.
 // 1 -  Islamic Lunar Calendar:
 field = (FieldPrintDate) doc.getRange().getFields().get(1);

 Assert.assertTrue(field.getUseLunarCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\h", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(2);

 // 2 -  Umm al-Qura calendar:
 Assert.assertTrue(field.getUseUmAlQuraCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\u", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(3);

 // 3 -  Indian National Calendar:
 Assert.assertTrue(field.getUseSakaEraCalendar());
 Assert.assertEquals("1/5/1942 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\s", field.getFieldCode());
 
 

Parameters:

value - Whether to use the Saka Era calendar.

Throws:

java.lang.Exception

getUseUmAlQuraCalendar

public boolean getUseUmAlQuraCalendar()

Gets whether to use the Um-al-Qura calendar.

Examples:

Shows read PRINTDATE fields.

 
 Document doc = new Document(getMyDir() + "Field sample - PRINTDATE.docx");

 // When a document is printed by a printer or printed as a PDF (but not exported to PDF),
 // PRINTDATE fields will display the print operation's date/time.
 // If no printing has taken place, these fields will display "0/0/0000".
 FieldPrintDate field = (FieldPrintDate) doc.getRange().getFields().get(0);

 Assert.assertEquals("3/25/2020 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE ", field.getFieldCode());

 // Below are three different calendar types according to which the PRINTDATE field
 // can display the date and time of the last printing operation.
 // 1 -  Islamic Lunar Calendar:
 field = (FieldPrintDate) doc.getRange().getFields().get(1);

 Assert.assertTrue(field.getUseLunarCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\h", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(2);

 // 2 -  Umm al-Qura calendar:
 Assert.assertTrue(field.getUseUmAlQuraCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\u", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(3);

 // 3 -  Indian National Calendar:
 Assert.assertTrue(field.getUseSakaEraCalendar());
 Assert.assertEquals("1/5/1942 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\s", field.getFieldCode());
 
 

Returns:

Whether to use the Um-al-Qura calendar.

setUseUmAlQuraCalendar

public void setUseUmAlQuraCalendar(boolean value)
                            throws java.lang.Exception

Sets whether to use the Um-al-Qura calendar.

Examples:

Shows read PRINTDATE fields.

 
 Document doc = new Document(getMyDir() + "Field sample - PRINTDATE.docx");

 // When a document is printed by a printer or printed as a PDF (but not exported to PDF),
 // PRINTDATE fields will display the print operation's date/time.
 // If no printing has taken place, these fields will display "0/0/0000".
 FieldPrintDate field = (FieldPrintDate) doc.getRange().getFields().get(0);

 Assert.assertEquals("3/25/2020 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE ", field.getFieldCode());

 // Below are three different calendar types according to which the PRINTDATE field
 // can display the date and time of the last printing operation.
 // 1 -  Islamic Lunar Calendar:
 field = (FieldPrintDate) doc.getRange().getFields().get(1);

 Assert.assertTrue(field.getUseLunarCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\h", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(2);

 // 2 -  Umm al-Qura calendar:
 Assert.assertTrue(field.getUseUmAlQuraCalendar());
 Assert.assertEquals("8/1/1441 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\u", field.getFieldCode());

 field = (FieldPrintDate) doc.getRange().getFields().get(3);

 // 3 -  Indian National Calendar:
 Assert.assertTrue(field.getUseSakaEraCalendar());
 Assert.assertEquals("1/5/1942 12:00:00 AM", field.getResult());
 Assert.assertEquals(" PRINTDATE  \\s", field.getFieldCode());
 
 

Parameters:

value - Whether to use the Um-al-Qura calendar.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)