CIP Visual Basic.NET documentation for interface "IpfcModelCheckCustomCheckListener"

Interface IpfcModelCheckCustomCheckListener

Description

This interface should be extended to provide the implementation for a ModelCheck custom check.

Method Summary


`Function`	`OnCustomCheck (CheckName as String, Mdl as IpfcModel) as IpfcCustomCheckResults`
	Override this method to evaluate a ModelCheck externally defined check.

`Sub`	`OnCustomCheckAction (CheckName as String, Mdl as IpfcModel, SelectedItem as String [optional])`
	Override this method to execute a repair action on an item found by a custom check.

`Sub`	`OnCustomCheckUpdate (CheckName as String, Mdl as IpfcModel, SelectedItem as String [optional])`
	Override this method to update an item found by a custom check.

Method Detail

Function OnCustomCheck (CheckName as String, Mdl as IpfcModel) as IpfcCustomCheckResults

Override this method to evaluate a ModelCheck externally defined check.

Parameters:

Returns:: The IpfcCustomCheckResults object containing the results of the check for this model.

Sub OnCustomCheckAction (CheckName as String, Mdl as IpfcModel, SelectedItem as String [optional])

Override this method to execute a repair action on an item found by a custom check.

Parameters:

CheckName: Name of the check.
Mdl: The model.
SelectedItem: Label of the item that was selected from the table, if applicable. This will match the value of string returned in the IpfcCustomCheckResults object returned by IpfcModelCheckCustomCheckListener.OnCustomCheck(). Can be null if no item was selected.

Sub OnCustomCheckUpdate (CheckName as String, Mdl as IpfcModel, SelectedItem as String [optional])

Override this method to update an item found by a custom check.

Parameters:

CheckName: Name of the check.
Mdl: The model.
SelectedItem: Label of the item that was selected from the table,if applicable. This will match the value of string returned in the IpfcCustomCheckResults object returned by IpfcModelCheckCustomCheckListener.OnCustomCheck().