type property

DocumentProperty.type property

Gets the data type of the property.

@property
def type(self) -> aspose.words.properties.PropertyType:
    ...

Examples

Shows how to work with built-in document properties.

doc = aw.Document(MY_DIR + "Properties.docx")

# The "Document" object contains some of its metadata in its members.
print(f"Document filename:\n\t \"{doc.original_file_name}\"")

# The document also stores metadata in its built-in properties.
# Each built-in property is a member of the document's "BuiltInDocumentProperties" object.
print("Built-in Properties:")
for doc_property in doc.built_in_document_properties:
    print(doc_property.name)
    print(f"\tType:\t{doc_property.type}")

    # Some properties may store multiple values.
    if isinstance(doc_property.value, list):
        for value in doc_property.value:
            print(f"\tValue:\t\"{value}\"")
    else:
        print(f"\tValue:\t\"{doc_property.value}\"")

Shows how to work with a document’s custom properties.

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

self.assertEqual(0, properties.count)

# Custom document properties are key-value pairs that we can add to the document.
properties.add("Authorized", True)
properties.add("Authorized By", "John Doe")
properties.add("Authorized Date", datetime.now())
properties.add("Authorized Revision", doc.built_in_document_properties.revision_number)
properties.add("Authorized Amount", 123.45)

# The collection sorts the custom properties in alphabetic order.
self.assertEqual(1, properties.index_of("Authorized Amount"))
self.assertEqual(5, properties.count)

# Print every custom property in the document.
for prop in properties:
    print(f"Name: \"{prop.name}\"\n\tType: \"{prop.type}\"\n\tValue: \"{prop.value}\"")

# Display the value of a custom property using a DOCPROPERTY field.
builder = aw.DocumentBuilder(doc)
field = builder.insert_field(" DOCPROPERTY \"Authorized By\"").as_field_doc_property()
field.update()

self.assertEqual("John Doe", field.result)

# We can find these custom properties in Microsoft Word via "File" -> "Properties" > "Advanced Properties" > "Custom".
doc.save(ARTIFACTS_DIR + "DocumentProperties.document_property_collection.docx")

# Below are three ways or removing custom properties from a document.
# 1 -  Remove by index:
properties.remove_at(1)

self.assertFalse(properties.contains("Authorized Amount"))
self.assertEqual(4, properties.count)

# 2 -  Remove by name:
properties.remove("Authorized Revision")

self.assertFalse(properties.contains("Authorized Revision"))
self.assertEqual(3, properties.count)

# 3 -  Empty the entire collection at once:
properties.clear()

self.assertEqual(0, properties.count)

type property

DocumentProperty.type property

Examples

See Also