java.lang.Objectcom.aspose.words.DocumentPropertyCollection
public abstract class DocumentPropertyCollection
The names of the properties are case-insensitive. The properties in the collection are sorted alphabetically by name. Example:
// Create a blank document and get its custom property collection
Document doc = new Document();
CustomDocumentProperties properties = doc.getCustomDocumentProperties();
// The collection will be empty by default
Assert.assertEquals(properties.getCount(), 0);
// We can populate it with key/value pairs with a variety of value types
properties.add("Authorized", true);
properties.add("Authorized By", "John Doe");
properties.add("Authorized Date", new Date());
properties.add("Authorized Revision", doc.getBuiltInDocumentProperties().getRevisionNumber());
properties.add("Authorized Amount", 123.45);
// Custom properties are automatically sorted in alphabetic order
Assert.assertEquals(properties.indexOf("Authorized Amount"), 1);
Assert.assertEquals(properties.getCount(), 5);
// Enumerate and print all custom properties
Iterator<DocumentProperty> enumerator = properties.iterator();
try {
while (enumerator.hasNext()) {
DocumentProperty property = enumerator.next();
System.out.println(MessageFormat.format("Name: \"{0}\", Type: \"{1}\", Value: \"{2}\"", property.getName(), property.getType(), property.getValue()));
}
} finally {
if (enumerator != null) enumerator.remove();
}
// We can view/edit custom properties by opening the document and looking in File > Properties > Advanced Properties > Custom
doc.save(getArtifactsDir() + "Properties.DocumentPropertyCollection.docx");
// We can remove elements from the property collection by index or by name
properties.removeAt(1);
Assert.assertFalse(properties.contains("Authorized Amount"));
Assert.assertEquals(properties.getCount(), 4);
properties.remove("Authorized Revision");
Assert.assertFalse(properties.contains("Authorized Revision"));
Assert.assertEquals(properties.getCount(), 3);
// We can also empty the entire custom property collection at once
properties.clear();
Assert.assertEquals(properties.getCount(), 0);
Property Getters/Setters Summary | ||
---|---|---|
int | getCount() | |
Gets number of items in the collection. | ||
DocumentProperty | get(int index) | |
Returns a |
||
DocumentProperty | get(java.lang.String name) | |
Returns a |
Method Summary | ||
---|---|---|
void | clear() | |
Removes all properties from the collection. | ||
boolean | contains(java.lang.String name) | |
Returns true if a property with the specified name exists in the collection. | ||
int | indexOf(java.lang.String name) | |
Gets the index of a property by name. | ||
java.util.Iterator<DocumentProperty> | iterator() | |
Returns an iterator object that can be used to iterate over all items in the collection. | ||
void | remove(java.lang.String name) | |
Removes a property with the specified name from the collection. | ||
void | removeAt(int index) | |
Removes a property at the specified index. |
Property Getters/Setters Detail |
---|
getCount | |
public int getCount() |
Example:
Enumerates through all built-in and custom properties in a document using indexed access.String fileName = getMyDir() + "Properties.doc"; Document doc = new Document(fileName); System.out.println(MessageFormat.format("1. Document name: {0}", fileName)); System.out.println("2. Built-in Properties"); for (int i = 0; i < doc.getBuiltInDocumentProperties().getCount(); i++) { DocumentProperty docProperty = doc.getBuiltInDocumentProperties().get(i); System.out.println(MessageFormat.format("{0}({1}) : {2}", docProperty.getName(), docProperty.getType(), docProperty.getValue())); } System.out.println("3. Custom Properties"); for (int i = 0; i < doc.getCustomDocumentProperties().getCount(); i++) { DocumentProperty docProperty = doc.getCustomDocumentProperties().get(i); System.out.println(MessageFormat.format("{0}({1}) : {2}", docProperty.getName(), docProperty.getType(), docProperty.getValue())); }
get | |
public DocumentProperty get(int index) |
Note: In Java this method is slow because iterates over all nodes.
index
- Zero-based index of the Example:
Enumerates through all built-in and custom properties in a document using indexed access.String fileName = getMyDir() + "Properties.doc"; Document doc = new Document(fileName); System.out.println(MessageFormat.format("1. Document name: {0}", fileName)); System.out.println("2. Built-in Properties"); for (int i = 0; i < doc.getBuiltInDocumentProperties().getCount(); i++) { DocumentProperty docProperty = doc.getBuiltInDocumentProperties().get(i); System.out.println(MessageFormat.format("{0}({1}) : {2}", docProperty.getName(), docProperty.getType(), docProperty.getValue())); } System.out.println("3. Custom Properties"); for (int i = 0; i < doc.getCustomDocumentProperties().getCount(); i++) { DocumentProperty docProperty = doc.getCustomDocumentProperties().get(i); System.out.println(MessageFormat.format("{0}({1}) : {2}", docProperty.getName(), docProperty.getType(), docProperty.getValue())); }
get | |
public DocumentProperty get(java.lang.String name) |
Returns null if a property with the specified name is not found.
name
- The case-insensitive name of the property to retrieve.Example:
Retrieves a custom document property by name.Document doc = new Document(getMyDir() + "Properties.doc"); DocumentProperty docProperty = doc.getCustomDocumentProperties().get("Authorized Date"); if (docProperty != null) { System.out.println(docProperty.toDateTime()); } else { System.out.println("The document is not authorized. Authorizing..."); doc.getCustomDocumentProperties().add("AuthorizedDate", new Date()); }
Method Detail |
---|
clear | |
public void clear() |
Example:
Shows how to add custom properties to a document.// Create a blank document and get its custom property collection Document doc = new Document(); CustomDocumentProperties properties = doc.getCustomDocumentProperties(); // The collection will be empty by default Assert.assertEquals(properties.getCount(), 0); // We can populate it with key/value pairs with a variety of value types properties.add("Authorized", true); properties.add("Authorized By", "John Doe"); properties.add("Authorized Date", new Date()); properties.add("Authorized Revision", doc.getBuiltInDocumentProperties().getRevisionNumber()); properties.add("Authorized Amount", 123.45); // Custom properties are automatically sorted in alphabetic order Assert.assertEquals(properties.indexOf("Authorized Amount"), 1); Assert.assertEquals(properties.getCount(), 5); // Enumerate and print all custom properties Iterator<DocumentProperty> enumerator = properties.iterator(); try { while (enumerator.hasNext()) { DocumentProperty property = enumerator.next(); System.out.println(MessageFormat.format("Name: \"{0}\", Type: \"{1}\", Value: \"{2}\"", property.getName(), property.getType(), property.getValue())); } } finally { if (enumerator != null) enumerator.remove(); } // We can view/edit custom properties by opening the document and looking in File > Properties > Advanced Properties > Custom doc.save(getArtifactsDir() + "Properties.DocumentPropertyCollection.docx"); // We can remove elements from the property collection by index or by name properties.removeAt(1); Assert.assertFalse(properties.contains("Authorized Amount")); Assert.assertEquals(properties.getCount(), 4); properties.remove("Authorized Revision"); Assert.assertFalse(properties.contains("Authorized Revision")); Assert.assertEquals(properties.getCount(), 3); // We can also empty the entire custom property collection at once properties.clear(); Assert.assertEquals(properties.getCount(), 0);
contains | |
public boolean contains(java.lang.String name) |
name
- The case-insensitive name of the property.Example:
Shows how to add custom properties to a document.// Create a blank document and get its custom property collection Document doc = new Document(); CustomDocumentProperties properties = doc.getCustomDocumentProperties(); // The collection will be empty by default Assert.assertEquals(properties.getCount(), 0); // We can populate it with key/value pairs with a variety of value types properties.add("Authorized", true); properties.add("Authorized By", "John Doe"); properties.add("Authorized Date", new Date()); properties.add("Authorized Revision", doc.getBuiltInDocumentProperties().getRevisionNumber()); properties.add("Authorized Amount", 123.45); // Custom properties are automatically sorted in alphabetic order Assert.assertEquals(properties.indexOf("Authorized Amount"), 1); Assert.assertEquals(properties.getCount(), 5); // Enumerate and print all custom properties Iterator<DocumentProperty> enumerator = properties.iterator(); try { while (enumerator.hasNext()) { DocumentProperty property = enumerator.next(); System.out.println(MessageFormat.format("Name: \"{0}\", Type: \"{1}\", Value: \"{2}\"", property.getName(), property.getType(), property.getValue())); } } finally { if (enumerator != null) enumerator.remove(); } // We can view/edit custom properties by opening the document and looking in File > Properties > Advanced Properties > Custom doc.save(getArtifactsDir() + "Properties.DocumentPropertyCollection.docx"); // We can remove elements from the property collection by index or by name properties.removeAt(1); Assert.assertFalse(properties.contains("Authorized Amount")); Assert.assertEquals(properties.getCount(), 4); properties.remove("Authorized Revision"); Assert.assertFalse(properties.contains("Authorized Revision")); Assert.assertEquals(properties.getCount(), 3); // We can also empty the entire custom property collection at once properties.clear(); Assert.assertEquals(properties.getCount(), 0);
indexOf | |
public int indexOf(java.lang.String name) |
Note: In Java this method is slow because iterates over all nodes.
name
- The case-insensitive name of the property.Example:
Shows how to add custom properties to a document.// Create a blank document and get its custom property collection Document doc = new Document(); CustomDocumentProperties properties = doc.getCustomDocumentProperties(); // The collection will be empty by default Assert.assertEquals(properties.getCount(), 0); // We can populate it with key/value pairs with a variety of value types properties.add("Authorized", true); properties.add("Authorized By", "John Doe"); properties.add("Authorized Date", new Date()); properties.add("Authorized Revision", doc.getBuiltInDocumentProperties().getRevisionNumber()); properties.add("Authorized Amount", 123.45); // Custom properties are automatically sorted in alphabetic order Assert.assertEquals(properties.indexOf("Authorized Amount"), 1); Assert.assertEquals(properties.getCount(), 5); // Enumerate and print all custom properties Iterator<DocumentProperty> enumerator = properties.iterator(); try { while (enumerator.hasNext()) { DocumentProperty property = enumerator.next(); System.out.println(MessageFormat.format("Name: \"{0}\", Type: \"{1}\", Value: \"{2}\"", property.getName(), property.getType(), property.getValue())); } } finally { if (enumerator != null) enumerator.remove(); } // We can view/edit custom properties by opening the document and looking in File > Properties > Advanced Properties > Custom doc.save(getArtifactsDir() + "Properties.DocumentPropertyCollection.docx"); // We can remove elements from the property collection by index or by name properties.removeAt(1); Assert.assertFalse(properties.contains("Authorized Amount")); Assert.assertEquals(properties.getCount(), 4); properties.remove("Authorized Revision"); Assert.assertFalse(properties.contains("Authorized Revision")); Assert.assertEquals(properties.getCount(), 3); // We can also empty the entire custom property collection at once properties.clear(); Assert.assertEquals(properties.getCount(), 0);
iterator | |
public java.util.Iterator<DocumentProperty> iterator() |
Example:
Shows how to add custom properties to a document.// Create a blank document and get its custom property collection Document doc = new Document(); CustomDocumentProperties properties = doc.getCustomDocumentProperties(); // The collection will be empty by default Assert.assertEquals(properties.getCount(), 0); // We can populate it with key/value pairs with a variety of value types properties.add("Authorized", true); properties.add("Authorized By", "John Doe"); properties.add("Authorized Date", new Date()); properties.add("Authorized Revision", doc.getBuiltInDocumentProperties().getRevisionNumber()); properties.add("Authorized Amount", 123.45); // Custom properties are automatically sorted in alphabetic order Assert.assertEquals(properties.indexOf("Authorized Amount"), 1); Assert.assertEquals(properties.getCount(), 5); // Enumerate and print all custom properties Iterator<DocumentProperty> enumerator = properties.iterator(); try { while (enumerator.hasNext()) { DocumentProperty property = enumerator.next(); System.out.println(MessageFormat.format("Name: \"{0}\", Type: \"{1}\", Value: \"{2}\"", property.getName(), property.getType(), property.getValue())); } } finally { if (enumerator != null) enumerator.remove(); } // We can view/edit custom properties by opening the document and looking in File > Properties > Advanced Properties > Custom doc.save(getArtifactsDir() + "Properties.DocumentPropertyCollection.docx"); // We can remove elements from the property collection by index or by name properties.removeAt(1); Assert.assertFalse(properties.contains("Authorized Amount")); Assert.assertEquals(properties.getCount(), 4); properties.remove("Authorized Revision"); Assert.assertFalse(properties.contains("Authorized Revision")); Assert.assertEquals(properties.getCount(), 3); // We can also empty the entire custom property collection at once properties.clear(); Assert.assertEquals(properties.getCount(), 0);
remove | |
public void remove(java.lang.String name) |
name
- The case-insensitive name of the property.Example:
Shows how to add custom properties to a document.// Create a blank document and get its custom property collection Document doc = new Document(); CustomDocumentProperties properties = doc.getCustomDocumentProperties(); // The collection will be empty by default Assert.assertEquals(properties.getCount(), 0); // We can populate it with key/value pairs with a variety of value types properties.add("Authorized", true); properties.add("Authorized By", "John Doe"); properties.add("Authorized Date", new Date()); properties.add("Authorized Revision", doc.getBuiltInDocumentProperties().getRevisionNumber()); properties.add("Authorized Amount", 123.45); // Custom properties are automatically sorted in alphabetic order Assert.assertEquals(properties.indexOf("Authorized Amount"), 1); Assert.assertEquals(properties.getCount(), 5); // Enumerate and print all custom properties Iterator<DocumentProperty> enumerator = properties.iterator(); try { while (enumerator.hasNext()) { DocumentProperty property = enumerator.next(); System.out.println(MessageFormat.format("Name: \"{0}\", Type: \"{1}\", Value: \"{2}\"", property.getName(), property.getType(), property.getValue())); } } finally { if (enumerator != null) enumerator.remove(); } // We can view/edit custom properties by opening the document and looking in File > Properties > Advanced Properties > Custom doc.save(getArtifactsDir() + "Properties.DocumentPropertyCollection.docx"); // We can remove elements from the property collection by index or by name properties.removeAt(1); Assert.assertFalse(properties.contains("Authorized Amount")); Assert.assertEquals(properties.getCount(), 4); properties.remove("Authorized Revision"); Assert.assertFalse(properties.contains("Authorized Revision")); Assert.assertEquals(properties.getCount(), 3); // We can also empty the entire custom property collection at once properties.clear(); Assert.assertEquals(properties.getCount(), 0);
removeAt | |
public void removeAt(int index) |
Note: In Java this method is slow because iterates over all nodes.
index
- The zero based index.Example:
Shows how to add custom properties to a document.// Create a blank document and get its custom property collection Document doc = new Document(); CustomDocumentProperties properties = doc.getCustomDocumentProperties(); // The collection will be empty by default Assert.assertEquals(properties.getCount(), 0); // We can populate it with key/value pairs with a variety of value types properties.add("Authorized", true); properties.add("Authorized By", "John Doe"); properties.add("Authorized Date", new Date()); properties.add("Authorized Revision", doc.getBuiltInDocumentProperties().getRevisionNumber()); properties.add("Authorized Amount", 123.45); // Custom properties are automatically sorted in alphabetic order Assert.assertEquals(properties.indexOf("Authorized Amount"), 1); Assert.assertEquals(properties.getCount(), 5); // Enumerate and print all custom properties Iterator<DocumentProperty> enumerator = properties.iterator(); try { while (enumerator.hasNext()) { DocumentProperty property = enumerator.next(); System.out.println(MessageFormat.format("Name: \"{0}\", Type: \"{1}\", Value: \"{2}\"", property.getName(), property.getType(), property.getValue())); } } finally { if (enumerator != null) enumerator.remove(); } // We can view/edit custom properties by opening the document and looking in File > Properties > Advanced Properties > Custom doc.save(getArtifactsDir() + "Properties.DocumentPropertyCollection.docx"); // We can remove elements from the property collection by index or by name properties.removeAt(1); Assert.assertFalse(properties.contains("Authorized Amount")); Assert.assertEquals(properties.getCount(), 4); properties.remove("Authorized Revision"); Assert.assertFalse(properties.contains("Authorized Revision")); Assert.assertEquals(properties.getCount(), 3); // We can also empty the entire custom property collection at once properties.clear(); Assert.assertEquals(properties.getCount(), 0);