IptcRecordSet class

Represents a collection of IPTC records.

Inheritance: IptcRecordSet → CustomPackage → MetadataPackage

The IptcRecordSet type exposes the following members:

Constructors

Constructor	Description
`__init__(self)`	Initializes a new instance of the `IptcRecordSet` class.
`__init__(self, data_sets)`	Initializes a new instance of the `IptcRecordSet` class.

Properties

Property	Description
metadata_type	Gets the metadata type.
keys	Gets a collection of the metadata property names.
property_descriptors	Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count	Gets the number of metadata properties.
envelope_record	Gets or sets the Envelope Record.
application_record	Gets or sets the Application Record.

Indexer

Name	Description
[index]

Methods

Method	Description
`remove(self, record_number, data_set_number)`	Removes the dataSet with the specified record and dataSet number.
`remove(self, record_number)`	Removes the record with the specified record number.
`contains(self, property_name)`	Determines whether the package contains a metadata property with the specified name.
`find_properties(self, specification)`	Finds the metadata properties satisfying a specification. The search is recursive so it affects all nested packages as well.
`update_properties(self, specification, value)`	Updates known metadata properties satisfying a specification. The operation is recursive so it affects all nested packages as well.
`remove_properties(self, specification)`	Removes metadata properties satisfying a specification.
`add_properties(self, specification, value)`	Adds known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well.
`set_properties(self, specification, value)`	Sets known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well. This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`. If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package.
`sanitize(self)`	Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.
`set(self, data_set)`	Adds or updates the specified dataSet in the appropriate record.
`add(self, data_set)`	Adds the specified dataSet to the appropriate record. The dataSet is considered as repeatable if a dataSet with the specified number already exists.
`clear(self)`	Removes all records from the collection.
`to_data_set_list(self)`	Creates a list of dataSets from the package.
`to_list(self)`	Creates a list from the package.

Remarks

Learn more | | |

Example

This code sample shows hot to update basic IPTC metadata properties.

IptcRecordSet class

IptcRecordSet class

Constructors

Properties

Indexer

Methods

Remarks

Example

See Also