_SnpRunnerExportBookAsPDF Class Reference

Inheritance diagram for _SnpRunnerExportBookAsPDF:

Public Member Functions
	_SnpRunnerExportBookAsPDF (void)
virtual	~_SnpRunnerExportBookAsPDF (void)
bool16	CanRun (ISnpRunnableContext *runnableContext)
ErrorCode	Run (ISnpRunnableContext *runnableContext)
bool16	CanLoad () const
virtual ISnipRunSuite::eSnpRunContextType	GetContext (void)
virtual ErrorCode	SetupContext (ISnpRunnableContext *runnableContext)
Public Member Functions inherited from SnpRunnable
	SnpRunnable (ConstCString name)
virtual	~SnpRunnable ()
virtual ConstCString	GetName () const
virtual ConstCString	GetDescription () const
virtual ConstCString	GetPreconditions () const
virtual ConstCString	GetCategories () const
virtual ErrorCode	RunUnitTest (ISnpRunnableContext *runnableContext)

Additional Inherited Members
Protected Member Functions inherited from SnpRunnable
virtual void	SetDescription (ConstCString description)
virtual void	SetPreconditions (ConstCString preconditions)
virtual void	SetCategories (ConstCString categories)

Detailed Description

Makes the snippet SnpExportBookAsPDF available to the SnippetRunner framework.

Constructor & Destructor Documentation

_SnpRunnerExportBookAsPDF::_SnpRunnerExportBookAsPDF

(

void

)

Constructor.

_SnpRunnerExportBookAsPDF::~_SnpRunnerExportBookAsPDF ( void  )

virtual

Destructor.

Member Function Documentation

bool16 _SnpRunnerExportBookAsPDF::CanLoad ( void  ) const

virtual

Don't present this snippet in the framework's UI if the product we are running under is InCopy.

Returns

kTrue if the snippet can be loaded, kFalse otherwise.

Reimplemented from SnpRunnable.

bool16 _SnpRunnerExportBookAsPDF::CanRun ( ISnpRunnableContext *  runnableContext )

virtual

Return kTrue if the snippet can run.

Parameters

runnableContext

see ISnpRunnableContext for documentation.

Returns

kTrue if snippet can run, kFalse otherwise

Implements SnpRunnable.

virtual ISnipRunSuite::eSnpRunContextType _SnpRunnerExportBookAsPDF::GetContext ( void  )

inlinevirtual

get the snippet context

Returns

eSnpRunContextType for this snippet

Implements SnpRunnable.

ErrorCode _SnpRunnerExportBookAsPDF::Run ( ISnpRunnableContext *  runnableContext )

virtual

Run the snippet.

Parameters

runnableContext

see ISnpRunnableContext for documentation.

Returns

kSuccess on success, other ErrorCode otherwise.

Implements SnpRunnable.

ErrorCode _SnpRunnerExportBookAsPDF::SetupContext ( ISnpRunnableContext *  runnableContext )

virtual

default behavior for snippet setup context

Set up the proper InDesign context for the snippert so that it can be run.

Parameters

runnableContext

Returns

kSuccess on success, other ErrorCode otherwise

Set up the proper InDesign context for the snippert so that it can be run.

Parameters

runnableContext

Returns

kSuccess on success, other ErrorCode otherwise

Reimplemented from SnpRunnable.