CIP C++ documentation for class "pfcSessionActionListener"

Class pfcSessionActionListener

# include <pfcSession.h> class pfcSessionActionListener : public virtual pfcActionListener { xaideclare(pfcSessionActionListener) ... };

Description

This class specifies an action listener to notify you of session operations.

Manual References:: Action Listeners: Creo Object TOOLKIT C++ Action Listeners

Method Summary


`void`	`OnAfterDirectoryChange (xrstring Path)`
	Provides a notification function called after the current directory has been changed.

`void`	`OnAfterModelDisplay ()`
	Provides a notification function called after displaying a model.

`void`	`OnAfterModelPurge (pfcModelDescriptor_ptr Desrc)`
	This is the listener method called after purging a model.

`void`	`OnAfterWindowChange (optional pfcWindow_ptr NewWindow)`
	Provides a listener method called after changing a window in Creo Parametric.

`void`	`OnBeforeModelCopy (pfcDescriptorContainer2_ptr Container)`
	This is the listener method called before copying a model.

`void`	`OnBeforeModelDelete ()`
	This is the listener method called before deleting a model.

`void`	`OnBeforeModelErase ()`
	This is the stener method called before erasing a model.

`void`	`OnBeforeModelPurge (pfcDescriptorContainer_ptr Container)`
	This is the listener method called before purging a model.

`void`	`OnBeforeModelRename (pfcDescriptorContainer2_ptr Container)`
	This is the listener method called before renaming a model.

`void`	`OnBeforeModelSave (pfcDescriptorContainer_ptr Container)`
	This is the listener method called before saving a model.

Method Detail

void OnAfterDirectoryChange (xrstring Path)

Provides a notification function called after the current directory has been changed.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Session Level Action Listeners

Parameters:

Path: The new path to the directory that was changed

Returns:

void OnAfterWindowChange (optional pfcWindow_ptr NewWindow)

Provides a listener method called after changing a window in Creo Parametric.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Session Level Action Listeners

Parameters:

NewWindow: The new window object.

Returns:

void OnAfterModelDisplay ()

Provides a notification function called after displaying a model.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Session Level Action Listeners

Returns:

void OnBeforeModelErase ()

This is the stener method called before erasing a model.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Session Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Returns:

void OnBeforeModelDelete ()

This is the listener method called before deleting a model.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Returns:

void OnBeforeModelRename (pfcDescriptorContainer2_ptr Container)

This is the listener method called before renaming a model.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Session Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Container: Two model descriptors. Your application can fill in the descriptors, forcing the Creo Parametric interface to follow your naming conventions.

Returns:

void OnBeforeModelSave (pfcDescriptorContainer_ptr Container)

This is the listener method called before saving a model.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Session Level Action Listeners, Action Listeners: Model Level Action listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Container: User should initialize this object with the model name to be saved in callback. If it is not initialized, the system prompts for the model name interactively.

Returns:

void OnBeforeModelPurge (pfcDescriptorContainer_ptr Container)

This is the listener method called before purging a model.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Container: A model descriptor.

Returns:

void OnBeforeModelCopy (pfcDescriptorContainer2_ptr Container)

This is the listener method called before copying a model.

Manual References:: Action Listeners: Session Level Action Listeners, Action Listeners: Session Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Container: Two model descriptors; your listener method may fill in the descriptors. This will force the Creo Parametric UI to use yournaming rules for new models.

Returns:

void OnAfterModelPurge (pfcModelDescriptor_ptr Desrc)

This is the listener method called after purging a model.

Manual References:: Action Listeners: Session Level Action Listeners

Parameters:

Desrc

Returns: