![]() | InDesign SDK 20.5 |
#include <IPageItemTypeUtils.h>

Public Types | |
| enum | { kDefaultIID = IID_IPAGEITEMTYPEUTILS } |
Public Member Functions | |
| virtual void | CategorizePageItems (const UIDList, int32 *totalItemCountPtr, int32 *graphicFrameCountPtr, int32 *textFrameCountPtr, int32 *imageCountPtr, int32 *topCountPtr, int32 *guideCountPtr, int32 *standoffCountPtr, int32 *standardItemCountPtr) const =0 |
| virtual bool16 | IsTextOnAPath (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsTextOnAPath (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsHTMLPageItem (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsHTMLPageItem (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsGraphicFrame (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsGraphicFrame (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsTextFrame (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsTextFrame (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsGraphic (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsGraphic (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsGuide (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsGuide (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | OnlyGuidesInList (const UIDList &items) const =0 |
| virtual bool16 | IsStandOff (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsStandOff (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | HasStandOff (const IPMUnknown *) const =0 |
| virtual bool16 | IsTextInset (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsTextInset (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | HasTextInset (const IPMUnknown *) const =0 |
| virtual bool16 | IsInline (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsInline (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsDirectInlineItem (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsDirectInlineItem (const IPMUnknown *iPageItem) const =0 |
| virtual IAnchoredObjectData::AnchoredPosition | GetInlinePosition (const UIDRef &pageItemUIDRef) const =0 |
| virtual IAnchoredObjectData::AnchoredPosition | GetInlinePosition (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsGroup (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsGroup (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsMedia (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsMedia (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsContent (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsContent (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsChildOfScrapItem (const IScrapItem *, IScrapItem *) const =0 |
| virtual bool16 | IsInlineInStory (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsInlineInLockedStory (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsWrapSupportedInline (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsPlacedInDesignPage (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsPlacedInDesignPage (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsButton (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsButton (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsMultiStateObject (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsMultiStateObject (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsFormItem (IPMUnknown *inBoss) const =0 |
| virtual bool16 | IsFormItem (UIDRef inRef) const =0 |
| virtual bool16 | IsCheckBox (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsCheckBox (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsRadioButton (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsRadioButton (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | PageItemHasAppearanceList (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | PageItemHasAppearanceList (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsPlacedInTable (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsPlacedInTable (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsDirectlyPlacedInTable (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsDirectlyPlacedInTable (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsPlacedInsideText (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsPlacedInsideText (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsEndnoteTextFrame (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsEndnoteTextFrame (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsEmptyGraphicFrame (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsEmptyGraphicFrame (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsNotAFrame (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsNotAFrame (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsThreadedTextFrame (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsThreadedTextFrame (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsSVGPageItem (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsSVGPageItem (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsTableFrame (const UIDRef &pageItemUIDRef) const =0 |
| virtual bool16 | IsTableFrame (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsMathObject (const IPMUnknown *iPageItem) const =0 |
| virtual bool16 | IsMathObject (const UIDRef &pageItemUIDRef) const =0 |
Public Member Functions inherited from IPMUnknown | |
| virtual IPMUnknown * | QueryInterface (PMIID interfaceID) const =0 |
| virtual void | AddRef () const =0 |
| virtual void | Release () const =0 |
Utility class for classifying and determing what type of page item something is.
| pure virtual |
Categorize the page items in the UIDList. Replacement for LayoutUtils::WhatIsSelected(). When using the selection UIDList, it should only be called from the Layout CSB in the new selection architecture. NOTE: Any of the int32* may be nil. In fact, for performance reasons, pass nil for any count you don't care about.
| UIDList,UIDList | [IN] UIDList of page items to categorize. |
| *totalItemCountPtr | [OUT] Total number of items in the selection, may be nil. |
| *graphicFrameCountPtr | [OUT] Total number of graphic frames in the selection, may be nil. |
| *textFrameCountPtr | [OUT] Total number of text frames in the selection, may be nil. |
| *imageCountPtr | [OUT] Total number of images in the selection, may be nil. |
| *topCountPtr | [OUT] Total number of Text on Path items in the selection, may be nil. |
| *guideCountPtr | [OUT] Total number of guide items in the selection, may be nil. |
| *standoffCountPtr | [OUT] Total number of standoff items in the selection, may be nil. |
| *standardItemCountPtr | [OUT] Default case of not one of the above types, total number of all other kinds of items in the selection, may be nil. |
| pure virtual |
Return the position of an inline anchored object. One of the values: kStandardInline, kAnchoredObject, kAboveLine.
| pageItemUIDRef | [IN] UIDRef of the page item in question. Page item must be an inline. |
| pure virtual |
Return the position of an inline anchored object. One of the values: kStandardInline, kAnchoredObject, kAboveLine.
| pageItemUIDRef | [IN] UIDRef of the page item in question. Page item must be an inline. |
| pure virtual |
Does the Specified page item have a "Standoff" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Does the Specified page item have a "Text Inset" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a Button?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a Button?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the specified page item a check box?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a check box?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "child of the scrap" item?
| IScrapItem* | [IN] The parent item to check |
| IScrapItem* | [IN] The child item to check |
| pure virtual |
Is the page item content of a frame? (For InCopy). e.g. Can item be modified/selected? Items within other frames and inlines are both considered content (though not anchored frames).
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the page item content of a frame? (For InCopy). e.g. Can item be modified/selected? Items within other frames and inlines are both considered content (though not anchored frames).
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item's direct parent an "inline" item? Useful for determining if you have the actual inline selected (kTrue), or an item farther down the inline's hierarchy (kFalse) (e.g. an image or pasted inside item).
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item's direct parent an "inline" item? Useful for determining if you have the actual inline selected (kTrue), or an item farther down the inline's hierarchy (kFalse) (e.g. an image or pasted inside item).
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Does the specified page item's direct parent is the root object placed inside the table's graphic cell(not as inline)
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Does the specified page item's direct parent is the root object placed inside the table's graphic cell(not as inline)
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Empty Graphic frame"(contains nothing) item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Empty Graphic frame"(contains nothing) item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a text frame for an endnote story?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the specified page item a text frame for an endnote story?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Does the specified page item have a form field interface? (Button or Multi-state object)
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Does the specified page item have a form field interface? (Button or Multi-state object)
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Graphic" (raster or vector) item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Graphic" (raster or vector) item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a "Graphic frame" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Graphic frame" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a "group" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "group" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a "Guide" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Guide" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Returns true iff the item is an embedded HTML item (e.g., iframe)
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Returns true iff the item is an embedded HTML item (e.g., iframe)
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item's root an "inline" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item's root an "inline" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item an inline is in the story that is locked
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item an inline in the primary story thread (meaning not in a table, or a note, or a footnote)?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a Math Object?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a Math Object?
| iPageItem | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "media" item (sound or movie)?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "media" item (sound or movie)?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a multi-state object?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a multi-state object?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a shape(indesign native) item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a shape(indesign native) item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a placed InDesign page?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a placed InDesign page?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Does the specified page item placed inside the text model, either as inline object or being placed inside the table's graphic cells
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Does the specified page item placed inside the text model, either as inline object or being placed inside the table's graphic cells
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Does the specified page item placed inside the table's graphic cell(not as inline)
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Does the specified page item placed inside the table's graphic cell(not as inline)
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the specified page item a radio button?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the specified page item a radio button?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Standoff" or "Text Inset" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Standoff" or "Text Inset" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item an "SVG" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item an "SVG" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a Table Frame?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a Table Frame?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a "Text frame" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Text frame" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a "Text Inset" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Text Inset" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item a "Text on a Path" item?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a "Text on a Path" item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the selected frame is threaded text frame?
| pageItemUIDRef | [IN] UIDRef of the page item in question. |
| pure virtual |
Is the Specified page item a shape(indesign native) item?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
Is the Specified page item an inline in a TextStoryThread that supports TextWrap?
| iPageItem | [IN] An interface from the page item in question. |
| pure virtual |
| pure virtual |
Does the specified page item has appearance list?
| iPageItem | [IN] An interface from the page item in question. |