IShowPageItemUtils Class Reference

#include <IShowPageItemUtils.h>

Inheritance diagram for IShowPageItemUtils:

Public Types
enum	{ kDefaultIID = IID_ISHOWPAGEITEMUTILS }
enum	{   kSuccess = 0, kOutOfMemory = kOutOfMemoryError, kInvalidParameter = kInvalidParameterErr, kHiddenPageItem = kHiddenPageItemError,   kOverSetGraphic = kOverSetGraphicError, kHiddenFormFieldState = kHiddenFormFieldStateError, kDeletedTextGraphic = kDeletedTextGraphicError, kXMLNotInLayoutGraphic = kXMLNotInLayoutGraphicError,   kHiddenTextGraphic = kHiddenTextGraphicError, kHiddenMSOState = kHiddenMSOStateError, kHiddenSpread = kHiddenSpreadError }

Public Member Functions
virtual ErrorCode	Show (IDataBase *db, UID pageItemUID)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This class is a helper class that will allow clients to show a given page item by passing in the database and UID of the item. The item when shown will be centered on the page and zoomed in on.

Member Enumeration Documentation

anonymous enum

The return values for Show

Enumerator
kSuccess	Everything worked
kOutOfMemory	Ran out of memory
kInvalidParameter	Invalid parameter passed in
kHiddenPageItem	Object was hidden (probably on a hidden layer)
kOverSetGraphic	Object was in overset text and could not be shown
kHiddenFormFieldState	The form field was in a hidden state
kDeletedTextGraphic	Object was in a deleted text track change and could not be shown
kXMLNotInLayoutGraphic	Object was in XML backing store and could not be shown
kHiddenTextGraphic	Object was in hidden conditional text and could not be shown
kHiddenMSOState	Object was in an inactive state of a multiple-state object and could not be shown
kHiddenSpread	Object is on a hidden spread

Member Function Documentation

virtual ErrorCode IShowPageItemUtils::Show ( IDataBase *  db, UID  pageItemUID  )

pure virtual

Show a page item

Parameters

db	- The DataBase the page item is in
pageItemUID	- The UID of the page item

Returns

- an error state indicating whether the item could be shown.