CSWhiteboard
in package
Class CSWhiteboard
Tags
Table of Contents
- applyPlanningToLayout() : array<string|int, mixed>
- Applies all planned changes of a Whiteboard Editor to the layout document
- createMergeList() : CSGuiWhiteboardMergedItemList
- getGuiPlugins() : array<string|int, CSWhiteboardGuiPlugin>
- Returns all available whiteboard gui plugins.
Methods
applyPlanningToLayout()
Applies all planned changes of a Whiteboard Editor to the layout document
public
static applyPlanningToLayout(int $MamFileID[, array<string|int, int> $aPlannedIDs = null ][, array<string|int, int> $aPlacedIDs = null ]) : array<string|int, mixed>
Parameters
- $MamFileID : int
-
the ID of the InDesign File
- $aPlannedIDs : array<string|int, int> = null
-
optional array with reference IDs of planned sketches to limit the changes to
- $aPlacedIDs : array<string|int, int> = null
-
optional array with reference IDs of placed sketches to limit the changes to
Tags
Return values
array<string|int, mixed> —createMergeList()
public
static createMergeList(CSMamFile $document) : CSGuiWhiteboardMergedItemList
Parameters
- $document : CSMamFile
Tags
Return values
CSGuiWhiteboardMergedItemList —getGuiPlugins()
Returns all available whiteboard gui plugins.
public
static getGuiPlugins(CSMamFile $oMamFile) : array<string|int, CSWhiteboardGuiPlugin>
Parameters
- $oMamFile : CSMamFile
-
The mam file for which the plugins should be loaded.
Tags
Return values
array<string|int, CSWhiteboardGuiPlugin> —List of available whiteboard gui plugin objects