InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPreflightTableCellInfo Class Referenceabstract

#include <IPreflightTableCellInfo.h>

Inheritance diagram for IPreflightTableCellInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPREFLIGHTTABLECELLINFO }
 

Public Member Functions

virtual UIDRef GetTableModelRef () const =0
 
virtual GridArea GetGridArea () const =0
 
virtual UIDRef GetTableFrameRef () const =0
 
virtual void Initialize ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface provides information about a particular table cell, table frame cell, or table cell area found in the document.

Member Function Documentation

virtual GridArea IPreflightTableCellInfo::GetGridArea () const
pure virtual

Get the area in the table model this cell or cell range is.

To determine whether this is a single cell, as opposed to a range, use GetGridArea().GetSpan().IsUnitSpan(). Note that if you know this is a TableCell or TableFrameCell, you're guaranteed that it is a single cell, so this advice only applies if you're handed one of these interfaces without context.

If you know it's a single cell then you can get the address from GetGridArea().GetTopLeft().

Returns
The area of the cell.
virtual UIDRef IPreflightTableCellInfo::GetTableFrameRef () const
pure virtual

Get the UIDRef of the table frame, ie the owned item in a parcel that contains the cell. This will only return a valid UIDRef if this is a table frame cell (a table cell is a true UID based data structure; a table frame cell is the composed, non-UID-based cell-on-page).

Returns
The UIDRef of the table frame; or an invalid UIDRef if this is a table cell.
virtual UIDRef IPreflightTableCellInfo::GetTableModelRef () const
pure virtual

Get the UIDRef of the table model that "owns" the cell.

Returns
UIDRef of the table model that "owns" the cell.
virtual void IPreflightTableCellInfo::Initialize ()
pure virtual

Initialize. Internal use only.