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

#include <IArticleChildList.h>

Inheritance diagram for IArticleChildList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IARTICLECHILDLIST }
 

Public Member Functions

virtual int32 CountChildren () const =0
 
virtual void AddChild (UID childUID, int32 pos=-1)=0
 
virtual void RemoveChild (UID childUID)=0
 
virtual void RemoveNthChild (int32 pos)=0
 
virtual void RemoveAllChildren ()=0
 
virtual UID GetNthChildUID (int32 pos) const =0
 
virtual int32 GetChildPosition (UID childUID) 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

Group children can be reordered inside an Article independent of their Layout hierarchy. This Interface provides access to this reordering.

Member Function Documentation

virtual void IArticleChildList::AddChild (UID childUID,
int32 pos = -1 
)
pure virtual

Add a child at the specified position in the Group.

Parameters
childUIDIN the UID of the child that needs to be added.
posIN 0 based position at which to add the child. Specify -1 to add to the end.
virtual int32 IArticleChildList::CountChildren () const
pure virtual

Get the number of direct children of the Group.

virtual int32 IArticleChildList::GetChildPosition (UID childUID) const
pure virtual

Get the position of the child in the Group.

Parameters
childUIDIN the UID of the child in the Group.
Returns
the position of the child.
virtual UID IArticleChildList::GetNthChildUID (int32 pos) const
pure virtual

Get the Nth child UID from the Group.

Parameters
posIN the 0 based index of the child in the Group.
Returns
the UID of the child.
virtual void IArticleChildList::RemoveAllChildren ()
pure virtual

Remove all children from the Group.

virtual void IArticleChildList::RemoveChild (UID childUID)
pure virtual

Remove a child from the Group.

Parameters
childUIDIN the UID of the child that needs to be removed.
virtual void IArticleChildList::RemoveNthChild (int32 pos)
pure virtual

Remove a child from the Group.

Parameters
posIN the position of the child in the Group.