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

#include <ISnippetImportLocPrefCmdData.h>

Inheritance diagram for ISnippetImportLocationPrefCmdData:
IPMUnknown

Public Member Functions

virtual void Set (const UIDRef &doc, const bool16 bUseOriginalLocation)=0
 
virtual const UIDRefGetDocument () const =0
 
virtual const bool16 GetSnippetImportUsesOriginalLocation () const =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

A class to tell whether batch-place (or snippet) import/place operations should use the original (stored) location of the item('s) in the file for placement, or load the placegun to allow the user to place

Member Function Documentation

virtual const UIDRef& ISnippetImportLocationPrefCmdData::GetDocument () const
pure virtual

Get the document

Returns
the document UIDRef
virtual const bool16 ISnippetImportLocationPrefCmdData::GetSnippetImportUsesOriginalLocation () const
pure virtual

Get the original/placegun preference value

Returns
kTrue = use the original spread location(s) for placed item(s); kFalse = enable placegun
virtual void ISnippetImportLocationPrefCmdData::Set (const UIDRefdoc,
const bool16 bUseOriginalLocation 
)
pure virtual

Set the values

Parameters
docIN the document
inbUseOriginalLocation IN kTrue = use original; kFalse = allow placegun