PropertyCollection Class

Class to retrieve or set a property value from a property collection.

Constructor

PropertyCollection(handle: c_void_p)

Name	Description
handle Required

get_property	Returns value of a property. If the property value is not defined, the specified default value is returned.
get_property_by_name	Returns value of a property. If the property value is not defined, the specified default value is returned.
set_property	Set value of a property. :param property_id: The id of the property :param value: The value to set
set_property_by_name	Set value of a property. :param property_name: The id name of the property :param value: The value to set

Returns value of a property. If the property value is not defined, the specified default value is returned.

get_property(property_id: PropertyId, default_value: str = '') -> str

Name	Description
property_id Required	The id of the property.
default_value Required	The default value which is returned if no value is defined for the property (empty string by default).

Type	Description
	Value of the property.

Returns value of a property. If the property value is not defined, the specified default value is returned.

get_property_by_name(property_name: str, default_value: str = '') -> str

Name	Description
property_name Required	The name of the property.
default_value Required	The default value which is returned if no value is defined for the property (empty string by default).

Type	Description
	Value of the property.

Set value of a property. :param property_id: The id of the property :param value: The value to set

set_property(property_id: PropertyId, value: str)

Name	Description
property_id Required
value Required

Set value of a property. :param property_name: The id name of the property :param value: The value to set

set_property_by_name(property_name: str, value: str)

Name	Description
property_name Required
value Required