InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDocMarginsCmdData Class Referenceabstract
Inheritance diagram for IDocMarginsCmdData:
IPMUnknown

Public Member Functions

virtual void Set (const PMReal &insideLeft, const PMReal &top, const PMReal &outsideRight, const PMReal &bottom)=0
 
virtual void GetMargins (PMReal *insideLeft, PMReal *top, PMReal *outsideRight, PMReal *bottom) const =0
 
virtual void SetDocument (const UIDRef &doc)=0
 
virtual const UIDRefGetDocument () const =0
 
virtual void SetUseUniformMargins (bool16 bUniform)=0
 
virtual bool16 GetUseUniformMargins ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual const UIDRef& IDocMarginsCmdData::GetDocument () const
pure virtual

Get the document for which preferences are to be operated on.

Returns
document reference.
virtual void IDocMarginsCmdData::GetMargins (PMRealinsideLeft,
PMRealtop,
PMRealoutsideRight,
PMRealbottom 
) const
pure virtual

Return the margin values in the data interface.

Parameters
insideLeftPMReal* OUT returns the inside or left margin.
topPMReal* OUT returns the top margin.
outsideRightPMReal* OUT returns the outside or right margin.
bottomPMReal* OUT returns the bottom margin.
virtual bool16 IDocMarginsCmdData::GetUseUniformMargins ()
pure virtual

Returns whether the doc margin's left, right, top, bottom will be same or not.

Returns
flag that represents whether the margins change uniformly or not.
virtual void IDocMarginsCmdData::Set (const PMRealinsideLeft,
const PMRealtop,
const PMRealoutsideRight,
const PMRealbottom 
)
pure virtual

Set the margins for document and pages in the kSetDocMarginCmdBoss item list.

Parameters
insideLeftPMReal& IN refers to inside (for facing pages case) or left margin.
topPMReal& IN refers to top margin.
outsideRightPMReal& IN refers to outside (for facing pages case) or right margin.
bottomPMReal& IN refers to bottom margin.
virtual void IDocMarginsCmdData::SetDocument (const UIDRefdoc)
pure virtual

Set the document for which preferences are to be operated on.

Parameters
docUIDRef IN returns the inside or left margin.
virtual void IDocMarginsCmdData::SetUseUniformMargins (bool16 bUniform)
pure virtual

Sets whether the doc margin's left, right, top, bottom will be same or not.

Parameters
bUniformbool16 refers to the flag to change the margins uniformly.