SnpInspectLayoutGrid Class Reference

Public Member Functions
virtual	~SnpInspectLayoutGrid ()
ErrorCode	InspectPages (const UIDList &pages)
ErrorCode	InspectLayoutGrid (const UIDRef &thePage, SnpLayoutGridInfo &info)
void	ReportLayoutGridInfo (const SnpLayoutGridInfo &info, const int32 pageIndex=-1)
UIDRef	GetFirstSelectedPage (IActiveContext *activeContext)

Detailed Description

• Inspect layout grid information for selected pages.

See Also

ICJKGridData

ICJKGridManager

ICJKGridUtils

ICJKLayoutGridData

SnpModifyLayoutGrid

Constructor & Destructor Documentation

virtual SnpInspectLayoutGrid::~SnpInspectLayoutGrid ( )

inlinevirtual

Destructor.

Member Function Documentation

UIDRef SnpInspectLayoutGrid::GetFirstSelectedPage

(

IActiveContext *

activeContext

)

Gets the first visible and selected page.

Parameters

activeContext

IN The current active context.

Returns

UIDRef of the first selected page

ErrorCode SnpInspectLayoutGrid::InspectLayoutGrid	(	const UIDRef &	thePage,
		SnpLayoutGridInfo &	info
	)

Shows how to inspect all information related to a layout grid on a given page.

Parameters

thePage	UIDRef of the page to inspect.
info	(return) Information structure with layout grid info.

Returns

kSuccess on success, kFailure otherwise.

ErrorCode SnpInspectLayoutGrid::InspectPages

(

const UIDList &

pages

)

Shows how to inspect pages in a document

Returns

kSuccess on success, kFailure otherwise.

void SnpInspectLayoutGrid::ReportLayoutGridInfo	(	const SnpLayoutGridInfo &	info,
		const int32	pageIndex = -1
	)

Report layout grid info to SNIPLOG.

Parameters

info	Information structure returned from InspectLayoutGrid().
pageIndex	Index from the list of pages. In the snip log, the index of the page in the page list passed into InspectPages will be displayed. -1 means don't care, and a different title gets displayed in the SNIPLOG.