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

#include <IArticleMemberList.h>

Inheritance diagram for IArticleMemberList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IARTICLEMEMBERLIST }
 

Public Member Functions

virtual int32 CountMembers () const =0
 
virtual void AddMember (UID memberUID, int32 pos=-1)=0
 
virtual void RemoveMember (UID memberUID)=0
 
virtual void RemoveNthMember (int32 pos)=0
 
virtual void RemoveAllMembers ()=0
 
virtual UID GetNthMemberUID (int32 pos) const =0
 
virtual int32 GetMemberPosition (UID memberUID) 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

Provides access to the members of an Article.

Member Function Documentation

virtual void IArticleMemberList::AddMember (UID memberUID,
int32 pos = -1 
)
pure virtual

Add a member at the specified position in the Article.

Parameters
memberUIDIN the UID of the member that needs to be added.
posIN 0 based position at which to add the member. Specify -1 to add to the end.
virtual int32 IArticleMemberList::CountMembers () const
pure virtual

Get the number of members in the Article.

Returns
the number of members in the Article.
virtual int32 IArticleMemberList::GetMemberPosition (UID memberUID) const
pure virtual

Get the position of the member in the Article.

Parameters
memberUIDIN the UID of the member in the Article.
Returns
the position of the member.
virtual UID IArticleMemberList::GetNthMemberUID (int32 pos) const
pure virtual

Get the Nth member UID from the Article.

Parameters
posIN the 0 based index of the member in the Article.
Returns
the UID of the member.
virtual void IArticleMemberList::RemoveAllMembers ()
pure virtual

Remove all members from the Article.

virtual void IArticleMemberList::RemoveMember (UID memberUID)
pure virtual

Remove a member from the Article

Parameters
memberUIDIN the UID of the member that needs to be removed.
virtual void IArticleMemberList::RemoveNthMember (int32 pos)
pure virtual

Remove a member from the Article.

Parameters
posIN the position of the member in the Article.