PdfPackage Class
Contents
[
Hide
]Summary: Represents Adobe Pdf namespace.
Module: aspose.psd.xmp.schemas.pdf
Full Name: aspose.psd.xmp.schemas.pdf.PdfPackage
Inheritance: IXmlValue, XmpPackage
Aspose.PSD Version: 24.12.0
Constructors
| Name | Description |
|---|---|
| PdfPackage() | Initializes a new instance of the PdfPackage class |
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| namespace_uri | string | r | Gets the namespace URI. |
| prefix | string | r | Gets the prefix. |
| xml_namespace | string | r | Gets the XML namespace. |
Methods
| Name | Description |
|---|---|
| add_value(key, value) | Adds string property. |
| clear() | Clears this instance. |
| contains_key(key) | Determines whether the specified key contains key. |
| get_xml_value() | Converts XMP value to the XML representation. |
| remove(key) | Remove the value with the specified key. |
| set_keywords(keywords) | Sets the keywords. |
| set_pdf_version(version) | Sets the PDF version. |
| set_producer(producer) | Sets the name of the tool that created Pdf. |
| set_trapped(is_trapped) | Sets the trapped. |
| set_value(key, value) | Sets the value. |
| set_xmp_type_value(key, value) | Sets the XMP type value. |
Constructor: PdfPackage()
PdfPackage()
Initializes a new instance of the PdfPackage class
Method: add_value(key, value)
add_value(key, value)
Adds string property.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| key | string | The string representation of key that is identified with added value. |
| value | string | The string value. |
Method: contains_key(key)
contains_key(key)
Determines whether the specified key contains key.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| key | string | The key to be checked. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if the specified key contains key. |
Method: get_xml_value()
get_xml_value()
Converts XMP value to the XML representation.
Returns
| Type | Description |
|---|---|
| string | Returns the XMP value converted to the XML representation. |
Method: remove(key)
remove(key)
Remove the value with the specified key.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| key | string | The string representation of key that is identified with removed value. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if the value with the specified key was removed. |
Method: set_keywords(keywords)
set_keywords(keywords)
Sets the keywords.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| keywords | string | The keywords. |
Method: set_pdf_version(version)
set_pdf_version(version)
Sets the PDF version.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| version | string | Pdf version, for example: 1.0, 1.3 etc. |
Method: set_producer(producer)
set_producer(producer)
Sets the name of the tool that created Pdf.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| producer | string | The producer name. |
Method: set_trapped(is_trapped)
set_trapped(is_trapped)
Sets the trapped.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| is_trapped | bool | if set to |
Method: set_value(key, value)
set_value(key, value)
Sets the value.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| key | string | The string representation of key that is identified with added value. |
| value | IXmlValue | The value to add to. |
Method: set_xmp_type_value(key, value)
set_xmp_type_value(key, value)
Sets the XMP type value.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| key | string | The string representation of key that is identified with set value. |
| value | XmpTypeBase | The value to set to. |