IPublishReference

This topic describes the properties and methods of the IPublishReference interface.

Properties

TargetStatus

Indicates whether the target of this reference is found or not.

The possible values are: Unchecked, NotFound, Found or Unknown

PublishItemMode

Indicates whether the target of this reference is found as a regular item or as an extra compare item.

The possible values are: PrimaryItem or ExtraCompareItem. In most situations the value will be PrimaryItem, only in case the reference is to an image of which the version was changed between 2 compared publication outputs (so in the compare folder you will have 2 files with the same GUID and resolution(e.g. GUID-X.v2-low.jpg and GUID-X.v1-low.jpg)) the reference to the latter will be marked as ExtraCompareItem.

Methods

Get

Returns the value for the given property name
propertyName
String with the name of the property

Set

Sets the value for the given property.
propertyName
String with the name of the property
value
String with the value for the property

TryGet

Tries to get the value for the given property name.
propertyName
String with the name of the property
value
String with the value matching the specified name

Contains

Checks whether the given property name exists or not
propertyName
String with the name of the property

Remove

Removes the value for the given property name
propertyName
String with the name of the property

GetPropertyNames

Returns a list with all the property names available on this object