DocumentPropertyCollection class

DocumentPropertyCollection class

Base class for BuiltInDocumentProperties and CustomDocumentProperties collections. To learn more, visit the Work with Document Properties documentation article.

Remarks

The names of the properties are case-insensitive.

The properties in the collection are sorted alphabetically by name.

Indexers

NameDescription
__getitem__(index)Returns a DocumentProperty object by index.

Properties

NameDescription
countGets number of items in the collection.

Methods

NameDescription
clear()Removes all properties from the collection.
contains(name)Returns True if a property with the specified name exists in the collection.
get_by_name(name)Returns a DocumentProperty object by the name of the property.
index_of(name)Gets the index of a property by name.
remove(name)Removes a property with the specified name from the collection.
remove_at(index)Removes a property at the specified index.

Examples

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.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)

See Also

DocumentProperty class DocumentSecurity enumeration