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

#include <IPageMarginsCmdData.h>

Inheritance diagram for IPageMarginsCmdData:
IPMUnknown

Public Member Functions

virtual void Set (const PMReal &insideLeft, const PMReal &top, const PMReal &outsideRight, const PMReal &bottom, const bool16 valid)=0
 
virtual void GetMargins (PMReal *insideLeft, PMReal *top, PMReal *outsideRight, PMReal *bottom) const =0
 
virtual const bool16 GetValid () 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

Command data interface associated with commands to manipulate page margins.

See Also
IMargins
kSetPageMarginsCmdBoss

Member Function Documentation

virtual void IPageMarginsCmdData::GetMargins (PMRealinsideLeft,
PMRealtop,
PMRealoutsideRight,
PMRealbottom 
) const
pure virtual

Return the margin values in the data interface.

Parameters
insideLeftPMReal* OUT returns the inside (for facing pages case) or left margin.
topPMReal* OUT returns the top margin.
outsideRightPMReal* OUT returns the outside (for facing pages case) or right margin.
bottomPMReal* OUT returnbs the bottom margin.
virtual const bool16 IPageMarginsCmdData::GetValid () const
pure virtual

Return the valid value in the data interface.

Returns
bool16
virtual void IPageMarginsCmdData::Set (const PMRealinsideLeft,
const PMRealtop,
const PMRealoutsideRight,
const PMRealbottom,
const bool16 valid 
)
pure virtual

Set the margins for pages in the kSetPageMarginCmdBoss item list.

Parameters
insideLeftPMReal& refers to inside (for facing pages case) or left margin.
topPMReal& refers to top margin.
outsideRightPMReal& refers to outside (for facing pages case) or right margin.
bottomPMReal& refers to bottom margin.
validbool16 The new margin valid valid. "Valid" refers to whether the page margins are in use (kTrue), or the page should get its margin values from its applied master (kFalse).