InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IExportOptionsUtils Class Referenceabstract

#include <IExportOptionsUtils.h>

Inheritance diagram for IExportOptionsUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IEXPORTOPTIONSUTILS }
 

Public Member Functions

virtual ErrorCode GetAlternateText (const UIDRef &item, PMString &altText)=0
 
virtual ErrorCode GetActualText (const UIDRef &item, PMString &actualText)=0
 
virtual ErrorCode GetMetadataValue (const UIDRef &item, const PMString &nsPrefix, const PMString &propertyPath, PMString &value)=0
 
virtual ErrorCode GetStructureAttribute (const UIDRef &item, bool16 alt, PMString &value)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Utils for Object export options.

Member Function Documentation

virtual ErrorCode IExportOptionsUtils::GetActualText (const UIDRefitem,
PMStringactualText 
)
pure virtual

This method computes the actual text for an object based on its export options preferences.

Parameters
itemIN the object to get the actual text for
actualTextOUT the actual text
Returns
ErrorCode: return error code on the basis of whether actual text exists or not
virtual ErrorCode IExportOptionsUtils::GetAlternateText (const UIDRefitem,
PMStringaltText 
)
pure virtual

This method computes the alternate text for an object based on its export options preferences.

Parameters
itemIN the object to get the alternate text for
altTextOUT the alternate text
Returns
ErrorCode: return error code on the basis of whether alt text exists or not
virtual ErrorCode IExportOptionsUtils::GetMetadataValue (const UIDRefitem,
const PMStringnsPrefix,
const PMStringpropertyPath,
PMStringvalue 
)
pure virtual

This method computes the metadata property value for an object given its xmp schema namespace prefix and path.

Parameters
itemIN the object to get the metadata property value for
nsPrefixIN metadata property xmp schema namespace prefix
propertyPathIN metadata property path
valueOUT the value of the metadata property
Returns
ErrorCode: return error code on the basis of whether metadata value exists or not
virtual ErrorCode IExportOptionsUtils::GetStructureAttribute (const UIDRefitem,
bool16 alt,
PMStringvalue 
)
pure virtual

This method computes the alternate/actual text for an object from the XML structure.

Parameters
itemIN the object to get the alternate/actual text for
altIN bool value to specify whether to get alternate or actual text
valueOUT the value from the structure
Returns
ErrorCode: return error code on the basis of whether structure text exists or not