IAssignedDocument Class Reference

#include <IAssignedDocument.h>

Inheritance diagram for IAssignedDocument:

Public Types
enum	{ kDefaultIID = IID_IASSIGNEDDOCUMENT }

Public Member Functions
virtual void	AddAssignment (IAssignment *assignment)=0
virtual void	RemoveAssignment (IAssignment *assignment, bool16 deleteFile)=0
virtual void	MoveAssignment (IAssignment *assignment, IAssignment *beforeAssignment)=0
virtual UIDList	GetAssignments () const =0
virtual ErrorCode	MoveAssignmentCmd (IAssignment *assignment, IAssignment *beforeAssignment)=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

This class is used to manage the list of assignments in an InDesign document. This object is added into kDocBoss, so you can get it from the RootUID of the IDataBase.

See Also

IAssignment

Member Function Documentation

virtual void IAssignedDocument::AddAssignment ( IAssignment *  assignment )

pure virtual

Add an assignment to the document. Must be called from a command.

Parameters

assignment

The assignment to add to the document.

virtual UIDList IAssignedDocument::GetAssignments ( ) const

pure virtual

Returns the list of assignments in this document. Can supply a const_iterator.

Returns

A constant reference to the assignment list.

virtual void IAssignedDocument::MoveAssignment ( IAssignment *  assignment, IAssignment *  beforeAssignment  )

pure virtual

Moves an assignment before another assignment.

Parameters

assignment	- The assignment to move.
beforeAssignment	- The assignment to move in front of. Pass nil to move to the end of the list.

virtual ErrorCode IAssignedDocument::MoveAssignmentCmd ( IAssignment *  assignment, IAssignment *  beforeAssignment  )

pure virtual

Moves an assignment before another assignment.

Parameters

assignment	- The assignment to move.
beforeAssignment	- The assignment to move in front of. Pass nil to move to the end of the list.

virtual void IAssignedDocument::RemoveAssignment ( IAssignment *  assignment, bool16  deleteFile  )

pure virtual

Remove an assignment from the document. Must be called from a command.

Parameters

assignment

The assignment to remove.