PhotoshopPackage Class

Summary: Represents Adobe Photoshop namespace.

Module: aspose.imaging.xmp.schemas.photoshop

Full Name: aspose.imaging.xmp.schemas.photoshop.PhotoshopPackage

Inheritance: IXmlValue, XmpPackage

Constructors

NameDescription
PhotoshopPackage()Initializes a new instance of the PhotoshopPackage class.

Properties

NameTypeAccessDescription
URGENCY_MAX [static]intrUrgency max value.
URGENCY_MIN [static]intrUrgency min value.
namespace_uristringrGets the namespace URI.
prefixstringrGets the prefix.
xml_namespacestringrGets the XML namespace.

Methods

NameDescription
add_value(key, value)Adds string property.
clear()Clears this instance.
contains_key(key)Determines whether the specified key contains key.
get_prop_value(key)Gets the object with the specified key.
get_xml_value()Converts XMP value to the XML representation.
remove(key)Remove the value with the specified key.
set_authors_position(authors_position)Sets the authors position.
set_caption_writer(caption_writer)Sets the caption writer.
set_category(category)Sets the category.
set_city(city)Sets the city.
set_color_mode(color_mode)Sets the color mode.
set_country(country)Sets the country.
set_created_date(created_date)Sets created date.
set_credit(credit)Sets the credit.
set_document_ancestors(ancestors)Sets the document ancestors.
set_headline(headline)Sets the headline.
set_history(history)Sets the history.
set_icc_profile(icc_profile)Sets the icc profile.
set_instructions(instructions)Sets the instructions.
set_prop_value(key, value)Gets or sets the object with the specified key.
set_source(source)Sets the source.
set_state(state)Sets the state.
set_supplemental_categories(supplemental_categories)Sets supplemental categories.
set_transmission_reference(transmission_reference)Sets the transmission reference.
set_urgency(urgency)Sets the urgency.
set_value(key, value)Sets the value.
set_xmp_type_value(key, value)Sets the XMP type value.

Constructor: PhotoshopPackage()

 PhotoshopPackage() 

Initializes a new instance of the PhotoshopPackage class.

Method: add_value(key, value)

 add_value(key, value) 

Adds string property.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with added value.
valuestringThe string value.

Method: contains_key(key)

 contains_key(key) 

Determines whether the specified key contains key.

Parameters:

ParameterTypeDescription
keystringThe key to be checked.

Returns

TypeDescription
boolReturns true if the specified key contains key.

Method: get_prop_value(key)

 get_prop_value(key) 

Gets the object with the specified key.

Parameters:

ParameterTypeDescription
keystringThe key that identifies value.

Returns

TypeDescription
objectReturns the object with the specified key.

Method: get_xml_value()

 get_xml_value() 

Converts XMP value to the XML representation.

Returns

TypeDescription
stringReturns the XMP value converted to the XML representation.

Method: remove(key)

 remove(key) 

Remove the value with the specified key.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with removed value.

Returns

TypeDescription
boolReturns true if the value with the specified key was removed.

Method: set_authors_position(authors_position)

 set_authors_position(authors_position) 

Sets the authors position.

Parameters:

ParameterTypeDescription
authors_positionstringThe authors position.

Method: set_caption_writer(caption_writer)

 set_caption_writer(caption_writer) 

Sets the caption writer.

Parameters:

ParameterTypeDescription
caption_writerstringThe caption writer.

Method: set_category(category)

 set_category(category) 

Sets the category.

Parameters:

ParameterTypeDescription
categorystringThe category.

Method: set_city(city)

 set_city(city) 

Sets the city.

Parameters:

ParameterTypeDescription
citystringThe city name.

Method: set_color_mode(color_mode)

 set_color_mode(color_mode) 

Sets the color mode.

Parameters:

ParameterTypeDescription
color_modeColorModeThe color mode.

Method: set_country(country)

 set_country(country) 

Sets the country.

Parameters:

ParameterTypeDescription
countrystringThe country.

Method: set_created_date(created_date)

 set_created_date(created_date) 

Sets created date.

Parameters:

ParameterTypeDescription
created_datedatetimeThe created date.

Method: set_credit(credit)

 set_credit(credit) 

Sets the credit.

Parameters:

ParameterTypeDescription
creditstringThe credit.

Method: set_document_ancestors(ancestors)

 set_document_ancestors(ancestors) 

Sets the document ancestors.

Parameters:

ParameterTypeDescription
ancestorsstringThe ancestors.

Method: set_headline(headline)

 set_headline(headline) 

Sets the headline.

Parameters:

ParameterTypeDescription
headlinestringThe headline.

Method: set_history(history)

 set_history(history) 

Sets the history.

Parameters:

ParameterTypeDescription
historystringThe history.

Method: set_icc_profile(icc_profile)

 set_icc_profile(icc_profile) 

Sets the icc profile.

Parameters:

ParameterTypeDescription
icc_profilestringThe icc profile.

Method: set_instructions(instructions)

 set_instructions(instructions) 

Sets the instructions.

Parameters:

ParameterTypeDescription
instructionsstringThe instructions.

Method: set_prop_value(key, value)

 set_prop_value(key, value) 

Gets or sets the object with the specified key.

Parameters:

ParameterTypeDescription
keystringThe key that identifies value.
valueobjectThe object with the specified key.

Method: set_source(source)

 set_source(source) 

Sets the source.

Parameters:

ParameterTypeDescription
sourcestringThe source.

Method: set_state(state)

 set_state(state) 

Sets the state.

Parameters:

ParameterTypeDescription
statestringThe state.

Method: set_supplemental_categories(supplemental_categories)

 set_supplemental_categories(supplemental_categories) 

Sets supplemental categories.

Parameters:

ParameterTypeDescription
supplemental_categoriesstringThe supplemental categories.

Method: set_transmission_reference(transmission_reference)

 set_transmission_reference(transmission_reference) 

Sets the transmission reference.

Parameters:

ParameterTypeDescription
transmission_referencestringThe transmission reference.

Method: set_urgency(urgency)

 set_urgency(urgency) 

Sets the urgency.

Parameters:

ParameterTypeDescription
urgencyintThe urgency.

Method: set_value(key, value)

 set_value(key, value) 

Sets the value.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with added value.
valueIXmlValueThe value to add to.

Method: set_xmp_type_value(key, value)

 set_xmp_type_value(key, value) 

Sets the XMP type value.

Parameters:

ParameterTypeDescription
keystringThe string representation of key that is identified with set value.
valueXmpTypeBaseThe value to set to.