SnpCreateFrameGrid Class Reference

Public Member Functions
	SnpCreateFrameGrid ()
virtual	~SnpCreateFrameGrid ()
ErrorCode	CreateFrameGrid (ILayoutControlData *layoutControlData, UIDRef &outFrameUIDRef, const PMReal left, const PMReal top, const int32 numCharsPerLine, const int32 numLines, const int32 numColumns, const PMReal columnGutterWidth, const bool16 verticalFrame=kTrue, WideString *textToInsert=nil)

Detailed Description

• How to create a frame grid (Japanese feature set required).

TODO: please use SequencePtr instead of ICommandSequence*

See Also

kCreateMultiColumnItemCmdBoss

kActivateCJKGridCmdBoss

kApplyCJKGridFormatCmdBoss

ICJKGridData

Constructor & Destructor Documentation

SnpCreateFrameGrid::SnpCreateFrameGrid ( )

inline

Constructor.

virtual SnpCreateFrameGrid::~SnpCreateFrameGrid ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpCreateFrameGrid::CreateFrameGrid	(	ILayoutControlData *	layoutControlData,
		UIDRef &	outFrameUIDRef,
		const PMReal	left,
		const PMReal	top,
		const int32	numCharsPerLine,
		const int32	numLines,
		const int32	numColumns,
		const PMReal	columnGutterWidth,
		const bool16	verticalFrame = kTrue,
		WideString *	textToInsert = nil
	)

Shows how to create a frame grid. The actual size of the frame will be determined by: (1) the number of characters per line (2) the number of lines (3) the number of columns (4) the space in between columns (in points) (5) the settings of the layout grid of the page.

Parameters

outFrameUIDRef	(out) The UIDRef of the created frame grid.
left	(in) The left coordinate of the frame grid to be created.
top	(in) The top coordinate of the frame grid to be created.
numCharsPerLine	(in) The number of characters per line in each column of the frame grid.
numLines	(in) The number of lines in each column of the frame grid.
numColumns	(in) The number of columns in the frame grid.
columnGutterWidth	(in) The gap between columns (in Points). If there is only 1 column, this value is ignored.
verticalFrame	(in) Set to kTrue to make the frame grid vertical, kFalse to make it horizontal.
textToInsert	(in) Specify the ptr to the WideString to insert. Set to nil if no text needs to be inserted.

Returns

kSuccess on success, kFailure otherwise.