Click or drag to resize

ExportItem Class

This represents an item that corresponds to one or more ExportDataRows and ListViewExRows in Export. This class handles the fact that the same Item might be present in Export structure in multiple parent contexts and thus changing an item field should reflect to all rows. While DataRows are always discarded and recreated between various states of the export, this object remains and get re-attached to new instances of ExportDataRows. This allows inheritant of this item object to retain values and state. If there are no DataRows attached at any given state, that means user has removed the row from Export and this object has become dangling, and thus should be ignored.
Inheritance Hierarchy
SystemObject
  CTExtensions.ExportCore.ExportHandlerExportItem

Namespace: CTExtensions.ExportCore.ExportHandler
Assembly: CTInterface (in CTInterface.dll) Version: 25.0
Syntax
public class ExportItem

The ExportItem type exposes the following members.

Constructors
 NameDescription
Public methodExportItem Constructor. Init(IGenericExportHandler, String) is called after.
Top
Properties
 NameDescription
Public propertyAllowInplaceEdits If column editing is enabled at GetAdditionalColumnsSetup2(IListViewEx, String, DictionaryString, Boolean, ListString, ListString) then this must be true to allow editing columns of this particular item. However, editing will not be enabled if also WritebackInplaceEdits is enabled but this item's writeback target is not in correct file access state. In SW, the file must not be readonly. In PDM client side, either we must have write access to NOTHING or we must have write access to the edited file. AllowInplaceEdits is false by default.
Public propertyAttachments Attachment rows of this item. The Item2 of the Tuple is top assembly configuration.
Public propertyCancelConversions Set this flag to true to cancel all conversions related to this item. Updates also checkbox state if ConversionCheckboxes feature is enabled.
Public propertyChildren Child items for this item.
Public propertyCollectedConversions Document Conversion collected during export procedure for this item.
Public propertyDataRows Datarows of this item. The Item2 of the Tuple is top assembly configuration.
Protected propertyExportHandler Export Handler. This should be an inheritant of GenericExportHandlerT, E, I but type is left loosely defined due to cascading generics.
Protected propertyExportProfile Currently Active Export Profile
Public propertyFields Export Profile Fields.
Public propertyID Unique identifier for this Item. This object is considered identical to another object of the same type, if IDs are equal.
Public propertyItemError 
Protected propertyParentExtension Parent Extension
Public propertyParents Parent items for this item. Empty for root item.
Public propertyPreview 
Public propertyRowColorController Color Controller for row/cell colors.
Public propertyUIRows UI Rows mapped to this item. Not available after deserialization.
Public propertyWritebackInplaceEdits If AllowInplaceEdits is enabled (and all its pre-requisities), editing a column automatically causes writeback.
Top
Methods
 NameDescription
Public methodAddGhostItemT 
Public methodBOMFieldChanged Has the BOM field value changed from original. Null and empty are considered the same.
Public methodCacheWriteBack Cache writeback value for given field.
Public methodCacheWriteBacks Adds given writebacks. Overwrites existing if same target already cached.
Public methodCollectDocumentConversion Add Collected conversion.
Public methodCreateWriteBacks Resolves writeback targets for given field. Value can be given optionally.
Public methodDeserialize Deserialize this item. All items are pre-initialized with their IDs and can be found from the collection given as an argument; i.e. those can be used to create the child/parent relation structure.
Public methodDissolve THIS IS NOT TESTED WELL
Public methodEquals
(Overrides ObjectEquals(Object))
Public methodExcludedFromAllParents Returns true if this item has zero quantity in all of its parents; or if is root item with zero quantity. Or if all grandparents are ExcludedFromAllParents -recursively.
Public methodFieldChanged Has the field value changed from original. Null and empty are considered the same.
Public methodGeneratePreview Generate preview if it doesn't exist yet. Returns existing preview unless forced.
Public methodGetBOMValue 
Public methodGetCachedWriteBacks 
Public methodGetHashCode
(Overrides ObjectGetHashCode)
Public methodGetMaterialQtyFields Get all export profile fields attached to Material Quantity.
Public methodGetMaterialQuantityIn 
Public methodGetQtyFields Get all export profile fields that are attached to Quantity
Public methodGetQuantityIn 
Public methodGetRightClickMenu 
Public methodGetValue 
Protected methodLog Do the Logging
Public methodPromote THIS IS NOT TESTED WELL
Public methodRemove Remove this item and this items children from the export.
Public methodRequiresWriteBack Return true if this item has cached writebacks
Public methodSerialize Serialize this item.
Public methodSetBOMValue 
Public methodSetQuantityIn 
Public methodSetValue 
Public methodToString
(Overrides ObjectToString)
Public methodValidateFieldConsistency 
Public methodValidateFieldConsistencyInParents 
Top
Revision History
DateVersionDescription
-2024 SP0First Release
-2025 SP0 Extended with AllowInplaceEdits and WritebackInplaceEdits that allow in-place editing and writebacks for item fields set to be editable in GetAdditionalColumnsSetup2(IListViewEx, String, DictionaryString, Boolean, ListString, ListString).
See Also