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

Public Member Functions

 SnpSelectShape ()
 
virtual ~SnpSelectShape ()
 
ErrorCode ReportObjectType (PMPageItemType pathType)
 
void FindSimilarObjectTypes (PMPageItemType pathType, UIDList &uids, ISpread *spread)
 
void Select (ISelectionManager *selectionManager, const UIDList &itemList)
 

Detailed Description

  • how to iterate a spread, examining page items
  • how to identify page item types
  • how to extend the current selection
  • how to refresh the current view.

This snippet identifies the PMPageItemType of the current page item selection, then searches the spread containing the selection for all other page items of the same type.

Constructor & Destructor Documentation

SnpSelectShape::SnpSelectShape ()
inline

Constructor.

virtual SnpSelectShape::~SnpSelectShape ()
inlinevirtual

Destructor.

Member Function Documentation

void SnpSelectShape::FindSimilarObjectTypes (PMPageItemType pathType,
UIDListuids,
ISpreadspread 
)

Find all page items of the same PMPageItemType.

Parameters
pathType(in) Specifies enum of shape types.
uids(in/out) Specifies list to hold similar page items.
spread(in) Specifies pointer to spread containing selection.
See Also
IPathUtils
ErrorCode SnpSelectShape::ReportObjectType (PMPageItemType pathType)

Report selected object shape type to sniplog.

Parameters
pathType(in) Specifies enum of shape types.
Returns
kSuccess on identify, kFailure otherwise.
void SnpSelectShape::Select (ISelectionManagerselectionManager,
const UIDListitemList 
)

Select the given page items.

Parameters
selectionManagerin which items are to be selected.
itemListUIDs of items to be selected.