Click or drag to resize

FileHandlerExtensionValidateCopyAction Method

Validate the selected copy action for each individual file before the action is executed.

Namespace:  CTExtensions.Interfaces
Assembly:  CTInterface (in CTInterface.dll)
Syntax
Copy
public virtual bool ValidateCopyAction(
	int lBulkEditAction,
	string bsOldFile,
	string bsNewFile1,
	Array oParents,
	ref bool rbSupported,
	ref string roErrorMsg
)

Parameters

lBulkEditAction
Type: SystemInt32
eBulkEditAction
bsOldFile
Type: SystemString
Original filename
bsNewFile1
Type: SystemString
Target filename. Empty for actions that do not make copies.
oParents
Type: SystemArray
Array of strings; contains original filenames of bsOldFile's parent files THAT ARE NOT SELECTED for the current action, but would get modified by the current action. E.g. renaming child component requires that parent file is modifiable so it reference to the renamed child component can be updated.
rbSupported
Type: SystemBoolean
return false to give roErrorMsg and prevent preforming the lBulkEditAction. Return true to allow the action even if the CT core would otherwise define it unsupported.
roErrorMsg
Type: SystemString
Error message to show for the user when rbSupported is true.

Return Value

Type: Boolean
Return true if CT Core should consider rbSupported, false otherwise.
Availability

CUSTOMTOOLS 2022 SP1


See Also