 | Generic |
The GenericExportHandlerT, E, I type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AllowInplaceWriteBack |
Returns whether or not inplace editing is allowed for an item. This considers
different launch cases for Export: - From SOLIDWORKS -> Must have write access - From PDM -> All must be checked in (writeback handled at Task Host) OR The one being edited must be checked out (writeback handled locally). - Silent Export -> Never allowed as user interaction doesn't make sense in that case Note that this PDM-logic can conflict with what ERP integrations do: Either ALL files must be checked-in or NONE of them (than need writeback) must be checked-in. |
 | CancelConversionsFromUnaffectedItems | Checks if items are affected by currently set conversion rules, and if not, set cancelled flag. |
| CheckBOMModifierValueMatch |
Returns whether or not given field (or parent field) value matches given pattern.
This supports exact value (case-insensitive), starts with, ends with, contains and NOT versions for all of those. For starts-with, use asterisk (*) as wildcard at the end of the value, for ends-with at the beginning and for contains at both. For NOT, start the value with exclamation (!). To base the rule on PARENT's value, start with accent (^). Furhermore, you can do OR -rules using pipe (|) in between. Wildcard alone (*) is "must have non-empty value". Null or whitespace only is ignored. To achieve "must have empty value", use negation of "must have non-empty value" i.e. '!*'. Value comparison is case-insensitive. |
| CheckWritebackAccessInPrefill | |
| DeserializeSecondPhase | Deserialize this object and its items. |
| DiscardExcludedFromBOMItems | This function discards all excluded from BOM components from items. It's called after UpdateItemsPreFilling(ListE) but before UpdateItemsPostFilling(ListE). It's safe to call also during overridden implementation of UpdateItemsPreFilling(ListE) in case excluded from BOM components can be completely discarded by the implementation. |
| Export | 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. |
| FinalizeSecondPhase | |
| GetAdditionalColumnsSetup | Allows injecting new columns to export and hiding existing ones. |
| GetAdditionalColumnsSetup2 | Allows defining Editable columns in List view. |
| GetExportProfile | Getter for current export profile. |
| GetItemizer | Getter for loosly typed Itemizer, mostly for internal puposes. |
| GetParent | Getter for Parent Extension, mostly for internal puposes. |
| GetRoots | Get all non-excluded root items from the last itemized structure. |
| Hook |
Event subscribtions, called by the framework if T is
inheritant of ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE and
this extension is provided with GetEventExtensions.
If this event extension is used directly, then also Hook(CTInterface) must be called manually at T's implementation of Hook(CTInterface).
(Overrides EventExtensionHook(CTInterface)) |
| Init |
Initialization, called by the framework if T is
inheritant of ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE and
this extension is provided with GetEventExtensions.
If this event extension is used directly, then also Init(T) must be called immediately after this class is instantiated.
(Overrides EventExtensionEXTTYPEInit(EXTTYPE)) |
| InitExport | 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. |
| Log | Log everything that happends. |
| ManipulateExportDataBeforeItemization | 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. |
| NeedsSecondsPhase | 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. |
| OnCloseCustomStructureDlg | Resets this class by calling InitExport(ICTExportProfile, Boolean, Boolean, Int64, Int32) with nulls and defaults. |
| OnPostFileConversion | |
| OnQueryCancelExportConversions | |
| PerformWritebacksWithCheckoutAndCheckin | 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. |
| PreExport | This function is called immediately before Export(ListE) to give arguments provided by the framework and Export Profile settings. |
| QueryExportSuccess | |
| RefreshItems | |
| RefreshItems(ListE) | |
| SecondPhaseExport | 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. |
| SecondPhaseInitialized | 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. |
| SerializeForSecondPhase | Serialize this object and its Items. |
| ShowExportDoneMessage | |
| ShowProcessContinuesToSecondPhaseMessage | |
| UnHook |
Event unsubscribtions, called by the framework if T is
inheritant of ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE and
this extension is provided with GetEventExtensions.
If this event extension is used directly, then also UnHook(CTInterface) must be called manually at T's implementation of UnHook(CTInterface).
(Overrides EventExtensionUnHook(CTInterface)) |
| UpdateItemsPostFilling | 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. |
| UpdateItemsPreFilling | 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. |
| VerifyFieldHandler |
See Also