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

#include <IPreflightProfile.h>

Inheritance diagram for IPreflightProfile:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPREFLIGHTPROFILE }
 

Public Member Functions

virtual PMString GetName () const =0
 
virtual void SetName (const PMString &newName)=0
 
virtual PMString GetDescription () const =0
 
virtual void SetDescription (const PMString &newDesc)=0
 
virtual void CopyFrom (const IPreflightProfile *iSrc)=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

This interface sits on a preflight profile boss and provides basic information about the profile. The list of rules is maintained by the IPreflightProfileRules interface. The preferences (ie when to apply the profile) is maintained by the IPreflightProfilePrefs interface.

See Also
IPreflightProfileRules
IPreflightProfilePrefs

Member Function Documentation

virtual void IPreflightProfile::CopyFrom (const IPreflightProfileiSrc)
pure virtual

Copy all of the above settings from another instance.

Parameters
iSrcIN The source data to copy.
virtual PMString IPreflightProfile::GetDescription () const
pure virtual

Get the profile's description – a longer user defined field describing the profile.

Returns
The profile description.
virtual PMString IPreflightProfile::GetName () const
pure virtual

Get the profile's name (the name that is displayed in the UI).

Returns
The profile name.
virtual void IPreflightProfile::SetDescription (const PMStringnewDesc)
pure virtual

Set the profile's description – a longer user defined field describing the profile.

Parameters
newDescIN The new profile description.
virtual void IPreflightProfile::SetName (const PMStringnewName)
pure virtual

Set the profile's name (the name that is displayed in the UI).

Parameters
newNameIN The new profile name.