IDocSavePrefs Class Reference

#include <IDocSavePrefs.h>

Inheritance diagram for IDocSavePrefs:

Public Types
enum	{ kDefaultIID = IID_IDOCSAVEPREFS }
enum	ThumbnailOptions {   kFirstPageJPEGThumbnail = 0, kFirst2PagesJPEGThumbnail, kFirst5PagesJPEGThumbnail, kFirst10PagesJPEGThumbnail,   kAllPagesJPEGThumbnail }
enum	PreviewSizeOptions { kSmall = 0, kMedium, kLarge, kExtraLarge }

Public Member Functions
virtual void	SetThumbnailOptions (ThumbnailOptions thumbnail)=0
virtual ThumbnailOptions	GetThumbnailOptions () const =0
virtual void	SetSaveThumbnailWithDocument (bool16 saveThumbnail)=0
virtual bool16	GetSaveThumbnailWithDocument () const =0
virtual void	SetPreviewSizeOptions (PreviewSizeOptions previewsize)=0
virtual PreviewSizeOptions	GetPreviewSizeOptions () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

IDocSavePrefs are document preferences which dictates whether or not a JPEG thumbnail

of the first one or more Pages will be created and added to the InDesign document at Save time. Creating a thumbnail or preview can be very expensive if the document is complex. Sometimes, a preview is not necessary because the document is being stored in a database (as is the case for some system integrators) and the preview will never be used. For these cases, a client may wish to disable the preview creation. Use the kSetDocSavePrefsCmdBoss to change the thumbnail an preview settings.

Member Enumeration Documentation

anonymous enum

Default IID enum

enum IDocSavePrefs::PreviewSizeOptions

The Preview size options

enum IDocSavePrefs::ThumbnailOptions

The thumbnail creation options

Member Function Documentation

virtual PreviewSizeOptions IDocSavePrefs::GetPreviewSizeOptions ( ) const

pure virtual

Get the current Preview size preference

Parameters

void

Returns

PreviewSizeOptions

virtual bool16 IDocSavePrefs::GetSaveThumbnailWithDocument ( ) const

pure virtual

Get the preference of whether or not to save previews with documents

Parameters

void

Returns

true if we're saving thumbnails

virtual ThumbnailOptions IDocSavePrefs::GetThumbnailOptions ( ) const

pure virtual

Get the current thumbnail preference

Parameters

void

Returns

ThumbnailOptions

virtual void IDocSavePrefs::SetPreviewSizeOptions ( PreviewSizeOptions  previewsize )

pure virtual

Set the Preview size preference

Parameters

previewsize

IN - the new setting

virtual void IDocSavePrefs::SetSaveThumbnailWithDocument ( bool16  saveThumbnail )

pure virtual

Set the preference of whether or not to save previews with documents

Parameters

saveThumbnail

IN - the new setting

virtual void IDocSavePrefs::SetThumbnailOptions ( ThumbnailOptions  thumbnail )

pure virtual

Set the thumbnail preference

Parameters

thumbnail

IN - the new setting