SnpCreateTable Class Reference

#include <SnpCreateTable.h>

Public Member Functions
bool16	CanCreateTable (const UIDRef &storyRef, const TextIndex at)
ErrorCode	CreateTable (const UIDRef &storyRef, const TextIndex at, const int32 numRows=2, const int32 numCols=3, const PMReal rowHeight=60.0, const PMReal colWidth=100.0, const CellType cellType=kTextContentType)

Detailed Description

• Creates a new table using ITableUtils.

See Also

kNewTableCmdBoss

Member Function Documentation

bool16 SnpCreateTable::CanCreateTable	(	const UIDRef &	storyRef,
		const TextIndex	at
	)

Checks if a table can be created (added for 1026750).

Parameters

storyRef	references the story the table is to be created inside
at	where to insert the table in the story

Returns

kTrue if a table can be created, kFalse otherwise.

ErrorCode SnpCreateTable::CreateTable	(	const UIDRef &	storyRef,
		const TextIndex	at,
		const int32	numRows = 2,
		const int32	numCols = 3,
		const PMReal	rowHeight = 60.0,
		const PMReal	colWidth = 100.0,
		const CellType	cellType = kTextContentType
	)

Method that attempts to create a table

Returns

kSuccess on success, kFailure otherwise.