Click or drag to resize

FileHandlerExtensionCheckSupportedPropertyOperation Method

Validate the selected Property action before the action is executed. Called for all actions when Default action is selected to determine which operations really are supported.

Namespace:  CTExtensions.Interfaces
Assembly:  CTInterface (in CTInterface.dll)
Syntax
public virtual bool CheckSupportedPropertyOperation(
	int lPropertyAction,
	string bsFilename,
	ref bool rbSupported,
	ref string roErrorMsg
)

Parameters

lPropertyAction
Type: SystemInt32
SaveOperation
bsFilename
Type: SystemString
Current filename of the document
rbSupported
Type: SystemBoolean
return false to prevent user from exiting Properties with given lPropertyAction or return true when the action CAN be supported even thoguh the CT Core would otherwise define it unsupported (e.g. Renaming when file is read-only).
roErrorMsg
Type: SystemString
Error message to show for the user when preventing exit using rbSupported.

Return Value

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

CUSTOMTOOLS 2022 SP1


See Also