InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnpPrintDocument Class Reference

Public Member Functions

ErrorCode DoPrintDocument (IDocument *document, IPrintCmdData::PrintUIOptions printUIOptions, const UIDRef &printStyle, const int32 whichPages, const PMString &pageRangeString)
 
ErrorCode SetLayerPrintability (IDocumentLayer *docLayer, bool16 printable)
 
ErrorCode DoPrintBook (IBook *book, IBookOutputActionCmdData::OutputUIOptions printUIOptions, const int32 documentToPrint=-1)
 
K2Vector< PMStringGetBookContentNames (IBook *book)
 
UIDList SortUIDList (const UIDList &uidlist)
 

Detailed Description

  • Prints a document using the print command.

,

Author
Ken Sadahiro

Member Function Documentation

ErrorCode SnpPrintDocument::DoPrintBook (IBookbook,
IBookOutputActionCmdData::OutputUIOptions printUIOptions,
const int32 documentToPrint = -1 
)

Prints a book.

Parameters
bookIN The book to print.
printUIOptionsIN The UI options.
documentToPrintIN The index of the book content (document) to print. -1 means print all book contents.
Returns
kSuccess if success. If the configuration is invalid, a specific error code is returned.
ErrorCode SnpPrintDocument::DoPrintDocument (IDocumentdocument,
IPrintCmdData::PrintUIOptions printUIOptions,
const UIDRefprintStyle,
const int32 whichPages,
const PMStringpageRangeString 
)

Prints a document.

Parameters
documentIN The document to print.
printUIOptionsIN The UI options during printing.
printStyleIN The print style to use.
whichPagesIN Which pages to print. Either IPrintData::kAllPages or IPrintData::kPageRange.
pageRangeStringIN The string that denotes the range of pages to print.
See Also
IPageList::PageRangeStringToUIDList
IPrintData::kAllPages
IPrintData::kPageRange
kPrintSavePrintDataCmdBoss
kPrintActionCmdBoss
Returns
kSuccess on success, other ErrorCode otherwise.
K2Vector< PMString > SnpPrintDocument::GetBookContentNames (IBookbook)

Get the names of the book contents.

Parameters
bookIN The book to examine.
Returns
A list of names of book contents.
ErrorCode SnpPrintDocument::SetLayerPrintability (IDocumentLayerdocLayer,
bool16 printable 
)

Set the printability of a document layer

Parameters
docLayerIN The document layer to be set printable or not.
printableIN The boolean represents the printability.
Returns
kSuccess on success, other ErrorCode otherwise.
UIDList SnpPrintDocument::SortUIDList (const UIDListuidlist)

Sort a UIDList by UIDs contained.

Parameters
uidlistIN The UIDList to be sorted.
Returns
A new UIDList sorted by UIDs.