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

Public Member Functions

 AnnotationCollection ()
 
virtual void GetAnnotationCollectionID (AnnotationCollectionID &annotCollectionid) const
 
virtual void SetListOfPagesInCollection (const std::vector< std::shared_ptr< AnnotationPage >> &pages)
 
virtual void GetListOfPagesInCollection (std::vector< std::shared_ptr< AnnotationPage >> &pages) const
 
virtual void AppendListOfPagesToCollection (const std::vector< std::shared_ptr< AnnotationPage >> &pages)
 

Constructor & Destructor Documentation

AnnotationCollection::AnnotationCollection ()

Sets the information of a particular collection of annotations related to a single document.

Member Function Documentation

virtual void AnnotationCollection::AppendListOfPagesToCollection (const std::vector< std::shared_ptr< AnnotationPage >> & pages)
virtual
Appends a List of Pages to a particular collection of annotations related to a single document.

Parameters
pagesIN is the collection's list of pages with relevant annotations.
virtual void AnnotationCollection::GetAnnotationCollectionID (AnnotationCollectionID & annotCollectionid) const
virtual

Sets the DocumentUID of a particular collection of annotations related to a single document.

Parameters
docIDIN is the collection's associated document ID. Gets the DocumentUID of a particular collection of annotations related to a single document.
docIDOUT is the collection's associated document ID.Gets the Collection of a particular collection of annotations related to a single document.
uidOUT is the collection's unique ID
virtual void AnnotationCollection::GetListOfPagesInCollection (std::vector< std::shared_ptr< AnnotationPage >> & pages) const
virtual

Gets the List of Pages of a particular collection of annotations related to a single document.

Parameters
pagesOUT is the collection's list of pages with relevant annotations.
virtual void AnnotationCollection::SetListOfPagesInCollection (const std::vector< std::shared_ptr< AnnotationPage >> & pages)
virtual

Sets the Number of Annotations of a particular collection of annotations related to a single document.

Parameters
totalNumberOfAnnotationsPresentIN is the total number of annotations present in the collection.Gets the Number of Annotations of a particular collection of annotations related to a single document.
totalNumberOfAnnotationsPresentOUT is the total number of annotations present in the collection.Sets the List of Pages of a particular collection of annotations related to a single document.
pagesIN is the collection's list of pages with relevant annotations.