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

Public Member Functions

void Inspect (const K2Vector< XMLReference > &elements)
 
void Inspect (const UIDList &uidList)
 
void Inspect (const XMLReference &xmlRef)
 
void Inspect (const UIDRef &objectUIDRef)
 
void InspectText (const UIDRef &textModelUIDRef, const RangeData &textRange)
 
void InspectTable (const UIDRef &tableModelUIDRef, const GridArea &gridArea)
 
void InspectLayoutObject (const UIDRef &uidRef)
 
void InspectTextFrame (const UIDRef &uidRef)
 

Detailed Description

Code that inspects XML-related properties of objects.

Member Function Documentation

void SnpInspectSelectionXMLProperties::Inspect (const K2Vector< XMLReference > & elements)

Report on the XML-related properties of a list of XML elements.

Parameters
elementsspecifies elements (see IIDXMLElement)
void SnpInspectSelectionXMLProperties::Inspect (const UIDListuidList)

Report on the XML-related properties of a list of UID-based objects in the document

Parameters
uidListspecifies objects of interest
void SnpInspectSelectionXMLProperties::Inspect (const XMLReferencexmlRef)

Report on XML-related properties properties of a single XML element

Parameters
xmlRefspecifies element (IIDXMLElement) of interest
void SnpInspectSelectionXMLProperties::Inspect (const UIDRefobjectUIDRef)

Report on XML-related properties properties of a single UID-based object; this could be something like a graphic frame which contains an image or text.

Precondition
objectUIDRef should allow IFrameType to be instantiated
Parameters
objectUIDRefobject of interest
void SnpInspectSelectionXMLProperties::InspectLayoutObject (const UIDRefuidRef)

Report on properties of a graphic frame

Parameters
uidRefspecifies frame of interest
Precondition
uidRef should allow IGraphicFrameData to be instantiated
void SnpInspectSelectionXMLProperties::InspectTable (const UIDReftableModelUIDRef,
const GridAreagridArea 
)

Report on XML-related properties of a range of cells in table

Precondition
tableModelUIDRef should allow ITableModel to be instantiated
Parameters
tableModelUIDRef
gridAreaspecifies cells of interest
void SnpInspectSelectionXMLProperties::InspectText (const UIDReftextModelUIDRef,
const RangeDatatextRange 
)

Report on XML-related properties of a range of text

Parameters
textModelUIDRef
textRange
void SnpInspectSelectionXMLProperties::InspectTextFrame (const UIDRefuidRef)

Report XML properties of a text frame, including info about the XML elements in the span of the frame

Precondition
uidRef should allow IHierarchy to be instantiated
Parameters
uidReftext frame