InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
_SnpRunnerManipulateGraphicAttributes Class Reference
Inheritance diagram for _SnpRunnerManipulateGraphicAttributes:
SnpRunnable

Public Member Functions

 _SnpRunnerManipulateGraphicAttributes ()
 
virtual ~_SnpRunnerManipulateGraphicAttributes ()
 
bool16 CanRun (ISnpRunnableContext *runnableContext)
 
ErrorCode Run (ISnpRunnableContext *runnableContext)
 
bool16 CanLoad () const
 
virtual
ISnipRunSuite::eSnpRunContextType 
GetContext (void)
 
- 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)
 
virtual ErrorCode SetupContext (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 SnpManipulateGraphicAttributes available to the SnippetRunner framework.

Constructor & Destructor Documentation

_SnpRunnerManipulateGraphicAttributes::_SnpRunnerManipulateGraphicAttributes ()

Constructor.

_SnpRunnerManipulateGraphicAttributes::~_SnpRunnerManipulateGraphicAttributes ()
virtual

Destructor

Member Function Documentation

bool16 _SnpRunnerManipulateGraphicAttributes::CanLoad (void ) const
virtual

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

Returns
kFalse if the host product is InCopy, kTrue otherwise.

Reimplemented from SnpRunnable.

bool16 _SnpRunnerManipulateGraphicAttributes::CanRun (ISnpRunnableContextrunnableContext)
virtual

Return kTrue if the snippet can run.

Parameters
runnableContextsee ISnpRunnableContext for documentation.
Returns
kTrue if a document is open, kFalse otherwise

Implements SnpRunnable.

virtual ISnipRunSuite::eSnpRunContextType _SnpRunnerManipulateGraphicAttributes::GetContext (void )
inlinevirtual

get the snippet context

Returns
eSnpRunContextType for this snippet

Implements SnpRunnable.

ErrorCode _SnpRunnerManipulateGraphicAttributes::Run (ISnpRunnableContextrunnableContext)
virtual

Run the snippet.

Parameters
runnableContextsee ISnpRunnableContext for documentation.
Returns
kSuccess on success, other ErrorCode otherwise.

Implements SnpRunnable.