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

#include <IPropertyMgr.h>

Inheritance diagram for IPropertyMgr:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPROPERTYMGR }
 

Public Member Functions

virtual UID NewProperty (const PMString &name, ClassID type)=0
 
virtual bool16 DeleteProperty (UID propertyUID)=0
 
virtual int32 GetPropertyCount () const =0
 
virtual UID GetNthProperty (int32 n) const =0
 
virtual UID FindProperty (const PMString &name) 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

Class to manage descriptive properties (name, description, timestamp, etc.). Used by the library catalog to keep track of asset properties.

See Also
IProperty
IPropertyTable

Member Function Documentation

virtual bool16 IPropertyMgr::DeleteProperty (UID propertyUID)
pure virtual

Delete a property.

Parameters
propertyUIDIN the property to delete
Returns
kTrue for success; kFalse for failure
virtual UID IPropertyMgr::FindProperty (const PMStringname) const
pure virtual

Find a property by its name

Parameters
nameIN the name to search for
Returns
the UID of the property found (or kInvalidUID for not found)
virtual UID IPropertyMgr::GetNthProperty (int32 n) const
pure virtual

Get a property.

Parameters
nIN the zero-based index of the property to get
Returns
the UID of the property
virtual int32 IPropertyMgr::GetPropertyCount () const
pure virtual

Get the number of properties stored by the property manager.

Returns
the number of properties.
virtual UID IPropertyMgr::NewProperty (const PMStringname,
ClassID type 
)
pure virtual

Add a property.

Parameters
nameIN the name of the property (e.g., "Name," "Description," etc.)
typeIN the ClassID of the property type (e.g., kStringPropTabBoss)
Returns
the UID of the new property