Click or drag to resize
FileHandlerExtension Class
Base implementation of interface type ctExtensionInterfaceFileHandler. Must implement at least GetParent. Override GetInterface2(ctExtensionInterface) in your extension and return your implementation of this interface when requested type is ctExtensionInterfaceFileHandler.
Inheritance Hierarchy
SystemObject
  CTExtensions.InterfacesFileHandlerExtension

Namespace: CTExtensions.Interfaces
Assembly: CTInterface (in CTInterface.dll)
Syntax
public abstract class FileHandlerExtension : IExtensionInterface

The FileHandlerExtension type exposes the following members.

Methods
  NameDescription
Public methodBatchProcessAfterConversions
Called after Batch conversion has finished. Use as such: var fileMappings = poFileMappings.Cast<CTEngineLib.CTGeneric>().ToList(); var overriddenProperties = poOverridenProperties.Cast<CTEngineLib.CTGeneric>().ToList();
Public methodBeforeAddToPrintList
Pre notifies when a file is added to the print list
Public methodEnsureLocalDocument
Some operation is about to be using given document. FileHandler may ensure it exists.
Public methodFileSaveCompleted
Post notification for save events, when CT core has finished all operations.
Public methodFinalizeFilesInStructure
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.
Public methodGetParent
Must implement. Return parent CTExtension of this extension interface.
Public methodGetParentDrawings
Return filenames of drawings that reference to given filename and configuration.
Public methodGetParentModels
Return filenames of models that reference to given model and configuration.
Public methodImportSavedFile
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.
Public methodNotifyAddingToStructure
Notification when a component or a drawing is added to the structure
Public methodNotifyAddingToStructure2
Notification when a component or a drawing is added to the structure
Public methodNotifyPrintDocumentDeserialized
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.
Public methodNotifyPrintDocumentSerialized
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.
Public methodPreConvert
Called just before the document is converted into another format using given rule.
Public methodPrepareStructure
Prepare given filename/configuration for structure retrieval
Public methodPreSaveFile
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.
Public methodRequireStructureCalls
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.
Top
Availability

CUSTOMTOOLS 2019 SP0


See Also