 | FileHandlerExtensionValidateCopyAction Method |
Validate the selected copy action for each individual file before the action is executed.
Namespace: CTExtensions.InterfacesAssembly: CTInterface (in CTInterface.dll) Version: 25.0
Syntaxpublic virtual bool ValidateCopyAction(
int lBulkEditAction,
string bsOldFile,
string bsNewFile1,
Array oParents,
ref bool rbSupported,
ref string roErrorMsg
)
Public Overridable Function ValidateCopyAction (
lBulkEditAction As Integer,
bsOldFile As String,
bsNewFile1 As String,
oParents As Array,
ByRef rbSupported As Boolean,
ByRef roErrorMsg As String
) As Boolean
Parameters
- lBulkEditAction Int32
- eBulkEditAction
- bsOldFile String
- Original filename
- bsNewFile1 String
- Target filename. Empty for actions that do not make copies.
- oParents Array
- 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 Boolean
- 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 String
- Error message to show for the user when rbSupported is true.
Return Value
BooleanReturn true if CT Core should consider
rbSupported, false otherwise.
Revision HistoryDate | Version | Description |
---|
- | 2022 SP1 | First Release |
See Also