InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDocIterationResult Class Referenceabstract
Inheritance diagram for IDocIterationResult:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDOCITERATIONRESULT }
 

Public Member Functions

virtual void SetGradientUsed (bool16 fGradient)=0
 
virtual void SetTransparentPages (K2Vector< int32 > &vecPages)=0
 
virtual void InkResourceInsert (int32 nPage, IInkResourceData *pResourceData)=0
 
virtual void AppendFontInfo (const Font_Info *pFont)=0
 
virtual void AppendMissingFontName (const PMString &fontName)=0
 
virtual void SetPagesWithSVGFonts (K2Vector< int32 > &vecPages)=0
 
virtual void SetImageCount (K2Vector< int32 > &vecCountByPage)=0
 
virtual void TZPathsInsert (int32 nPage, K2Vector< TrapZoneInfo * > &vecTrapList)=0
 
virtual void AppendGraphicSuppliedFontName (const PMString &fontName)=0
 
virtual int32 InkRsrcLength (void)=0
 
virtual IInkResourceDataGetNthInkRsrcData (int32 index) const =0
 
virtual int32 GetImagesUsed (int32 nPage) const =0
 
virtual int32 NumberOfPagesWithTransparency () const =0
 
virtual bool16 GetTransparencyUsed (const int32 whichPage) const =0
 
virtual int32 NumFontInfo () const =0
 
virtual Font_InfoGetNthFontInfo (int32 n) const =0
 
virtual int32 NumGraphicSuppliedFonts () const =0
 
virtual void GetNthGraphicSuppliedFontName (int32 n, PMString &fontName) const =0
 
virtual int32 NumMissingFonts () const =0
 
virtual void GetNthMissingFontName (const int32 n, PMString &fontName) const =0
 
virtual int32 TZPathsLength (void)=0
 
virtual K2Vector< TrapZoneInfo * > GetNthTZPathsList (int32 index) const =0
 
virtual void SetGradientMeshUsed (bool16 fGradientMesh)=0
 
virtual void AppendLinks (const UIDList &links)=0
 
virtual const UIDListGetLinks () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual void IDocIterationResult::AppendGraphicSuppliedFontName (const PMStringfontName)
pure virtual

Sometimes we care about the fonts that are supplied by the graphics within the document. For example, when placing a page from an imported INDD document, we may want to obtain a list of all the fonts in the document, including those within any vector graphics within said document. These fonts can then be stored in the IFontNames interface for the placed object.

Parameters
fontName[IN] the name of the graphic font.
virtual void IDocIterationResult::AppendLinks (const UIDListlinks)
pure virtual

Append a list of page items with 1 or more data links if SetCollectLinks(true) has been called.

Parameters
links[IN]: A list of page items with links to append to the list encountered so far.
virtual void IDocIterationResult::AppendMissingFontName (const PMStringfontName)
pure virtual

Add the name of a missing font.

Parameters
fontName[IN],:Name of the missing font.
virtual const UIDList& IDocIterationResult::GetLinks () const
pure virtual

Get the list of page items with links used in this print job. Note that you will need to query for the IDataLinkReference and/or IDataLinkListReference on each element in the list to obtain the actual links.

Returns
UIDList of links.
virtual void IDocIterationResult::GetNthGraphicSuppliedFontName (int32 n,
PMStringfontName 
) const
pure virtual

Sometimes we care about the fonts that are supplied by the graphics within the document. For example, when placing a page from an imported INDD document, we may want to obtain a list of all the fonts in the document, including those within any vector graphics within said document. These fonts can then be stored in the IFontNames interface for the placed object.

Parameters
n[IN]: zero-based index of font to get
fontName[OUT]: on return, will hold the name of the Nth graphic font.
virtual void IDocIterationResult::GetNthMissingFontName (const int32 n,
PMStringfontName 
) const
pure virtual

Get the name of the Nth missing font.

Parameters
n[IN]: zero-based index of font to get
fontName[OUT]: on return, will hold the name of the Nth missing font.
virtual int32 IDocIterationResult::NumGraphicSuppliedFonts () const
pure virtual

Sometimes we care about the fonts that are supplied by the graphics within the document. For example, when placing a page from an imported INDD document, we may want to obtain a list of all the fonts in the document, including those within any vector graphics within said document. These fonts can then be stored in the IFontNames interface for the placed object.

Returns
number of fonts supplied by graphics.
virtual int32 IDocIterationResult::NumMissingFonts () const
pure virtual

Get the number of missing fonts. These fonts are NOT included in the NumFontInfo() count.

Returns
number of missing fonts.