CTInterface Class |
Namespace: ATR.CT.CTInterface
The CTInterface type exposes the following members.
Name | Description | |
---|---|---|
ActiveDatabase |
Currently active database of CUSTOMTOOLS.
| |
SldWorksInstance |
Currently running SOLIDWORKS instance (SldWorks).
|
Name | Description | |
---|---|---|
GetSWDocManager |
Get licensed instance of SOLIDWORKS Document Manager.
Instance is available only if CTInterface has been initialized by CUSTOMTOOLS.
| |
GetXMLData |
When OnSaveToStoragePre is invoked (during document save-operation),
this function can be used to retrieve current CustomScope data in XML.
Modified data can be sent back for CUSTOMTOOLS with SetXMLData using the same key.
| |
SetXMLData |
When OnSaveToStoragePre is invoked (during document save-operation),
this function can be used to manipulate CustomScope data in XML.
Data that CUSTOMTOOLS was about to store can be accessed with GetXMLData using the same key.
|
Name | Description | |
---|---|---|
NotifyDialogAccess |
Notifies when user opens and close defined CT dialog.
| |
NotifyIdle |
Notifies SW idle both pre CT handling and post CT handling
Value determines whether this is
pre-event (true) or post-event (false).
| |
OnAddImportFile |
Invoked at CUSTOMTOOLS Import for each individual file inserted to the list.
Allows full control on what files are actually brought into the process.
For instance it would be possible to unzip given file and add all unpacked files
to the list via this event.
| |
OnAfterButtonFunction |
Notification is sent after user has clicked a button representing a button function that is
associated with a property in CUSTOMTOOLS Properties pane.
Event is triggered when user has closed the dialog box associated with the button function.
| |
OnAppExit |
Notification that occurs when CUSTOMTOOLS is being unloaded.
Can be used for instance to safely terminate asynchronous
background tasks started by the script add-in.
| |
OnChangeCustomProperty |
Post-notifies when a customer property has been changed.
| |
OnCloseCustomStructureDlg |
Notification that occurs when user exits CUSTOMTOOLS Export window.
| |
OnCustomCopyPreSavePropertyValue |
Invoked at CUSTOMTOOLS Copy during the copy process, before the dirty properties are written.
Allows manipulating values of dirty properties.
| |
OnCustomCopyResolveInitialConfiguration |
Invoked during CUSTOMTOOLS Copy process for all individual files
when Configuration option at Properties is set to Property Specific.
Allows setting configuration option per file.
| |
OnCustomListUpdate |
Invoked for each Custom-type lookuplist at CUSTOMTOOLS start up and
when 'Run' is clicked at Options for the Custom-type lookuplist in question.
Allows full control over the lookuplist content.
| |
OnCustomPropertiesFinished |
Invoked after user exits CUSTOMTOOLS Properties with Ok/Apply and all
related processes have completed.
| |
OnCustomPropertiesLoaded |
Invoked when CUSTOMTOOLS Properties are loaded.
| |
OnCustomPropertiesLoading |
Invoked when CUSTOMTOOLS Properties are loading.
| |
OnCustomPropertyChanged |
Invoked at CUSTOMTOOLS Properties when a value of a property that has Allow Scripting -option set changes.
Allows manipulating all property values in context that have Allow Scripting -option set.
| |
OnExecuteSearchGroupSearch |
Invoked for Search Group searches that are defined to use Custom Handler.
Allows full control over the returned Search Group data.
| |
OnExportProfileSelected |
Notification that is sent after user selects Export profile in the CUSTOMTOOLS Export dialog box. This notification
is sent also when the Export dialog is opened and the last used Export profile is selected automatically.
| |
OnFileSavePre |
Invoked when a SOLIDWORKS document is being saved.
| |
OnGetCustomImportRule |
Invoked at CUSTOMTOOLS Import for each file right after they are added to the list.
Allows showing custom columns, setting special import options, displaying different string
than filename and disabling the row from process.
| |
OnGetImportFiletypeFilters |
Invoked at CUSTOMTOOLS Import when user adds file/files to the list. Allows adding
new file name/extension filters to the file selection dialog.
| |
OnImportFile |
Notification triggered before importing a file.
| |
OnImportFilePost |
Invoked at CUSTOMTOOLS Import for each individual file right after one's import process is complete.
| |
OnImportFilePre |
Invoked at CUSTOMTOOLS Import for each file defined in OnGetCustomImportRule before
the normal import procedure takes place.
| |
OnImportFinished |
Notification the is send then CUSTOMTOOLS Import procedure has finished.
| |
OnItemDeletePre |
Invoked when a feature is deleted from model's feature tree.
| |
OnListViewExportRowRightClick |
Invoked at CUSTOMTOOLS Export when user right clicks a row.
Allows appending menu items which click events can be handled at OnPopupMenuChosen.
| |
OnLookupListFill |
Invoked when CUSTOMTOOLS fills up Lookuplist items for Hierarchical Combo.
With this event it's possible to use value/key as saved value while
displaying a different corresponding value/key in the GUI.
| |
OnModelDocLoaded |
Invoked when a SOLIDWORKS document has been loaded.
| |
OnOptionsClosedNotify |
Notifies when user exits CUSTOMTOOLS Options with OK.
Invoked only when Options is accessed via SOLIDWORKS, and NOT from CUSTOMTOOLS Administration.
| |
OnPopupMenuChosen |
Invoked at CUSTOMTOOLS Export when user has right clicked a row and then selected popped up menu item
defined at OnListViewExportRowRightClick.
| |
OnPostFileConversion |
Invoked after CUSTOMTOOLS has performed file conversion.
| |
OnPreBatchProcessFile |
Invoked before CUSTOMTOOLS starts to perform file conversion.
| |
OnPreFileConversion |
Invoked before CUSTOMTOOLS performs file conversion task.
| |
OnPreFillCopyFileTargets |
Invoked at CUSTOMTOOLS Copy when filenames are generated.
Allows manipulating target filenames, target project per file and check state of the row.
| |
OnPropertiesVisibilityOverride |
Invoked when CUSTOMTOOLS Properties is first initialized and shown for a document.
Allows changing visibility and selected value/option of special controls.
| |
OnPropertyCustomDefinition |
Invoked at CUSTOMTOOLS Options when user click Custom Definition button [...] at property's
Advanced Options -page. Invoked only when Options is accessed via SOLIDWORKS, and NOT from
CUSTOMTOOLS Administration.
| |
OnQueryCancelExportConversions |
Invoked at CUSTOMTOOLS Export before possible conversions are performed for each row in internal export data structure.
Allows cancelling conversions before need for them is even validated.
| |
OnRequestScriptButton |
Invoked at CUSTOMTOOLS startup. Allows one script add-in to set up an extra button
to CUSTOMTOOLS menu. Availability of the button is queried with OnRequestScriptButtonEnable
and it's click event at OnScriptButtonClicked.
| |
OnRequestScriptButtonEnable |
Invoked multiple times at various cases. Allows setting availablity of the script button
defined with OnRequestScriptButton.
| |
OnSavePost |
Invoked after a SOLIDWORKS document has been saved.
| |
OnSaveToStoragePost |
Invoked after 3rdPartyData is saved to the model.
| |
OnSaveToStoragePre |
Invoked before 3rdPartyData is saved to the model.
Use GetXMLData(String) and SetXMLData(String, String) to manipulate save content.
| |
OnScriptButtonClicked |
Notification that is send when user has clicked the script button
defined with OnRequestScriptButton.
| |
OnStrExport |
Invoked at CUSTOMTOOLS Export when the xml data is ready but before it's saved as a file.
| |
OnStrExportAddRow |
Invoked at CUSTOMTOOLS Export for each row when the list is getting filled.
Allows filling/changing column values.
| |
OnStrExportFillColumns |
Invoked at CUSTOMTOOLS Export before model structure is filled to the view.
Allows hiding/adding of columns in the view.
| |
OnStrExportFillListPost |
Invoked at CUSTOMTOOLS Export after the model structure and values are filled into the Export view.
Allows setting errors for rows.
| |
OnStrExportFillListPre |
Invoked at CUSTOMTOOLS Export before model structure is filled to the view.
Allows manipulating the structure before it's shown.
| |
OnStrExportPost |
Invoked at CUSTOMTOOLS Export when the export procedure has finished and the xml data is saved as a file.
| |
OnStrExportPre |
Notification that occurs at CUSTOMTOOLS Export when user clicks export but before actual procedure is ran.
| |
OnStrExportVerifyField |
Invoked at CUSTOMTOOLS Export for each row and each field in the view.
Allows checking the field value and setting an error message that prevents
user for performing the export.
| |
OnValidateCustomProperties |
Invoked at CUSTOMTOOLS Properties when user clicks Ok/Apply and at least one property has Allow Scripting -option set.
Allows manipulating property values, preventing exiting of Properties and displaying an error/warning message.
|