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

#include <SynthObjModel.h>

Inheritance diagram for kNewPageCmdBoss:

Public Member Functions

IPMUnknown IID_ISETLAYOUTPOLICYCMDDATA
 
IPageCmdData IID_IPAGECMDDATA
 
IBoolData IID_IBOOLDATA
 
IApplyMasterCmdData IID_IAPPLYMASTERCMDDATA
 
ICommand IID_ICOMMAND
 
IPMUnknown IID_IREPAGINATEFLAG
 
IPMUnknown IID_IBINDINGSIDE
 

Detailed Description

 This command creates one or more pages (kPageBoss) in a spread (kSpreadBoss)

or master spread (kMasterPagesBoss). If the targeted spread cannot accommodate some of the new pages, this command creates the necessary spreads.

Postcondition
The new pages (kPageBoss) are added to the targeted spread on the IHierarchy interface of its pages layer (kSpreadLayerBoss). The index of the new page in IHierarchy is given by this command's IPageCmdData interface.
Item list input
None (IPageCmdData identifies the spread to be edited)
Item list output
References the pages (kPageBoss) created by the command
Observer notification 1
  • theChange: kNewPageCmdBoss
  • theSubject: kDocBoss
  • protocol: IID_ISPREADLIST if adding page(s) to a spread (kSpreadBoss), IID_IMASTERSPREADLIST if adding to master(kMasterPagesBoss)
  • changedBy: command instance
  • pre-notifies: no
Observer notification 2
  • theChange: kNewPageCmdBoss
  • theSubject: kDocBoss
  • protocol: IID_IHIERARCHY
  • changedBy: command instance
  • pre-notifies: no
Responder notification
  • ServiceID: kPageNumEvenOddnessChangeSignalResponderService
  • Signal data: IUIDData interface referencing the affected document (kDocBoss)
See Also
kPageBoss, ISpreadList, kSpreadBoss, IMasterSpreadList, kMasterPagesBoss, IPageSetupPrefs

Member Function Documentation

IApplyMasterCmdData kNewPageCmdBoss::IID_IAPPLYMASTERCMDDATA

IApplyMasterCmdData, identifies the master to be applied.

  • Implementation: kApplyMasterCmdDataImpl
  • Available in:
  • Class from:
IPMUnknown kNewPageCmdBoss::IID_IBINDINGSIDE
     IN IIntData, specifies the side of the binding line (default ISpread::kDefaultBindingSide).

See Also
ISpread::BindingSide for the permitted values
    <ul>

    <li>Implementation: kPersistIntDataImpl</li>

    <li>Available in: </li>

    <li>Class from:</li>

    </ul>
IBoolData kNewPageCmdBoss::IID_IBOOLDATA
     IN IBoolData, kFalse = don't shuffle, kTrue = shuffle (default kTrue).

See Also
kShufflePagesCmdBoss
    <ul>

    <li>Implementation: kBoolDataImpl</li>

    <li>Available in: </li>

    <li>Class from:</li>

    </ul>
ICommand kNewPageCmdBoss::IID_ICOMMAND

ICommand implementation.

  • Implementation: kNewPageCmdImpl
  • Available in:
  • Class from:
IPageCmdData kNewPageCmdBoss::IID_IPAGECMDDATA
     IN IPageCmdData, identifies the target spread, number of pages to insert, 

and the position of the new pages within the spread. The other parameters are taken from IPageSetupPrefs on the document workspace, if you leave them as default.

    <ul>

    <li>Implementation: kPageCmdDataImpl</li>

    <li>Available in: </li>

    <li>Class from:</li>

    </ul>
IPMUnknown kNewPageCmdBoss::IID_IREPAGINATEFLAG

IN IBoolData, kTrue = repaginate, kFalse= don't repaginate, only used for book (default kTrue).

  • Implementation: kRepaginateFlagImpl
  • Available in:
  • Class from:
IPMUnknown kNewPageCmdBoss::IID_ISETLAYOUTPOLICYCMDDATA
     IN Allows new pages to have a specified layout policy, defaults to kNoLayoutPolicy.

See Also
ILayoutObject::LayoutPolicy for the permitted values
    <ul>

    <li>Implementation: kSetLayoutPolicyCmdDataImpl</li>

    <li>Available in: </li>

    <li>Class from:</li>

    </ul>