Class CustomDocumentPropertyCollection

Namespace: Aspose.Cells.Properties
Assembly: Aspose.Cells.dll (25.2.0)

A collection of custom document properties.

public class CustomDocumentPropertyCollection : DocumentPropertyCollection, IList<documentproperty>, ICollection<documentproperty>, IEnumerable<documentproperty>, ICollection, IEnumerable

Inheritance

object ← CollectionBase<documentproperty> ← DocumentPropertyCollection ← CustomDocumentPropertyCollection

Implements

IList<documentproperty>, ICollection<documentproperty>, IEnumerable<documentproperty>, ICollection, IEnumerable

Inherited Members

DocumentPropertyCollection.Contains(string), DocumentPropertyCollection.IndexOf(string), DocumentPropertyCollection.Remove(string), DocumentPropertyCollection.RemoveAt(int), DocumentPropertyCollection.this[string], DocumentPropertyCollection.this[int], CollectionBase<documentproperty>.BinarySearch(DocumentProperty), CollectionBase<documentproperty>.BinarySearch(DocumentProperty, IComparer<documentproperty>), CollectionBase<documentproperty>.BinarySearch(int, int, DocumentProperty, IComparer<documentproperty>), CollectionBase<documentproperty>.Contains(DocumentProperty), CollectionBase<documentproperty>.CopyTo(DocumentProperty[]), CollectionBase<documentproperty>.CopyTo(DocumentProperty[], int), CollectionBase<documentproperty>.CopyTo(int, DocumentProperty[], int, int), CollectionBase<documentproperty>.Exists(Predicate<documentproperty>), CollectionBase<documentproperty>.Find(Predicate<documentproperty>), CollectionBase<documentproperty>.FindAll(Predicate<documentproperty>), CollectionBase<documentproperty>.FindIndex(Predicate<documentproperty>), CollectionBase<documentproperty>.FindIndex(int, Predicate<documentproperty>), CollectionBase<documentproperty>.FindIndex(int, int, Predicate<documentproperty>), CollectionBase<documentproperty>.FindLast(Predicate<documentproperty>), CollectionBase<documentproperty>.FindLastIndex(Predicate<documentproperty>), CollectionBase<documentproperty>.FindLastIndex(int, Predicate<documentproperty>), CollectionBase<documentproperty>.FindLastIndex(int, int, Predicate<documentproperty>), CollectionBase<documentproperty>.IndexOf(DocumentProperty), CollectionBase<documentproperty>.IndexOf(DocumentProperty, int), CollectionBase<documentproperty>.IndexOf(DocumentProperty, int, int), CollectionBase<documentproperty>.LastIndexOf(DocumentProperty), CollectionBase<documentproperty>.LastIndexOf(DocumentProperty, int), CollectionBase<documentproperty>.LastIndexOf(DocumentProperty, int, int), CollectionBase<documentproperty>.GetEnumerator(), CollectionBase<documentproperty>.Clear(), CollectionBase<documentproperty>.RemoveAt(int), CollectionBase<documentproperty>.OnClearComplete(), CollectionBase<documentproperty>.OnClear(), CollectionBase<documentproperty>.Capacity, CollectionBase<documentproperty>.Count, CollectionBase<documentproperty>.InnerList, CollectionBase<documentproperty>.this[int], object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Examples

csharp
[C#]

//Instantiate a Workbook object
Workbook workbook = new Workbook("book1.xls");

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

'Instantiate a Workbook object
Dim workbook As New Workbook("book1.xls")

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

Remarks

Each Aspose.Cells.Properties.DocumentProperty object represents a custom property of a container document.

Methods

Add(string, string)

Creates a new custom document property of the PropertyType.String data type.

public DocumentProperty Add(string name, string value)

Parameters

name string

The name of the property.

value string

The value of the property.

Returns

DocumentProperty

The newly created property object.

Add(string, int)

Creates a new custom document property of the PropertyType.Number data type.

public DocumentProperty Add(string name, int value)

Parameters

name string

The name of the property.

value int

The value of the property.

Returns

DocumentProperty

The newly created property object.

Add(string, DateTime)

Creates a new custom document property of the PropertyType.DateTime data type.

public DocumentProperty Add(string name, DateTime value)

Parameters

name string

The name of the property.

value DateTime

The value of the property.

Returns

DocumentProperty

The newly created property object.

Add(string, bool)

Creates a new custom document property of the PropertyType.Boolean data type.

public DocumentProperty Add(string name, bool value)

Parameters

name string

The name of the property.

value bool

The value of the property.

Returns

DocumentProperty

The newly created property object.

Add(string, double)

Creates a new custom document property of the PropertyType.Float data type.

public DocumentProperty Add(string name, double value)

Parameters

name string

The name of the property.

value double

The value of the property.

Returns

DocumentProperty

The newly created property object.

AddLinkToContent(string, string)

Creates a new custom document property which links to content.

public DocumentProperty AddLinkToContent(string name, string source)

Parameters

name string

The name of the property.

source string

The source of the property. It should be the name of named range.

Returns

DocumentProperty

The newly created property object.

UpdateLinkedPropertyValue()

Update custom document property value which links to content.

public void UpdateLinkedPropertyValue()

UpdateLinkedRange()

Update custom document property value to linked range.

public void UpdateLinkedRange()

</documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty></documentproperty>