SnpIterTableStories Class Reference

Public Member Functions
	SnpIterTableStories ()
virtual	~SnpIterTableStories ()
ErrorCode	IterateAllTablesInDocument (IDocument *document)
void	IterateAllTablesInStory (UIDRef &story)

Detailed Description

• Iterate tables in document using deprecated method; recommended method shown in SnpIterTableUseDictHier.

Deprecated mechanism to iterate through tables in a document. Ideally use the method illustrated in SnpIterTableUseDictHier rather than the method involving ITableModelList shown here.

See Also

ITableModelList

Constructor & Destructor Documentation

SnpIterTableStories::SnpIterTableStories ( )

inline

Constructor.

virtual SnpIterTableStories::~SnpIterTableStories ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpIterTableStories::IterateAllTablesInDocument

(

IDocument *

document

)

Shows how to get all tables in a document by iterating through the story list. This uses the ITableModelList. See SnpIterTableUseDictHier::IterateAllTablesInDocument() for a better technique. Also see Tables technotes for more information regarding these 2 techniques.

Parameters

document

The document of interest.

Returns

kSuccess on success, kFailure otherwise.

void SnpIterTableStories::IterateAllTablesInStory

(

UIDRef &

story

)

Iterate though all tables in a story, by iterating through ITableModelList on kTextStoryBoss. Compare with SnpIterTableUseDictHier::IterateAllTablesInStory().

Parameters

story

UIDRef of the story to inspect.