SnpInspectTableModel Class Reference

Public Member Functions
	SnpInspectTableModel ()
virtual	~SnpInspectTableModel ()
ErrorCode	InspectTable (int32 tchoice, const InterfacePtr< ITableSuite > &tableSuite)
ErrorCode	InspectSelectionInTable (int32 sitchoice, const InterfacePtr< ITableSuite > &tableSuite)

Detailed Description

• How to inspect various properties of a story's table model (ITableSuite)

This snippet highlights those ITableSuite functions that answer questions about the selection or about the table containing the selection. This snippet does not cover how to override supplied cell/table/row attributes; the TableAttributes SDK sample plug-in covers this.

For additional information regarding table attributes, look in the browseable API documentation for kTableAttrXXXBoss entries.

See Also

ITableSuite

Constructor & Destructor Documentation

SnpInspectTableModel::SnpInspectTableModel ( )

inline

Constructor.

virtual SnpInspectTableModel::~SnpInspectTableModel ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpInspectTableModel::InspectSelectionInTable	(	int32	sitchoice,
		const InterfacePtr< ITableSuite > &	tableSuite
	)

Inspect selection in table.

Parameters

sitchoice	Specifies index of refined selection inspection.
tableSuite	Supplied ITableSuite*.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpInspectTableModel::InspectTable	(	int32	tchoice,
		const InterfacePtr< ITableSuite > &	tableSuite
	)

Inspect table containing selection.

Parameters

tchoice	Specifies index of refined table inspection.
tableSuite	Supplied ITableSuite*.

Returns

kSuccess on success, other ErrorCode otherwise.