Click or drag to resize

GenericExportHandlerT, E, I Methods

The GenericExportHandlerT, E, I generic type exposes the following members.

Methods
  NameDescription
Protected methodCancelConversionsFromUnaffectedItems
Checks if items are affected by currently set conversion rules, and if not, set cancelled flag.
Protected methodCheckWritebackAccessInPrefill
Protected methodDeserializeSecondPhase
Deserialize this object and its items.
Protected methodDiscardExcludedFromBOMItems
Protected methodExport
User has clicked the Export button, and the items are prepared for the export. Remember to check the export case using CurrentExportCase and if SilentMode is set.
Protected methodFinalizeSecondPhase
Protected methodGetAdditionalColumnsSetup
Protected methodGetAdditionalColumnsSetup2
Public methodGetExportProfile
Getter for current export profile.
Public methodGetItemizer
Getter for loosly typed Itemizer, mostly for internal puposes.
Public methodGetParent
Getter for Parent Extension, mostly for internal puposes.
Public methodGetRoots
Get all non-excluded root items from the last itemized structure.
Public methodHook (Overrides EventExtensionHook(CTInterface).)
Public methodInit (Overrides EventExtension.Init``1(UMP).)
Protected methodInitExport
Initialization of this class for Export procedure, or to disable or handling; depending if the typename of the given export profile matches the indentifying name of the parent extension.
Public methodLog
Log everything that happends.
Protected methodManipulateExportDataBeforeItemization
Override this function to do anything you like for the data before it's being itemized. Note that this is invoked for all exported configurations separately.
Protected methodNeedsSecondsPhase
Indicates is second phase is required or not. By default it IS needed if we are outside SW context, the first phase succeeded and any of the items has cached writebacks or has not cancelled its conversions.
Protected methodOnCloseCustomStructureDlg
Resets this class by calling InitExport(ICTExportProfile, Boolean, Boolean, Int64, Int32) with nulls and defaults.
Protected methodOnPostFileConversion
Protected methodOnQueryCancelExportConversions
Protected methodPerformWritebacksWithCheckoutAndCheckin
Collects all cached writeback requests from the items, requests write access to each individual file (causes check-out in PDM), applies the writebacks, and then releases the obtained write accesses (causes check-in to PDM) and clears cached writebacks.
Protected methodQueryExportSuccess
Public methodRefreshItems
Protected methodRefreshItems(ListE)
Protected methodSecondPhaseExport
This function is called during the second phase Export. At this point all conversions are done and collected, and writebacks are already done to files. This is mostly desined for sending converted documents to the target system, however, it is also possible to handle the whole Export Process silently within this function. To write addtitional writebacks to files, call PerformWritebacksWithCheckoutAndCheckin(ListE) after caching the writebacks to items. Note that PerformWritebacksWithCheckoutAndCheckin(ListE) is already called once during SecondPhaseInitialized(ListE) so if there were writebacks added at the first export phase, some items might get multiple versions checked-in. You can override SecondPhaseInitialized(ListE) to not call ///
Protected methodSecondPhaseInitialized
Called after deserialization is done and this class and all items have all data available. Calls PerformWritebacksWithCheckoutAndCheckin(ListE) to write pending value writebacks as the conversions are performed after this and it might be important to have updated values visible in converted documents.
Protected methodSerializeForSecondPhase
Serialize this object and its Items.
Protected methodShowExportDoneMessage
Protected methodShowProcessContinuesToSecondPhaseMessage
Public methodUnHook (Overrides EventExtensionUnHook(CTInterface).)
Protected methodUpdateItemsPostFilling
All the same operations should be doable in UpdateItemsPreFilling(ListE), which recommended over this function. If there for some reason is a need to directly manipulate ListView rows, it can be done here.
Protected methodUpdateItemsPreFilling
Do possible queries to target systems to map the items etc. Supports setting field and bom field values, colors and everything even before the actual list view items are added to the list.
Protected methodVerifyFieldHandler
Top
See Also