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

#include <IExportTagValues.h>

Inheritance diagram for IExportTagValues:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IEXPORTTAGVALUES }
 

Public Member Functions

virtual ExportTagData GetTagData (const WideString &exportType) const =0
 
virtual void SetTagData (const WideString &exportType, const ExportTagData &tagData)=0
 
virtual size_t GetNumberOfExportTypes () const =0
 
virtual WideString GetNthExportType (size_t nthType) const =0
 
virtual bool16 GetBreakHTMLFileInEPUB () const =0
 
virtual void SetBreakHTMLFileInEPUB (bool16 breakFile)=0
 
virtual bool16 GetEmitCSSForStyle () const =0
 
virtual void SetEmitCSSForStyle (bool16 emitCSS)=0
 
virtual bool16 GetIncludeClassInHTML () const =0
 
virtual void SetIncludeClassInHTML (bool16 includeClass)=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

The IExportTagValues interface stores a persistent, list of tags and values. It is used to store the tags to use for exporting EPUB and PDF

Member Function Documentation

virtual bool16 IExportTagValues::GetBreakHTMLFileInEPUB () const
pure virtual

Get break html file in EPUB at style. Only meaningful for paragraph style.

Returns
bool16 kTrue if break HTML file at style. Value defaults to kFalse.
virtual bool16 IExportTagValues::GetEmitCSSForStyle () const
pure virtual

Get the status of 'emit CSS for this style'.

Returns
kTrue if CSS should be emitted for this style, kFalse otherwise. Default is kTrue.
virtual bool16 IExportTagValues::GetIncludeClassInHTML () const
pure virtual
Get the status of 'include class' for this style.

Returns
kTrue if class should be included for this style, kFalse otherwise. Default is kTrue.
virtual WideString IExportTagValues::GetNthExportType (size_t nthType) const
pure virtual

Get the nth export type.

Parameters
nthTypeindex to type of export
Returns
WideString export type. i.e. L"PDF", L"EPUB"
virtual size_t IExportTagValues::GetNumberOfExportTypes () const
pure virtual

Get the number of export types.

Returns
size_t number of export types
virtual ExportTagData IExportTagValues::GetTagData (const WideStringexportType) const
pure virtual

Get the tag data for export type.

Parameters
exportTypetype of export to get tag data for. i.e. L"PDF", L"EPUB"
Returns
ExportTagData tag data
virtual void IExportTagValues::SetBreakHTMLFileInEPUB (bool16 breakFile)
pure virtual

Set break html file in EPUB at style.

Parameters
breakFilekTrue to break HTML file at style.
virtual void IExportTagValues::SetEmitCSSForStyle (bool16 emitCSS)
pure virtual

Set 'emit CSS' for this style.

Parameters
emitCSSkTrue to emit CSS for this style, kFalse otherwise.
virtual void IExportTagValues::SetIncludeClassInHTML (bool16 includeClass)
pure virtual
Set 'include class' for this style.

Parameters
includeClasskTrue to include class for this style, kFalse otherwise.
virtual void IExportTagValues::SetTagData (const WideStringexportType,
const ExportTagDatatagData 
)
pure virtual

Set the tag data for export type. Setting to ExportTagData() will remove the entry.

Parameters
exportTypetype of export to get tag data for. i.e. L"PDF", L"EPUB"
tagDatatag data