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

Public Member Functions

ErrorCode Inspect ()
 Inspects the contents of the content dropper. More...
 
ErrorCode LoadSelectionIntoDropper (const UIDList &items)
 Loads the selected items onto the content dropper's conveyor. More...
 
ErrorCode ExpandOrCollapseHead (const bool16 expand)
 Expand or collapse the collection at the head of the conveyor. More...
 
ErrorCode InspectDocumentContributions ()
 Examine the collections on the conveyor from each open document. More...
 
ErrorCode RotateContentDropper (const int32 byHowMany, const bool16 isForward)
 Rotate the items on the content dropper. More...
 

Detailed Description

How to work with the ContentDropper APIs.

See Also
IContentDropperFacade
IContentDropperAppData
IContentDropperDocData
CCollection

Member Function Documentation

ErrorCode SnpContentDropper::ExpandOrCollapseHead (const bool16 expand)

Expand or collapse the collection at the head of the conveyor.

Parameters
expandkTrue to expand the head item, kFalse to collapse it.
Return values
kSuccessif successful.
kFailureif the head of the conveyor cannot be expanded.
ErrorCode SnpContentDropper::Inspect ()

Inspects the contents of the content dropper.

Iterates over the collections on the content dropper, tracing information about the collections and their contents to the SnippetRunner log. Additionally reports information about the current item at the head of the content dropper.

Return values
kSuccesson success
kFailureotherwise
ErrorCode SnpContentDropper::InspectDocumentContributions ()

Examine the collections on the conveyor from each open document.

For each open document, inspect the collections added to the document by the given document.

Return values
kSuccess
ErrorCode SnpContentDropper::LoadSelectionIntoDropper (const UIDListitems)

Loads the selected items onto the content dropper's conveyor.

Parameters
[in]itemsThe items to load onto the conveyor
Returns
ErrorCode returned when loading the conveyor.
ErrorCode SnpContentDropper::RotateContentDropper (const int32 byHowMany,
const bool16 isForward 
)

Rotate the items on the content dropper.

Parameters
byHowManyHow many items do you want to rotate by?
isForwardkTrue to rotate forwards, kFalse otherwise
Return values
kSuccessif rotation is successful
kFailureotherwise