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

#include <IXMLConvertElementToInlineCmdData.h>

Inheritance diagram for IXMLConvertElementToInlineCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXMLCONVERTELEMENTTOINLINECMDDATA }
 

Public Member Functions

virtual void Set (const XMLReference &xmlRef, const PMPoint &dimensions)=0
 
virtual void Set (const XMLReference &xmlRef, UID frameToCopy, bool16 retainExistingFrame)=0
 
virtual XMLReference GetXMLReference () const =0
 
virtual const PMPointGetDimensions () const =0
 
virtual UID GetFrameToCopy () const =0
 
virtual bool16 GetRetainExistingFrame () 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

Data interface Convert Element to Inline Cmd

Member Function Documentation

virtual const PMPoint& IXMLConvertElementToInlineCmdData::GetDimensions () const
pure virtual
Returns
the dimensions.
virtual UID IXMLConvertElementToInlineCmdData::GetFrameToCopy () const
pure virtual
Returns
the frame to copy.
virtual bool16 IXMLConvertElementToInlineCmdData::GetRetainExistingFrame () const
pure virtual
Returns
the Retain Existing Frame setting.
virtual XMLReference IXMLConvertElementToInlineCmdData::GetXMLReference () const
pure virtual
Returns
the xml reference.
virtual void IXMLConvertElementToInlineCmdData::Set (const XMLReferencexmlRef,
const PMPointdimensions 
)
pure virtual

Use this to create a rectangular inline with the specified dimensions

Parameters
xmlRefthe element to convert to an inline.
thePointdimensions of the new inline
virtual void IXMLConvertElementToInlineCmdData::Set (const XMLReferencexmlRef,
UID frameToCopy,
bool16 retainExistingFrame 
)
pure virtual

Use this to create a copy of the specified item as your inline. Dimensions will be the same as the copied element

Parameters
xmlRefthe element to convert to an inline.
frameToCopyUID of the frame you'd like to copy
frameToCopyUID of the frame you'd like to copy
retainExistingFrameif true and the element is already an inline, the existing frame will be used. if false, existing frame will be deleted and copied frame used