com.aspose.cells
Class CustomDocumentPropertyCollection
java.lang.Object
DocumentPropertyCollection
com.aspose.cells.CustomDocumentPropertyCollection
- All Implemented Interfaces:
- com.aspose.cells.c.b.a.a.a.c.b.e, java.lang.Cloneable
public class CustomDocumentPropertyCollection
- extends DocumentPropertyCollection
A collection of custom document properties.
Each DocumentProperty object represents a custom property of a container document.
Example:
//Instantiate a Workbook object
Workbook workbook = new Workbook("C:\\book1.xls");
//Retrieve a list of all custom document properties of the Excel file
CustomDocumentPropertyCollection customProperties = workbook.getWorksheets().getCustomDocumentProperties();
Property Getters/Setters Detail |
-
Gets number of items in the collection.
-
Returns a DocumentProperty object by the name of the property.
Returns null if a property with the specified name is not found.
- Parameters:
name
- The case-insensitive name of the property to retrieve.
-
Returns a DocumentProperty object by index.
- Parameters:
index
- Zero-based index of the DocumentProperty to retrieve.
-
Creates a new custom document property of the PropertyType.String data type.
- Parameters:
name
- The name of the property.value
- The value of the property.
- Returns:
- The newly created property object.
-
Creates a new custom document property of the PropertyType.Number data type.
- Parameters:
name
- The name of the property.value
- The value of the property.
- Returns:
- The newly created property object.
add | |
public DocumentProperty add(java.lang.String name, com.aspose.cells.DateTime value) |
-
Creates a new custom document property of the PropertyType.DateTime data type.
- Parameters:
name
- The name of the property.value
- The value of the property.
- Returns:
- The newly created property object.
-
Creates a new custom document property of the PropertyType.Boolean data type.
- Parameters:
name
- The name of the property.value
- The value of the property.
- Returns:
- The newly created property object.
-
Creates a new custom document property of the PropertyType.Float data type.
- Parameters:
name
- The name of the property.value
- The value of the property.
- Returns:
- The newly created property object.
addLinkToContent | |
public DocumentProperty addLinkToContent(java.lang.String name, java.lang.String source) |
-
Creates a new custom document property which links to content.
- Parameters:
name
- The name of the property.source
- The source of the property
- Returns:
- The newly created property object.
updateLinkedPropertyValue | |
public void updateLinkedPropertyValue() |
-
Update custom document property value which links to content.
updateLinkedRange | |
public void updateLinkedRange() |
-
Update custom document property value to linked range.
- Returns:
-
Returns true if a property with the specified name exists in the collection.
- Parameters:
name
- The case-insensitive name of the property.
- Returns:
- True if the property exists in the collection; false otherwise.
-
Gets the index of a property by name.
- Parameters:
name
- The case-insensitive name of the property.
- Returns:
- The zero based index. Negative value if not found.
-
Removes a property with the specified name from the collection.
- Parameters:
name
- The case-insensitive name of the property.
-
Removes a property at the specified index.
- Parameters:
index
- The zero based index.
-
Removes all properties from the collection.
See Also:
Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.