Aspose::Cells::Properties::ICustomDocumentPropertyCollection Class Referenceabstract
A collection of custom document properties. More...
Inherits Aspose::Cells::Properties::IDocumentPropertyCollection.
Public Member Functions | |
| virtual intrusive_ptr< Aspose::Cells::Properties::IDocumentProperty > | AddIDocumentProperty (intrusive_ptr< Aspose::Cells::Systems::String > name, intrusive_ptr< Aspose::Cells::Systems::String > value)=0 |
| Creates a new custom document property of the PropertyType.String data type. More... | |
| virtual intrusive_ptr< Aspose::Cells::Properties::IDocumentProperty > | AddIDocumentProperty (intrusive_ptr< Aspose::Cells::Systems::String > name, Aspose::Cells::Systems::Int32 value)=0 |
| Creates a new custom document property of the PropertyType.Number data type. More... | |
| virtual intrusive_ptr< Aspose::Cells::Properties::IDocumentProperty > | AddIDocumentProperty (intrusive_ptr< Aspose::Cells::Systems::String > name, intrusive_ptr< Aspose::Cells::Systems::DateTime > value)=0 |
| Creates a new custom document property of the PropertyType.DateTime data type. More... | |
| virtual intrusive_ptr< Aspose::Cells::Properties::IDocumentProperty > | AddIDocumentProperty (intrusive_ptr< Aspose::Cells::Systems::String > name, bool value)=0 |
| Creates a new custom document property of the PropertyType.Boolean data type. More... | |
| virtual intrusive_ptr< Aspose::Cells::Properties::IDocumentProperty > | AddIDocumentProperty (intrusive_ptr< Aspose::Cells::Systems::String > name, Aspose::Cells::Systems::Double value)=0 |
| Creates a new custom document property of the PropertyType.Float data type. More... | |
| virtual intrusive_ptr< Aspose::Cells::Properties::IDocumentProperty > | AddLinkToContentProperty (intrusive_ptr< Aspose::Cells::Systems::String > name, intrusive_ptr< Aspose::Cells::Systems::String > source)=0 |
| Creates a new custom document property which links to content. More... | |
| virtual void | UpdateLinkedPropertyValue ()=0 |
| Update custom document property value which links to content. More... | |
| virtual void | UpdateLinkedRange ()=0 |
| Update custom document property value to linked range. More... | |
 Public Member Functions inherited from Aspose::Cells::Properties::IDocumentPropertyCollection | |
| virtual Aspose::Cells::Systems::Int32 | GetCount ()=0 |
| Gets number of items in the collection. More... | |
| virtual intrusive_ptr< Aspose::Cells::Properties::IDocumentProperty > | GetObjectByIndex (intrusive_ptr< Aspose::Cells::Systems::String > name)=0 |
| Returns a IDocumentProperty object by the name of the property. More... | |
| virtual intrusive_ptr< Aspose::Cells::Properties::IDocumentProperty > | GetObjectByIndex (Aspose::Cells::Systems::Int32 index)=0 |
| Returns a IDocumentProperty object by index. More... | |
| virtual intrusive_ptr< Aspose::Cells::Systems::Collections::IEnumerator > | GetEnumerator ()=0 |
| virtual bool | Contains (intrusive_ptr< Aspose::Cells::Systems::String > name)=0 |
| Returns true if a property with the specified name exists in the collection. More... | |
| virtual Aspose::Cells::Systems::Int32 | IndexOf (intrusive_ptr< Aspose::Cells::Systems::String > name)=0 |
| Gets the index of a property by name. More... | |
| virtual void | Remove (intrusive_ptr< Aspose::Cells::Systems::String > name)=0 |
| Removes a property with the specified name from the collection. More... | |
| virtual void | RemoveAt (Aspose::Cells::Systems::Int32 index)=0 |
| Removes a property at the specified index. More... | |
| virtual void | Clear ()=0 |
| Removes all properties from the collection. More... | |
| virtual void | add_ref () |
| virtual int | release_ref () |
Detailed Description
A collection of custom document properties.
Each IDocumentProperty object represents a custom property of a container document.
[C++]
//Instantiate an IWorkbook object, which must contains document property
intrusive_ptr<Aspose::Cells::IWorkbook> workbook = Factory::CreateIWorkbook(new String("C:\\book1.xls"));
//Retrieve a list of all custom document properties of the Excel file
intrusive_ptr<Aspose::Cells::Properties::ICustomDocumentPropertyCollection> customProperties =
workbook->GetIWorksheets()->GetICustomDocumentProperties();
Member Function Documentation
◆ AddIDocumentProperty() [1/5]
|
pure virtual |
Creates a new custom document property of the PropertyType.String data type.
<overloads>Creates a new custom document property.</overloads>
- Parameters
-
name The name of the property. value The value of the property.
- Returns
- The newly created property object.
◆ AddIDocumentProperty() [2/5]
|
pure virtual |
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.
◆ AddIDocumentProperty() [3/5]
|
pure virtual |
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.
◆ AddIDocumentProperty() [4/5]
|
pure virtual |
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.
◆ AddIDocumentProperty() [5/5]
|
pure virtual |
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.
◆ AddLinkToContentProperty()
|
pure virtual |
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()
|
pure virtual |
Update custom document property value which links to content.
◆ UpdateLinkedRange()
|
pure virtual |
Update custom document property value to linked range.