FileHandlerExtension Class |
Namespace: CTExtensions.Interfaces
The FileHandlerExtension type exposes the following members.
Name | Description | |
---|---|---|
FileHandlerExtension | Initializes a new instance of the FileHandlerExtension class |
Name | Description | |
---|---|---|
BatchProcessAfterConversions |
Called after Batch conversion has finished.
Use as such:
var fileMappings = poFileMappings.Cast<CTEngineLib.CTGeneric>().ToList();
var overriddenProperties = poOverridenProperties.Cast<CTEngineLib.CTGeneric>().ToList();
| |
BeforeAddToPrintList |
Pre notifies when a file is added to the print list
| |
CheckSupportedPropertyOperation |
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.
| |
EnsureLocalDocument |
Some operation is about to be using given document. FileHandler
may ensure it exists.
| |
FileSaveCompleted |
Post notification for save events, when CT core has finished all operations.
| |
FinalizeFilesInStructure |
Called for components/drawings that were requested at NotifyAddingToStructure. Note that
files -argument may contain also other files than those requested by this as any extension
may request a file to be addeed to the finalization.
| |
GetParent |
Must implement. Return parent CTExtension of this extension interface.
| |
GetParentDrawings |
Return filenames of drawings that reference to given filename and configuration.
| |
GetParentModels |
Return filenames of models that reference to given model and configuration.
| |
IdentifyLocalFile |
Possiblity to provide any arbitrary identification of the local file
in order to use the same id on different client. The id can be used to
RequestWriteAccess(Array, String) and ReleaseWriteAccessInBatch(Int32, Array, String).
| |
ImportSavedFile |
Notification given on file save and at Import. Allow performing
extra work to outside system for those file, and to prevent CT from
importing files to its DB.
| |
NotifyAddingToStructure |
Notification when a component or a drawing is added to the structure
| |
NotifyAddingToStructure2 |
Notification when a component or a drawing is added to the structure
| |
NotifyPrintDocumentDeserialized |
Notification send for print/convert document when it's getting deserialized and if any byte[] -data was
given at NotifyPrintDocumentSerialized(String, String). Any of the structure and file preparation methods
are not called for serialized process so this is the only place to handle correct local instances of
documents for the serialized process.
| |
NotifyPrintDocumentDeserialized2 |
Notification send for print/convert document when it's getting deserialized and if any byte[] -data was
given at NotifyPrintDocumentSerialized(String, String). Any of the structure and file preparation methods
are not called for serialized process so this is the only place to handle correct local instances of
documents for the serialized process.
| |
NotifyPrintDocumentSerialized |
Notification send for each print/convert document when the batch operation has been serialized for later execution.
Arbitrary byte[] -data can be returned which will be stored too, and then later provided at NotifyPrintDocumentDeserialized(String, String, Array).
Use case for these would be providing some identification data per document to handle the correct local instances at,
deserialization as the serialized process will not have any structure preparation methods called for it.
| |
NotifyPrintDocumentSerialized2 |
Notification send for each print/convert document when the batch operation has been serialized for later execution.
Arbitrary byte[] -data can be returned which will be stored too, and then later provided at NotifyPrintDocumentDeserialized(String, String, Array).
Use case for these would be providing some identification data per document to handle the correct local instances at,
deserialization as the serialized process will not have any structure preparation methods called for it.
| |
PreConvert |
Called just before the document is converted into another format using given rule.
| |
PrepareStructure |
Prepare given filename/configuration for structure retrieval
| |
PreSaveFile |
Notification that is send when a file is saved with given name.
This is called only when CT has programmatically called save or
CT has overridden the save dialog. These are the only cases we can
be sure about the resulting target filename before its creation.
ImportSavedFile is called in all save cases but after the document
is already saved.
| |
ReleaseWriteAccessInBatch |
Relesase write access to files obtained at RequestWriteAccess(Array, String).
| |
RequestWriteAccess |
Obtain modifiable local copy for the ID provided by IdentifyLocalFile(String, Array).
ReleaseWriteAccessInBatch(Int32, Array, String) MUST be called if and only if this function
returns true. This function cab return false AND a valid bsLocalFilePath if the
file in given local path is modifiable but there is no need to call ReleaseWriteAccessInBatch(Int32, Array, String).
| |
RequireStructureCalls |
Notification send before structure is about to be built
using light structure which doesn't notify the components
for Filehandler. Return true in case your filehandler
needs to be able to prepare the structure and its components.
| |
ResolveIdentifiedLocalFile |
Get local path of file identified with IdentifyLocalFile(String, Array).
| |
ValidateCopyAction |
Validate the selected copy action for each individual file before the action is executed.
|
CUSTOMTOOLS 2019 SP0