InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
kSpreadBoss Class Reference

#include <SynthObjModel.h>

Inheritance diagram for kSpreadBoss:
kPageItemBosskMasterPagesBoss

Public Member Functions

IGeometry IID_IGEOMETRY
 
IPageTransitionInfo IID_IPAGETRANSITIONINFO
 
IPMUnknown IID_IHIDESPREADBOOLDATA
 
IPMUnknown IID_ITEXTWRAPTARGETMANAGER
 
IHierarchy IID_IHIERARCHY
 
IPMUnknown IID_IISLANDSPREAD
 
IPMUnknown IID_IHIDDENITEMS
 
IDOMElement IID_IDOMELEMENT
 
IScrapItem IID_ISCRAPITEM
 
IScript IID_ISCRIPT
 
IIDMLComponentName IID_IIDMLCOMPONENTNAME
 
IPMUnknown IID_ISNAPTO
 
IPMUnknown IID_ISPREADMSPREADTEXTWRAPMANAGER
 
IPMUnknown IID_ILOCKEDITEMS
 
IVisitorHelper IID_IVISITORHELPER
 
IFlattenerSettings IID_IXPFLATTENERSETTINGS
 
IPMUnknown IID_IBINDINGLOCATION
 
IMasterOverrideList IID_IMASTEROVERRIDELIST
 
IPMUnknown IID_IITEMCONTEXT
 
IPMUnknown IID_ISMARTGUIDES
 
IShape IID_ISHAPE
 
IPMUnknown IID_IDELETEINPROGRESS
 
IMasterElementsDrawSetting IID_IDRAWMASTERELEMENTS
 
IPMUnknown IID_IFRAMEBASELINEGRIDCLIPITEMLIST
 
IPMUnknown IID_ICOLUMNSCLIPITEMLIST
 
ISubject IID_ISUBJECT
 
ISpreadFieldOrder IID_ISPREADFIELDORDER
 
ISpreadMultiColumnFrames IID_ISPREADMULTICOLUMNFRAMES
 
IPMUnknown IID_ISPREADSTANDOFFS
 
ISpread IID_ISPREAD
 
IPMUnknown IID_IBASELINEGRIDCLIPITEMLIST
 
- Public Member Functions inherited from kPageItemBoss
ISwatchReferenceData IID_ISWATCHREFERENCEDATA
 
IAdaptiveTransform IID_IADAPTIVETRANSFORM
 
IStandOff IID_ISTANDOFF
 
IPMPersist IID_IPMPERSIST
 
ISubject IID_ISUBJECT
 
IAdornmentIterator IID_IPAGEITEMADORNMENTLIST
 
IHierarchy IID_IHIERARCHY
 
IPMUnknown IID_ISTANDOFFPARCELUSEDLIST
 
IPageItemCache IID_IPAGEITEMCACHE
 
IBlackBoxData IID_IBLACKBOXDATA
 
IStandOffData IID_ISTANDOFFDATA
 
ITextInset IID_ITEXTINSET
 
IPolygonConverter IID_IPOLYGONCONVERTER
 
ITransform IID_ITRANSFORM
 
IPMUnknown IID_ISHAPEGRAFIXCACHE
 

Detailed Description

 Represents a spread, the primary container for layout data in a document. A spread contains a set of pages (kPageBoss) on which 

the page items that represent pictures, text and other content are arranged. The signature interface for a spread is ISpread, it provides access to the content which is arranged in a hierarchy (IHierarchy) under the spread.

See Also
kDocBoss, ISpreadList lists the spreads (kSpreadBoss) in a document
kNewSpreadCmdBoss, kDeleteSpreadCmdBoss
kDocumentLayerBoss, kSpreadLayerBoss the classes that represent a document's layers
kMasterPagesBoss the class that represents a master spread
kPageBoss

Member Function Documentation

IPMUnknown kSpreadBoss::IID_IBASELINEGRIDCLIPITEMLIST

Undocumented.

  • Implementation: kPersistUIDListDataImpl
  • Available in:
  • Class from:
IPMUnknown kSpreadBoss::IID_IBINDINGLOCATION
     IIntData

See Also
ISpread::BindingLocation, kSetBindingLocationCmdBoss
    <ul>

    <li>Implementation: kPersistIntDataImpl</li>

    <li>Available in: </li>

    <li>Class from:</li>

    </ul>
IPMUnknown kSpreadBoss::IID_ICOLUMNSCLIPITEMLIST

Undocumented.

  • Implementation: kMyPersistUIDListDataImpl
  • Available in:
  • Class from:
IPMUnknown kSpreadBoss::IID_IDELETEINPROGRESS

Undocumented.

  • Implementation: kDeleteInProgressImpl
  • Available in:
  • Class from:
IDOMElement kSpreadBoss::IID_IDOMELEMENT

Undocumented.

  • Implementation: kPageItemScriptDOMElementImpl
  • Available in:
  • Class from:
  • Added-in interface
IMasterElementsDrawSetting kSpreadBoss::IID_IDRAWMASTERELEMENTS

Undocumented.

  • Implementation: kDrawMasterElementsImpl
  • Available in:
  • Class from:
  • Added-in interface
IPMUnknown kSpreadBoss::IID_IFRAMEBASELINEGRIDCLIPITEMLIST

Undocumented.

  • Implementation: kFrameBLGListPersistUIDListDataImpl
  • Available in:
  • Class from:
IGeometry kSpreadBoss::IID_IGEOMETRY

Undocumented.

  • Implementation: kSpreadGeometryImpl
  • Available in:
  • Class from:
IPMUnknown kSpreadBoss::IID_IHIDDENITEMS

Undocumented.

  • Implementation: kHiddenItemsImpl
  • Available in:
  • Class from:
  • Added-in interface
IPMUnknown kSpreadBoss::IID_IHIDESPREADBOOLDATA

Undocumented.

  • Implementation: kHideSpreadBoolDataImpl
  • Available in:
  • Class from:
IHierarchy kSpreadBoss::IID_IHIERARCHY
     IHierarchy stores the content of the spread as a tree of boss objects.

The children of a spread's hierarchy are spread layers (kSpreadLayerBoss), the grand children are pages (kPageBoss) and page items (kSplineItemBoss, etc.).

See Also
ISpread helps navigate to the pages and page items contained in the spread, it's much easier to use than IHierarchy.
    <ul>

    <li>Implementation: kCSpreadNodeImpl</li>

    <li>Available in: </li>

    <li>Class from:</li>

    </ul>
IIDMLComponentName kSpreadBoss::IID_IIDMLCOMPONENTNAME

Undocumented.

  • Implementation: kIDMLSpreadComponentNameImpl
  • Available in:
  • Class from:
  • Added-in interface
IPMUnknown kSpreadBoss::IID_IISLANDSPREAD
     IBoolData, kTrue = island-spread, kFalse = normal-spread. An island-spread

contains a set of pages that are kept together in the island-spread as you add or remove pages that precede it. The pages contained in a normal spread will change as you add or remove pages that precede it to respect the IPageSetupPrefs::GetPagesPerSpreadPref setting.

See Also
kSetIslandSpreadCmdBoss, IPageSetupPrefs
    <ul>

    <li>Implementation: kPersistBoolDataImpl</li>

    <li>Available in: </li>

    <li>Class from:</li>

    </ul>
IPMUnknown kSpreadBoss::IID_IITEMCONTEXT

Undocumented.

  • Implementation: kSpreadItemContextImpl
  • Available in:
  • Class from:
IPMUnknown kSpreadBoss::IID_ILOCKEDITEMS

Undocumented.

  • Implementation: kLockedItemsImpl
  • Available in:
  • Class from:
  • Added-in interface
IMasterOverrideList kSpreadBoss::IID_IMASTEROVERRIDELIST

Undocumented.

  • Implementation: kMasterOverrideListImpl
  • Available in:
  • Class from:
  • Added-in interface
IPageTransitionInfo kSpreadBoss::IID_IPAGETRANSITIONINFO

Undocumented.

  • Implementation: kPageTransitionInfoImpl
  • Available in:
  • Class from:
  • Added-in interface
IScrapItem kSpreadBoss::IID_ISCRAPITEM

Undocumented.

  • Implementation: kPageItemScrapImpl
  • Available in:
  • Class from:
IScript kSpreadBoss::IID_ISCRIPT

Undocumented.

  • Implementation: kSpreadScriptImpl
  • Available in:
  • Class from:
IShape kSpreadBoss::IID_ISHAPE

Undocumented.

  • Implementation: kSpreadShapeImpl
  • Available in:
  • Class from:
IPMUnknown kSpreadBoss::IID_ISMARTGUIDES

Undocumented.

  • Implementation: kSmartGuidesImpl
  • Available in:
  • Class from:
  • Added-in interface
IPMUnknown kSpreadBoss::IID_ISNAPTO

Undocumented.

  • Implementation: kCSnapToImpl
  • Available in:
  • Class from:
  • Added-in interface
ISpread kSpreadBoss::IID_ISPREAD
     ISpread is the signature interface for a spread and provides methods

that help access the content stored in its hierarchy (IHierarchy).

    <ul>

    <li>Implementation: kSpreadImpl</li>

    <li>Available in: </li>

    <li>Class from:</li>

    </ul>
ISpreadFieldOrder kSpreadBoss::IID_ISPREADFIELDORDER

Undocumented.

  • Implementation: kSpreadFieldOrderImpl
  • Available in:
  • Class from:
  • Added-in interface
IPMUnknown kSpreadBoss::IID_ISPREADMSPREADTEXTWRAPMANAGER

Undocumented.

  • Implementation: kSpreadMSpreadTextWrapManagerImpl
  • Available in:
  • Class from:
  • Added-in interface
ISpreadMultiColumnFrames kSpreadBoss::IID_ISPREADMULTICOLUMNFRAMES

Undocumented.

  • Implementation: kSpreadMultiColumnFramesImpl
  • Available in:
  • Class from:
  • Added-in interface
IPMUnknown kSpreadBoss::IID_ISPREADSTANDOFFS

Undocumented.

  • Implementation: kSpreadStandOffsImpl
  • Available in:
  • Class from:
  • Added-in interface
ISubject kSpreadBoss::IID_ISUBJECT

Undocumented.

  • Implementation: kSpreadSubjectImpl
  • Available in:
  • Class from:
IPMUnknown kSpreadBoss::IID_ITEXTWRAPTARGETMANAGER

Undocumented.

  • Implementation: kTextWrapTargetManagerImpl
  • Available in:
  • Class from:
  • Added-in interface
IVisitorHelper kSpreadBoss::IID_IVISITORHELPER

Undocumented.

  • Implementation: kSpreadVisitorHelperImpl
  • Available in:
  • Class from:
IFlattenerSettings kSpreadBoss::IID_IXPFLATTENERSETTINGS

Undocumented.

  • Implementation: kXPFlattenerSettingsPersistImpl
  • Available in:
  • Class from:
  • Added-in interface