CIP Visual Basic.NET documentation for interface "IpfcModelActionListener"

Interface IpfcModelActionListener

Description

This class defines an action listener for models that notifies you when operations on a model occur.

Direct Parent Classes:: IpfcActionListener

Method Summary


`Sub`	`OnAfterModelCopy (FromMdl as IpfcModel, ToMdl as IpfcModel [optional])`
	The listener method called after successful execution of a copy command.

`Sub`	`OnAfterModelCopyAll (FromMdl as IpfcModel, ToMdl as IpfcModel [optional])`
	This is the listener method called after successful copying of any model (not just an explicit copy of a single model).

`Sub`	`OnAfterModelCreate (Mdl as IpfcModel)`
	This is the listener method called after successful creation of a model.

`Sub`	`OnAfterModelDelete (Mdl as IpfcModel)`
	This is the listener method called after successful deletion of a model.

`Sub`	`OnAfterModelDeleteAll (Descr as IpfcModelDescriptor)`
	The listener method called after successful deletion of any model, (not just an explicit deletion of a single model).

`Sub`	`OnAfterModelErase (Mdl as IpfcModel)`
	This is the listener method called after successful erasing of a model.

`Sub`	`OnAfterModelEraseAll (Descr as IpfcModelDescriptor)`
	This is the listener method called after successful erasure of any model, (not just an explicit erasure of a single model).

`Sub`	`OnAfterModelRename (FromMdl as IpfcModel, ToMdl as IpfcModel [optional])`
	This is the listener method called after successful renaming of a model.

`Sub`	`OnAfterModelRetrieve (Mdl as IpfcModel)`
	This is the listener method called after successful retrieval of a model.

`Sub`	`OnAfterModelRetrieveAll (Descr as IpfcModelDescriptor)`
	This is the listener method called after successful retrieval of any model, (not just an explicit retrieval of a single model).

`Sub`	`OnAfterModelSave (Descr as IpfcModelDescriptor)`
	This is the listener mothod called after successful saving of a model.

`Sub`	`OnAfterModelSaveAll (Descr as IpfcModelDescriptor)`
	This is the listener method called after successful saving of any model, (not just an explicit save of a single model).

`Sub`	`OnBeforeModelDisplay (Mdl as IpfcModel)`
	The listener method called before a model is displayed.

`Sub`	`OnBeforeParameterCreate (Owner as IpfcModel, Name as String, Value as IpfcParamValue)`
	This is the listener method called before creating a parameter. To abort parameter creation throw exception `IpfcXCancelProEAction`.

`Sub`	`OnBeforeParameterDelete (Param as IpfcParameter)`
	This is the listener method called before deleting a parameter. To abort parameter delete operation throw exception `IpfcXCancelProEAction`.

`Sub`	`OnBeforeParameterModify (Param as IpfcParameter, Value as IpfcParamValue)`
	This is the listener method called before modifying a parameter. To abort parameter modification throw exception `IpfcXCancelProEAction`.

Method Detail

Sub OnAfterModelCopy (FromMdl as IpfcModel, ToMdl as IpfcModel [optional])

The listener method called after successful execution of a copy command.

This method is deprecated. Use IpfcModelEventActionListener.OnAfterModelCopy() for better performance. This listener method is called only for models which are explicity copied, not for dependent models.

Parameters:

FromMdl: Source model that was copied.
ToMdl: Target model created by copying.

Sub OnAfterModelCopyAll (FromMdl as IpfcModel, ToMdl as IpfcModel [optional])

This is the listener method called after successful copying of any model (not just an explicit copy of a single model).

This method is deprecated. Use IpfcModelEventActionListener.OnAfterModelCopyAll() for better performance. For example, when copying an assembly and all the component parts in it, this method will be called once for each model copied.

Parameters:

FromMdl: Source model that was copied.
ToMdl: Target model created by copying.

Sub OnAfterModelCreate (Mdl as IpfcModel)

This is the listener method called after successful creation of a model.

This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Mdl: Model just created

Sub OnAfterModelDelete (Mdl as IpfcModel)

This is the listener method called after successful deletion of a model.

This method is deprecated. Use IpfcModelEventActionListener.OnAfterModelDelete() for better performance. This listener method is caled only for models which are explicitly deleted, not for dependent models. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Mdl: Model that was deleted.

Sub OnAfterModelDeleteAll (Descr as IpfcModelDescriptor)

The listener method called after successful deletion of any model, (not just an explicit deletion of a single model).

For example, when deleting an assembly and all the component parts in it, called once for each model deleted. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Descr: The model descriptor of the deleted part

Sub OnAfterModelErase (Mdl as IpfcModel)

This is the listener method called after successful erasing of a model.

This method is deprecated. Use IpfcModelEventActionListener.OnAfterModelErase() for better performance. This listener method is called only for models which are explicitly erased, not for dependent models. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Mdl: Model that was erased.

Sub OnAfterModelEraseAll (Descr as IpfcModelDescriptor)

This is the listener method called after successful erasure of any model, (not just an explicit erasure of a single model).

For example, when erasing an assembly and all the component parts in it, this method is called once for each model erased. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Descr: The model descriptor of the erased model

Sub OnAfterModelRename (FromMdl as IpfcModel, ToMdl as IpfcModel [optional])

This is the listener method called after successful renaming of a model.

This method is deprecated. Use IpfcModelEventActionListener.OnAfterModelRename() for better performance. This listener method is called only for models which are explicitly renamed, not for dependent models.

Parameters:

FromMdl: Model that was renamed.
ToMdl: The newly renamed model.

Sub OnAfterModelRetrieve (Mdl as IpfcModel)

This is the listener method called after successful retrieval of a model.

This listener method is called only for models which are explicitly retrieved, not for dependent models. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Mdl: Name of the retrieved model

Sub OnAfterModelRetrieveAll (Descr as IpfcModelDescriptor)

This is the listener method called after successful retrieval of any model, (not just an explicit retrieval of a single model).

For example, when retrieving an assembly and all the component parts in it, this method is called once for each model retrieved. This listener method will only be invoked if the ModelActionListener is assigned to the Creo Parametric session. It may not be assigned to an individual model.

Parameters:

Descr: The model descriptor of the retrieved part

Sub OnAfterModelSave (Descr as IpfcModelDescriptor)

This is the listener mothod called after successful saving of a model.

This listener method is called only for models which are explicitly saved, not for dependent models.

Parameters:

Descr: The descriptor of the saved model

Sub OnAfterModelSaveAll (Descr as IpfcModelDescriptor)

This is the listener method called after successful saving of any model, (not just an explicit save of a single model).

For example, when saving an assembly and all the component parts in it, this method is called once for each model saved.

Parameters:

Descr: The model descriptor of the saved part

Sub OnBeforeModelDisplay (Mdl as IpfcModel)

The listener method called before a model is displayed.

This method is blocked for asynchronous mode, because it causes a significant slowdown when changing the display of a model (rotating or moving).

Parameters:

Mdl: Name of the model to be displayed

Sub OnBeforeParameterCreate (Owner as IpfcModel, Name as String, Value as IpfcParamValue)

This is the listener method called before creating a parameter. To abort parameter creation throw exception IpfcXCancelProEAction.

Parameters:

Owner: Owner model of parameter
Name: Name of parameter
Value: Value of parameter

Sub OnBeforeParameterDelete (Param as IpfcParameter)

This is the listener method called before deleting a parameter. To abort parameter delete operation throw exception IpfcXCancelProEAction.

Parameters:

Param: Name of parameter to be deleted

Sub OnBeforeParameterModify (Param as IpfcParameter, Value as IpfcParamValue)

This is the listener method called before modifying a parameter. To abort parameter modification throw exception IpfcXCancelProEAction.

Parameters:

Param: Parameter to be modified
Value: Value of the parameter