DocumentPropertyCollection Class

Base class for BuiltInDocumentPropertyCollection and CustomDocumentPropertyCollection collections.

Inheritance Hierarchy

SystemObject
  Aspose.Cells.PropertiesDocumentPropertyCollection
    Aspose.Cells.PropertiesBuiltInDocumentPropertyCollection
    Aspose.Cells.PropertiesCustomDocumentPropertyCollection

Namespace: Aspose.Cells.Properties
Assembly: Aspose.Cells (in Aspose.Cells.dll) Version: 22.5.0.0 (22.5.0)

Syntax

C++

public abstract class DocumentPropertyCollection : IEnumerable

Public MustInherit Class DocumentPropertyCollection
	Implements IEnumerable

public ref class DocumentPropertyCollection abstract : IEnumerable

[<AbstractClassAttribute>]
type DocumentPropertyCollection =  
    class
        interface IEnumerable
    end

The DocumentPropertyCollection type exposes the following members.

Constructors

	Name	Description
	DocumentPropertyCollection	Initializes a new instance of the DocumentPropertyCollection class

Properties

	Name	Description
	Count	Gets number of items in the collection.
	ItemInt32	Returns a DocumentProperty object by index.
	ItemString	Returns a DocumentProperty object by the name of the property.

Methods

	Name	Description
	Clear	Removes all properties from the collection.
	Contains	Returns true if a property with the specified name exists in the collection.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetEnumerator
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	IndexOf	Gets the index of a property by name.
	MemberwiseClone	(Inherited from Object.)
	Remove	Removes a property with the specified name from the collection.
	RemoveAt	Removes a property at the specified index.
	ToString	(Inherited from Object.)

Examples

[C#]

//Instantiate a Workbook object by calling its empty constructor
Workbook workbook = new Workbook("book1.xls");

//Retrieve a list of all custom document properties of the Excel file
DocumentPropertyCollection customProperties = workbook.Worksheets.CustomDocumentProperties;

//Accessng a custom document property by using the property index
DocumentProperty customProperty1 = customProperties[3];

//Accessng a custom document property by using the property name
DocumentProperty customProperty2 = customProperties["Owner"];

[VB.NET]

'Instantiate a Workbook object by calling its empty constructor
Dim workbook As Workbook = New Workbook("book1.xls")

'Retrieve a list of all custom document properties of the Excel file
Dim customProperties As DocumentPropertyCollection = workbook.Worksheets.CustomDocumentProperties

'Accessng a custom document property by using the property index
Dim customProperty1 As DocumentProperty = customProperties(3)

'Accessng a custom document property by using the property name
Dim customProperty2 As DocumentProperty = customProperties("Owner")

Reference

Aspose.Cells.Properties Namespace