to_date_time method

to_date_time()

Returns the property value as DateTime in UTC.

def to_date_time(self):
    ...

Remarks

Throws an exception if the property type is not PropertyType.DATE_TIME.

Microsoft Word stores only the date part (no time) for custom date properties.

Examples

Shows how to create a custom document property which contains a date and time.

doc = aw.Document()

doc.custom_document_properties.add("AuthorizationDate", datetime.utcnow())

print("Document authorized on", doc.custom_document_properties.get_by_name("AuthorizationDate").to_date_time())

Shows various type conversion methods of custom document properties.

doc = aw.Document()
properties = doc.custom_document_properties

auth_date = datetime.now()
properties.add("Authorized", True)
properties.add("Authorized By", "John Doe")
properties.add("Authorized Date", auth_date)
properties.add("Authorized Revision", doc.built_in_document_properties.revision_number)
properties.add("Authorized Amount", 123.45)

self.assertEqual(True, properties.get_by_name("Authorized").to_bool())
self.assertEqual("John Doe", str(properties.get_by_name("Authorized By")))
self.assertEqual(auth_date, properties.get_by_name("Authorized Date").to_date_time())
self.assertEqual(1, properties.get_by_name("Authorized Revision").to_int())
self.assertEqual(123.45, properties.get_by_name("Authorized Amount").to_double())

to_date_time method

to_date_time()

Remarks

Examples

See Also