CIP C++ documentation for class "pfcCustomCheckInstructions"

Class pfcCustomCheckInstructions

# include <pfcModelCheck.h> class pfcCustomCheckInstructions : public virtual xobject { xdeclare(pfcCustomCheckInstructions) ... }; This is a COMPACT class.

Description

This class provides the details about custom ModelCheck check.

Manual References:: Models: Custom Checks

Method Summary


`static pfcCustomCheckInstructions_ptr`	`Create (xrstring CheckName, xrstring CheckLabel, pfcModelCheckCustomCheckListener_ptr Listener)`
	Creates a new `pfcModelCheckInstructions` object.

`optional xstring`	`GetActionButtonLabel ()`
`void`	`SetActionButtonLabel (optional xrstring value)`
	Specifies label of the action button. Can be `null`, which means no action button will be shown.

`xstring`	`GetCheckLabel ()`
`void`	`SetCheckLabel (xrstring value)`
	Specifies the label of the check.

`xstring`	`GetCheckName ()`
`void`	`SetCheckName (xrstring value)`
	Specifies the name of the check.

`pfcModelCheckCustomCheckListener_ptr`	`GetListener ()`
`void`	`SetListener (pfcModelCheckCustomCheckListener_ptr value)`
	The object containing the implementation of the custom check methods.

`optional xstring`	`GetUpdateButtonLabel ()`
`void`	`SetUpdateButtonLabel (optional xrstring value)`
	Specifies label of the update button. Can be `null`, which means no update button will be shown.

Method Detail

`xstring`	`GetCheckName`	`()`
`void`	`SetCheckName`	`(xrstring value)`

Specifies the name of the check.

Manual References:: Models: Custom Checks, Models: Custom Checks

`xstring`	`GetCheckLabel`	`()`
`void`	`SetCheckLabel`	`(xrstring value)`

Specifies the label of the check.

Manual References:: Models: Custom Checks, Models: Custom Checks

`optional xstring`	`GetUpdateButtonLabel`	`()`
`void`	`SetUpdateButtonLabel`	`(optional xrstring value)`

Specifies label of the update button. Can be null, which means no update button will be shown.

Manual References:: Models: Custom Checks

`optional xstring`	`GetActionButtonLabel`	`()`
`void`	`SetActionButtonLabel`	`(optional xrstring value)`

Specifies label of the action button. Can be null, which means no action button will be shown.

Manual References:: Models: Custom Checks, Models: Custom Checks

`pfcModelCheckCustomCheckListener_ptr`	`GetListener`	`()`
`void`	`SetListener`	`(pfcModelCheckCustomCheckListener_ptr value)`

The object containing the implementation of the custom check methods.

Manual References:: Models: Custom Checks, Models: Custom Checks

static pfcCustomCheckInstructions_ptr Create (xrstring CheckName, xrstring CheckLabel, pfcModelCheckCustomCheckListener_ptr Listener)

Creates a new pfcModelCheckInstructions object.

Manual References:: Models: Custom Checks, Models: Custom Checks

Parameters:

CheckName: Name of the check.
CheckLabel: Label of the check.
Listener: The object containing the implementation of the custom check methods.

Returns:: The new object.