Hide Table of Contents
SOLIDWORKS Electrical API  2021.0.0
Electrical API
EwProjectObjects.idl
Go to the documentation of this file.
1 #pragma once
2 
3 #if (__midl >= 501)
4 midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
5 #endif
6 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 
10 import "EnumDefinition.idl";
11 import "EwProjectRoutingObjects.idl";
12 import "EwProjectComponentObjects.idl";
13 import "EwProjectManufacturerPartObjects.idl";
14 import "EwProjectLocationObjects.idl";
15 import "EwProjectWireObjects.idl";
16 import "EwProjectCableObjects.idl";
17 import "EwProjectEntity3DObjects.idl";
18 import "EwProjectHarnessObjects.idl";
19 import "EwProjectExportObjects.idl";
20 import "EwProjectProcessObjects.idl";
21 import "EwProjectInputOutputObjects.idl";
22 
23 
24 /************************************************************************/
25 /* In his file, all PROJECT object */
26 /************************************************************************/
27 
28 
29 /************************************************************************/
30 /* ENUMERATION */
31 /************************************************************************/
32 
33 /************************************************************************/
34 /* INTERFACES */
35 /************************************************************************/
36 
38 
42 [
43  object,
44  uuid(B13AD024-81E0-41C8-ADCA-518E347AAAE9),
45  dual,
46  oleautomation,
47  nonextensible,
48  helpstring("IEwProjectSymbolX Interface"),
49  pointer_default(unique)
50 ]
52 {
60  long getFileID (EwErrorCode* errorCode);
61 
62 
71  long getLocationID (EwErrorCode* errorCode);
72 
73 
74 
83  long getFunctionID (EwErrorCode* errorCode);
84 
85 
93  BSTR getEwSymbolName (EwErrorCode* errorCode);
94 
95 
103  EwErrorCode setEwSymbolName (BSTR strSymbolName);
104 
105 
114  long getObjectID (EwErrorCode* errorCode);
115 
116 
126 
127 
136 
137 
146 
147 
156 
157 
166 
167 
175  BSTR getAssociatedMacro (EwErrorCode* errorCode);
176 
177 
185  double getXPosition (EwErrorCode* errorCode);
186 
187 
195  EwErrorCode setXPosition (double dXCoordinate);
196 
197 
205  double getYPosition (EwErrorCode* errorCode);
206 
207 
215  EwErrorCode setYPosition (double dYCoordinate);
216 
217 
226 
227 
235  BSTR getColumnMark (EwErrorCode* errorCode);
236 
237 
245  BSTR getRowMark (EwErrorCode* errorCode);
246 
247 
248 
257  double getRotationAngle (EwErrorCode* errorCode);
258 
259 
268  EwErrorCode setRotationAngle (double dAngle);
269 
270 
278  EwErrorCode setYScale (double dYScale);
279 
280 
288  double getYScale (EwErrorCode* errorCode);
289 
290 
298  double getXScale (EwErrorCode* errorCode);
299 
300 
308  EwErrorCode setXScale (double dXScale);
309 
310 };
311 
312 
317 [
318  object,
319  uuid(06DD51E2-79F7-4148-9F53-02932E9A2D44),
320  dual,
321  oleautomation,
322  nonextensible,
323  pointer_default(unique)
324 ]
325 interface IEwProjectSymbolManagerX : IDispatch
326 {
336 
337 };
338 //\endcond
339 
340 
345 [
346  object,
347  uuid(4ac92b54-1043-11e5-9493-1697f925ec7b),
348  dual,
349  oleautomation,
350  nonextensible,
351  helpstring("IEwProjectFileX Interface"),
352  pointer_default(unique)
353 ]
355 {
356 
368 
369 
370 
380  BSTR getFilePath (EwErrorCode* errorCode);
381 
382 
392 
393 
403 
404 
409 
410 
421  LONG getPosition (EwErrorCode* errorCode);
422 
423 
424 
425 
426 
437  LONG getEwProjectBookID (EwErrorCode* errorCode);
438 
439 
452 
453 
470 
471 
488 
489 
490 
501  VARIANT_BOOL isOpen (EwErrorCode* errorCode);
502 
503 
515 
516 
528 
529 
542 
543 
560  EwErrorCode setOriginalFilePath (BSTR strFilePath, VARIANT_BOOL bAsShortCut);
561 
562 
574  BSTR getTargetFilePath (EwErrorCode* errorCode);
575 
576 
587  VARIANT_BOOL isLockByMe (EwErrorCode* errorCode);
588 
589 
600  VARIANT_BOOL isLockedByAnother (EwErrorCode* errorCode);
601 
602 
603 };
604 
609 [
610  object,
611  uuid(5C9A9148-129E-4FCC-AE6A-842C0F78C736),
612  dual,
613  nonextensible,
614  helpstring("IEwProjectBookX Interface"),
615  pointer_default(unique)
616 ]
618 {
619 
620 };
621 
626 [
627  object,
628  uuid(743809C9-28AA-409F-B8F3-50907C2B68EC),
629  dual,
630  nonextensible,
631  helpstring("IEwProjectFunctionX Interface"),
632  pointer_default(unique)
633 ]
635 {
643  BSTR getTagPath (EwErrorCode* errorCode);
644 
645 
646 };
647 
648 
653 [
654  object,
655  uuid(BEBE7B8F-F07A-4F7B-B931-B206E6587E76),
656  dual,
657  oleautomation,
658  nonextensible,
659  helpstring("IEwProjectFileManagerX Interface"),
660  pointer_default(unique)
661 ]
662 interface IEwProjectFileManagerX : IDispatch {
663 
671  INT_PTR getCount (EwErrorCode* errorCode);
672 
673 
681  VARIANT getEwProjectFileArray (EwErrorCode* errorCode);
682 
683 
693  IEwProjectFileX findEwProjectFileByID (LONG lEwProjectFileID, EwErrorCode* errorCode);
694 
695 
706  IEwProjectFileX findEwProjectFileFromPath (BSTR strFilePath, EwErrorCode* errorCode);
707 
708 
719 
720 
732 
733 };
734 
739 [
740  object,
741  uuid(4227D81E-E027-43CF-89C4-D877A885BBB1),
742  dual,
743  oleautomation,
744  nonextensible,
745  helpstring("IEwProjectConfigurationX Interface"),
746  pointer_default(unique)
747 ]
749 {
750 
751  /*
752  * Get the name of the title block associated with a cabinet layout
753  * \return Title block name
754  */
756 
757 
758  /*
759  * Get the used measuremnt type
760  * \param[out] errorCode EwErrorCode enum type, can be:
761  * \li EW_NO_ERROR if no error detected
762  * \li EW_UNDEFINED_ERROR if another error occurred
763  * \return Measurement type
764  */
766 
767 
768  /*
769  * Get the current language code
770  * \param[out] errorCode EwErrorCode enum type, can be:
771  * \li EW_NO_ERROR if no error detected
772  * \li EW_UNDEFINED_ERROR if another error occurred
773  * \return Language code
774  */
776 
777 
778  /*
779  * Set a project configuration value
780  * \param[in] eProjectConfigurationValues The project configuration property you want to apply
781  * \param[in] vValue The value you want to apply
782  * \return EwErrorCode enum type, can be:
783  * \li EW_NO_ERROR if no error detected
784  * \li EW_UNDEFINED_ERROR if another error occurred
785  */
786  EwErrorCode setEwProjectConfigValue (EwProjectConfigValue eProjectConfigurationValues, VARIANT vValue);
787 
788 
789 
790  /*
791  * Get a project configuration value
792  * \param[in] eProjectConfigurationValues The project configuration property you want to get
793  * \param[out] errorCode EwErrorCode enum type, can be:
794  * \li EW_NO_ERROR if no error detected
795  * \li EW_UNDEFINED_ERROR if another error occurred
796  * \li EW_BAD_INPUTS if the project configurations values does not exist
797  * \return project configuration value
798  */
799  VARIANT getEwProjectConfigValue (EwProjectConfigValue eProjectConfigurationValues, EwErrorCode* errorCode);
800 
801 
802 };
803 
808 [
809  object,
810  uuid(F984331D-9550-492C-9804-C43D9A173CA1),
811  dual,
812  nonextensible,
813  pointer_default(unique)
814 ]
815 interface IEwProjectBookManagerX : IDispatch
816 {
817 
825  INT_PTR getCount (EwErrorCode* errorCode);
826 
827 
835  VARIANT getEwProjectBookArray (EwErrorCode* errorCode);
836 
837 
847  IEwProjectBookX findEwProjectBookByID (LONG lEwProjectBookID, EwErrorCode* errorCode);
848 
849 
858 
859 };
860 
865 [
866  object,
867  uuid(41B046AD-FD19-4184-B6E7-A67E80FFD48F),
868  dual,
869  nonextensible,
870  pointer_default(unique)
871 ]
872 interface IEwProjectFunctionManagerX : IDispatch
873 {
881  INT_PTR getCount (EwErrorCode* errorCode);
882 
883 
892 
893 
903  IEwProjectFunctionX findEwProjectFunctionByID (LONG lEwProjectFunctionID, EwErrorCode* errorCode);
904 
905 
914 
915 };
916 
917 
922 [
923  object,
924  uuid(10D11ED8-FB45-4A3E-ADF6-DC349B4ECBFF),
925  dual,
926  nonextensible,
927  helpstring("IEwProjectFolder Interface"),
928  pointer_default(unique)
929 ]
931 {
932 
940  LONG getEwProjectBookID (EwErrorCode* errorCode);
941 
942 
943 
953 
954 
964 
965 
976 
977 
987 
988 
999 
1000 
1008  VARIANT_BOOL getDefineFirstDrawingNumber (EwErrorCode* errorCode);
1009 
1010 
1018  EwErrorCode setDefineFirstDrawingNumber (VARIANT_BOOL bDefineFirstDrawingNumber);
1019 
1020 
1028  LONG getPosition (EwErrorCode* errorCode);
1029 
1030 
1031 };
1032 
1033 
1038 [
1039  object,
1040  uuid(85158F93-1205-4614-ABC3-F3F19F9EDCDD),
1041  dual,
1042  nonextensible,
1043  pointer_default(unique)
1044 ]
1045 interface IEwProjectFolderManagerX : IDispatch
1046 {
1054  INT_PTR getCount (EwErrorCode* errorCode);
1055 
1056 
1064  VARIANT getEwProjectFolderArray (EwErrorCode* errorCode);
1065 
1066 
1076  IEwProjectFolderX findEwProjectFolderByID (LONG lEwProjectFolderID, EwErrorCode* errorCode);
1077 
1078 
1087 
1088 };
1089 
1090 
1095 [
1096  object,
1097  uuid(9442A4C0-D96C-4AAE-B679-C76877753635),
1098  dual,
1099  oleautomation,
1100  nonextensible,
1101  helpstring("IEwProjectX Interface"),
1102  pointer_default(unique)
1103 ]
1104 interface IEwProjectX : IDispatch {
1105 
1106 
1107 
1108 
1113  BSTR getCreoFolderPath (EwErrorCode* errorCode);
1114 
1115 
1125 
1126 
1136 
1137 
1147 
1148 
1157  IEwRoutingDataX getEwRoutingData (EwErrorCode* errorCode);
1158 
1159 
1169 
1170 
1180 
1181 
1191 
1192 
1193  /*
1194  * \return Get the ID of the project. -1 if the object is invalid
1195  */
1196  LONG getID ();
1197 
1198 
1207  EwErrorCode setName (BSTR strValue);
1208 
1209 
1218  BSTR getName (EwErrorCode* errorCode);
1219 
1220 
1229  EwErrorCode setCustomerName (BSTR strValue);
1230 
1231 
1240  BSTR getCustomerName (EwErrorCode* errorCode);
1241 
1242 
1252 
1253 
1263 
1264 
1274 
1275 
1285 
1286 
1296 
1297 
1307 
1308 
1318 
1319 
1329 
1330 
1340 
1341 
1351 
1352 
1362 
1363 
1373 
1374 
1383 
1384 
1394 
1395 
1405 
1406 
1415  BSTR getContractNumber (EwErrorCode* errorCode);
1416 
1417 
1418  /*
1419  * Update the object properties. If one of the properties has been modified, you must call this method to apply this modification.
1420  * Project must be opened to be able to call this method
1421  * \return EwErrorCode enum type, can be:
1422  * \li EW_UNDEFINED_ERROR default Error
1423  * \li EW_NO_ERROR if no error detected
1424  * \li EW_PROJECT_NOTOPENED Project not opened
1425  */
1427 
1428 
1439  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
1440 
1441 
1452  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
1453 
1454 
1467  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
1468 
1469 
1481  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
1482 
1483 
1493 
1494 
1504 
1505 
1515 
1516 
1526  VARIANT getMacroVariables (EwErrorCode* errorCode);
1527 
1528 
1538 
1539 
1548 
1549 
1550  /*
1551  * Remove the project. Project will be closed and mustn't be opened by someone else if you are using client and server installation.
1552  * \return EwErrorCode enum type, can be:
1553  * \li EW_NO_ERROR if no error detected
1554  * \li EW_UNDEFINED_ERROR if another error occurred
1555  * \li EW_CANNOT_CLOSE_PROJECT if project cannot be closed
1556  * \li EW_CANNOT_REMOVE if project cannot be removed
1557  * \li EW_NO_PROJECT_OPENED_BY_SOMEONE_ELSE if project is opened on another computer by someone else
1558  * \li EW_CANNOT_DROP_DATABASE if project database cannot be dropped. This can happen if the SQL Server Database cannot be deleted because it's opened by another process.
1559  * \li EW_CANNOT_DELETE_FOLDER if project folder cannot be deleted. This can happen if you don't have rights to delete the project folder.
1560  * \li EW_DATABASE_CONNECTION_ERROR if connection to project database cannot be opened. You need to check the query log to investigate the reason.
1561  * \li EW_PROJECT_NOTOPENED: project are close.
1562  */
1563  EwErrorCode remove ();
1564 
1565 
1574 
1575 
1584 
1585 
1586 
1596 
1597 
1598 
1608 
1609 
1618 
1619 
1627  EwErrorCode setExternID (BSTR strValue);
1628 
1629 
1637  BSTR getExternID (EwErrorCode* errorCode);
1638 
1639 
1649 
1650 
1660 
1661 
1670 
1671 
1682 
1683 
1694  BSTR getFolderPath (EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode* errorCode);
1695 
1696 
1707 
1708 
1719 
1720 
1731 
1732 
1743 
1744 
1755 
1756 
1767 
1768 
1779 
1780 
1791 
1792 
1801  BSTR getModifiedBy (EwErrorCode* eErrorCode);
1802 
1803 
1812 
1813 
1822 
1823 
1832  BSTR getCreatedBy (EwErrorCode* eErrorCode);
1833 
1834 
1845 
1846 
1847 };
1848 
1853 [
1854  object,
1855  uuid(9A02A344-94BB-4F95-A133-45E09A42D6C5),
1856  dual,
1857  oleautomation,
1858  nonextensible,
1859  helpstring("IEwProjectManagerX Interface"),
1860  pointer_default(unique)
1861 ]
1862 interface IEwProjectManagerX : IDispatch {
1863 
1867  LONG getCount ();
1868 
1869 
1879  VARIANT getEwProjectArray (EwErrorCode* errorCode);
1880 
1881 
1891 
1892 
1901  IEwProjectX findEwProjectByName (BSTR strName, EwErrorCode* errorCode);
1902 
1903 
1915  EwErrorCode archive (VARIANT vProjectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies);
1916 
1917 
1928  VARIANT unarchive (BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode* errorCode);
1929 
1930 
1942  IEwProjectX findProjectFromFilePath (BSTR strFilePath, EwErrorCode* errorCode);
1943 
1944 
1954  VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode* errorCode);
1955 
1956 
1966  EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings);
1967 
1968 }
1969 
1971 [
1972  uuid(9fd7cb1e-5e41-4e5b-91c4-825a6494819a),
1973  helpstring("Event interface for EwProjectX")
1974 ]
1975 dispinterface _DIEwProjectXEvents
1976 {
1977  properties:
1978  // Event interface has no properties
1979 
1980  methods:
1981  // NOTE - ClassWizard will maintain event information here.
1982  // Use extreme caution when editing this section.
1991  void addItemNotify (IDispatch * IEwObjectX);
1992 
1999  void deleteItemNotify (IDispatch* IEwObjectX);
2000 
2007  void updateItemNotity (IDispatch* IEwObjectX);
2008 
2009 };
2010 
2011 
BSTR getFolderPath(EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode *errorCode)
Return folder path associated to the current project.
LONG getPosition(EwErrorCode *errorCode)
Get the position of files inside a book/folder.
EwOpenProjectMode
All possible open modes for a project.
Definition: EwEnumeration.idl:443
EwErrorCode setGenerateAutomatedDrawings(VARIANT_BOOL bGenerateAutomatedDrawings)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
EwErrorCode unlock()
Unlock the file.
EwErrorCode setObjectID(long lID)
Sets the Object associated with the symbol.
VARIANT getEwProjectFileArray(EwErrorCode *errorCode)
Return the array of IEwProjectFile of associated project.
IEwProjectFolderX newEwProjectFolder(EwErrorCode *errorCode)
Create a IEwProjectFolderX object from the associated project.
IEwProjectFunctionManagerX getEwProjectFunctionManager(EwErrorCode *errorCode)
Get an IEwProjectFunctionManagerX to manage Functions of this project.
Definition: EwProjectObjects.idl:1976
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:429
BSTR getCustomerName(EwErrorCode *errorCode)
Get the name of the customer of the project.
double getXScale(EwErrorCode *errorCode)
Return the X scale of the symbol.
IEwProjectBookManagerX getEwProjectBookManager(EwErrorCode *errorCode)
Get an IEwProjectBookManagerX to manage Books of this project.
long getObjectID(EwErrorCode *errorCode)
Return the Object ID associated with the symbol.
EwFileType
File types used in a project.
Definition: EwEnumeration.idl:361
Generic interface for an object that belongs to a project.
Definition: EwObjectBase.idl:76
EwErrorCode setRotationAngle(double dAngle)
Set the rotation angle in degrees of the symbol.
Use this interface to manage IEwProjectX objects.
Definition: EwProjectObjects.idl:1862
EwProjectConfigValue
Values for project configuration.
Definition: EwEnumeration.idl:106
long getFileID(EwErrorCode *errorCode)
Return the file ID containing the symbol.
EwErrorCode setEwProjectFolderID(LONG lID)
Set the folder ID as parent for this file.
BSTR getCurrentCodeLanguage(EwErrorCode *errorCode)
BSTR getAssociatedMacro(EwErrorCode *errorCode)
Return the associated macro of the symbol.
LONG getEwProjectFolderID(EwErrorCode *errorCode)
Get the ID of the folder containing this file.
Use this interface to manage IEwProjectManufacturerPartX objects.
Definition: EwProjectManufacturerPartObjects.idl:430
Use this interface to manage the export reports used inside the project.
Definition: EwProjectExportObjects.idl:947
long getLocationID(EwErrorCode *errorCode)
Return the Location ID of the symbol.
EwErrorCode setFirstDrawingNumber(LONG lID)
Set the number of the first drawing that will be created in this folder.
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
Use this interface to manage export DWG files inside a project.
Definition: EwProjectExportObjects.idl:610
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of Folders of associated project.
IEwProjectX findEwProjectByName(BSTR strName, EwErrorCode *errorCode)
Look for the first project from a name.
Use this interface to manage the update of project data from libraries.
Definition: EwProjectProcessObjects.idl:242
EwErrorCode setEwProjectBookID(LONG lID)
Update the ID of the book containing this folder.
EwErrorCode close()
close the project
IEwProjectHarnessManagerX getEwProjectHarnessManager(EwErrorCode *errorCode)
Get an IEwProjectHarnessManagerX to manage Harness of this project.
Use this interface to manage IEwProjectInputOutputX objects.
Definition: EwProjectInputOutputObjects.idl:229
IEwProjectBookX newEwProjectBook(EwErrorCode *errorCode)
Create a IEwProjectBookX object from the associated project.
IEwProjectLocationX getEwProjectLocation(EwErrorCode *errorCode)
IEwProjectLocationX associated with the file.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of Functions of associated project.
Use this interface to manage for reports used inside the project.
Definition: EwProjectExportObjects.idl:877
EwErrorCode setEwProjectConfigValue(EwProjectConfigValue eProjectConfigurationValues, VARIANT vValue)
BSTR getCustomerAddress1(EwErrorCode *errorCode)
Get the customer address 1 of the project.
BSTR getCreoFolderPath(EwErrorCode *errorCode)
Return Creo folder path where Creo files are stored.
EwErrorCode setYScale(double dYScale)
Sets the Y scale of the symbol.
Use this interface to manage a print configuration manager inside a project.
Definition: EwProjectExportObjects.idl:465
LONG getEwProjectFolderID(EwErrorCode *errorCode)
Get the ID of the folder containing this folder.
IEwProjectComponentManagerX getEwProjectComponentManager(EwErrorCode *errorCode)
Get an IEwProjectComponentManagerX to manage components of this project.
IEwProjectUpdateReplaceDataX getEwProjectUpdateData(EwErrorCode *errorCode)
Get an IEwProjectUpdateReplaceDataX to manage the update or replacedata of this project.
BSTR getCustomerAddress2(EwErrorCode *errorCode)
Get the customer address 2 of the project.
double getRotationAngle(EwErrorCode *errorCode)
Return the rotation angle in degrees of the symbol.
EwSymbolCrossRefType getEwSymbolCrossRefType(EwErrorCode *errorCode)
Return the cross reference type of the symbol.
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object Project must be opened to be able to call this method.
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:259
EwErrorCode setDrawingOfficeName(BSTR strValue)
Set the Drawing office name of the project.
VARIANT_BOOL getDefineFirstDrawingNumber(EwErrorCode *errorCode)
Return true if the number of the first drawing created in the folder have to be the one defined in se...
BSTR getCustomerAddress3(EwErrorCode *errorCode)
Get the customer address 3 of the project.
EwErrorCode setCustomerName(BSTR strValue)
Set the name of the customer of the project.
IEwProjectExcelAutomationX newEwProjectExcelAutomation(EwErrorCode *errorCode)
Create an IEwProjectExcelAutomationX object from the associated project.
IEwProjectReportManagerX getEwProjectReportManager(EwErrorCode *errorCode)
Get an IEwProjectReportManagerX to manage reports of this project.
Use this interface to manage the Harness objects inside a project.
Definition: EwProjectHarnessObjects.idl:128
Use this interface to manage the numbering or renumbering of wires.
Definition: EwProjectProcessObjects.idl:289
IEwProjectExportDWGFilesX newEwProjectExportDWGFiles(EwErrorCode *errorCode)
Create an IEwProjectExportDWGFilesX object from the associated project.
LONG getEwProjectBookID(EwErrorCode *errorCode)
Get the ID of the book containing this folder.
void updateItemNotity(IDispatch *IEwObjectX)
this methode is an project Event of api when an item as update to project the event is fire
EwErrorCode setCustomerAddress3(BSTR strValue)
Set the customer address 3 of the project.
BSTR getRowMark(EwErrorCode *errorCode)
Return the row mark of the symbol.
Use this interface to manage IEwProjectBookX objects.
Definition: EwProjectObjects.idl:816
Use this interface to manage IEwProjectSymbolManagerX objects.
Definition: EwProjectObjects.idl:326
EwProjectFolderPathValue
Used with getFolderPath of EwProjectX object.
Definition: EwEnumeration.idl:42
BSTR getFilePath(EwErrorCode *errorCode)
Return the file path.
IEwProjectFileX findEwProjectFileByID(LONG lEwProjectFileID, EwErrorCode *errorCode)
Get the EwProjectFile from the file ID, for associated project.
Use this interface to manage IEwProjectFunctionX objects.
Definition: EwProjectObjects.idl:873
EwErrorCode setExternID(BSTR strValue)
Set the externID field in the project.
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:26
IEwProjectAutomaticArrowsX newEwProjectAutomaticArrows(EwErrorCode *errorCode)
Create an IEwProjectAutomaticArrowsX to manage the Origin Destination automatic insertion.
VARIANT getEwProjectArray(EwErrorCode *errorCode)
Return the array of IEwProjectX.
VARIANT_BOOL isLockedByAnother(EwErrorCode *errorCode)
Return true if the project file is lock by another.
LONG getFirstDrawingNumber(EwErrorCode *errorCode)
Get the number of the first drawing that will be created in this folder.
DATE getModificationDate(EwErrorCode *errorCode)
Get the modification date of the project.
IEwProjectFolderX findEwProjectFolderByID(LONG lEwProjectFolderID, EwErrorCode *errorCode)
Get the EwProjectFolder from the Folder ID of associated project.
IEwProjectOptimizeWireOrderX newEwProjectOptimizeWireOrder(EwErrorCode *errorCode)
Create an IEwProjectOptimizeWireOrderX to optimize the wire order of this project.
VARIANT getEwProjectFolderArray(EwErrorCode *errorCode)
Return the array of IEwProjectFolder of associated project.
Use this interface to manage symbol inside a project.
Definition: EwProjectObjects.idl:52
IEwProjectGenerateTSDrawingX newEwProjectGenerateTSDrawing(EwErrorCode *errorCode)
Create an IEwProjectGenerateTSDrawingX object to draw terminal strip in a project.
IEwProjectFunctionX findEwProjectFunctionByID(LONG lEwProjectFunctionID, EwErrorCode *errorCode)
Get the EwProjectFunction from the Function ID, for associated project.
EwErrorCode lock()
Lock the file so no one connected to the collaborative server can edit or delete it.
IEwProjectX findProjectFromFilePath(BSTR strFilePath, EwErrorCode *errorCode)
Return an IEwProjectX from a file path.
EwErrorCode setDrawingOfficeAddress2(BSTR strValue)
Set the drawing office address 2 of the project.
EwErrorCode setXPosition(double dXCoordinate)
Sets the X coordinate of the symbol.
VARIANT getEwProjectFunctionArray(EwErrorCode *errorCode)
Return the array of IEwProjectFunction of associated project.
EwErrorCode setDefineFirstDrawingNumber(VARIANT_BOOL bDefineFirstDrawingNumber)
Set this value to true to have the number of the first drawing created in this folder initialized by ...
EwErrorCode close()
Close the project file.
BSTR getDrawingOfficeName(EwErrorCode *errorCode)
Get the drawing office name of the project.
IEwProjectNumberMarksX newEwProjectNumberMarks(EwErrorCode *errorCode)
Create an IEwProjectNumberMarksX to manage the renumbering marks of this project.
EwSymbolType
All types of symbol.
Definition: EwEnumeration.idl:401
EwErrorCode setYPosition(double dYCoordinate)
Sets the Y coordinate of the symbol.
Use this interface to manage the location objects inside a project.
Definition: EwProjectLocationObjects.idl:65
EwErrorCode setCustomerAddress2(BSTR strValue)
Set the customer address 2 of the project.
EwErrorCode setEwMeasurementType(EwMeasurementType eMeasurementType)
Set the measurement type of the symbol.
BSTR getContractNumber(EwErrorCode *errorCode)
Get the contract number of the project.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Return the measurement type of the symbol.
Use this interface to manage configuration of the project.
Definition: EwProjectObjects.idl:749
double getYPosition(EwErrorCode *errorCode)
Return the Y coordinate of the symbol.
VARIANT_BOOL isLockByMe(EwErrorCode *errorCode)
Return true if the project file is lock by me.
BSTR getDrawingOfficeAddress1(EwErrorCode *errorCode)
Get the drawing office address 1 of the project.
EwErrorCode setContractNumber(BSTR strValue)
Set the contract number of the project.
Use this interface to manage the renumber marks.
Definition: EwProjectProcessObjects.idl:404
IEwProjectPrintConfigManagerX getEwProjectPrintConfigManager(EwErrorCode *errorCode)
Get an IEwProjectPrintConfigManagerX to manage print config of this project.
long getManufacturerPartID(EwErrorCode *errorCode)
Return the ManufacturerPart ID associated with the symbol.
EwSymbolCrossRefType
All cross reference type of symbol.
Definition: EwEnumeration.idl:428
LONG getEwProjectBookID(EwErrorCode *errorCode)
Get the ID of the book containing this file.
IEwProjectFileX newProjectFile(EwErrorCode *errorCode)
Create an IEwProjectFileX in the current project.
Use this interface to manage snapshot manager inside a project.
Definition: EwProjectProcessObjects.idl:181
EwSymbolType getEwSymbolType(EwErrorCode *errorCode)
Return the type of the symbol.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
BSTR getCreatedBy(EwErrorCode *eErrorCode)
Get the user name that created the current object.
EwErrorCode setFileType(EwFileType eFileType)
Set the file type of the current project file.
VARIANT getEwProjectConfigValue(EwProjectConfigValue eProjectConfigurationValues, EwErrorCode *errorCode)
Use this interface to manage the generation of terminal strip drawing inside the project.
Definition: EwProjectExportObjects.idl:1276
Use this interface to manage a project.
Definition: EwProjectObjects.idl:1104
IEwProjectSymbolManagerX getEwProjectSymbolManager(EwErrorCode *errorCode)
Get an IEwProjectSymbolManagerX to manage ProjectSymbolManager of this project.
LONG getPosition(EwErrorCode *errorCode)
Get the position of the folder in the book.
IEwProjectFileX findEwProjectFileFromPath(BSTR strFilePath, EwErrorCode *errorCode)
Get the EwProjectFile from a file path.
EwErrorCode setEwProjectBookID(LONG lID)
Set the Book ID of this file.
BSTR getDrawingOfficeAddress2(EwErrorCode *errorCode)
Get the drawing office address 2 of the project.
void addItemNotify(IDispatch *IEwObjectX)
/** this methode is an project Event of api when an item as add to project the event is fire
Use this interface to manage the components inside a project.
Definition: EwProjectComponentObjects.idl:398
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:346
IEwProjectSymbolX getProjectSymbolByID(LONG lId, EwErrorCode *errorCode)
return a Project Symbol by id.
IEwProjectFolderManagerX getEwProjectFolderManager(EwErrorCode *errorCode)
Get an IEwProjectFolderManagerX to manage Folders of this project.
IEwProjectWireManagerX getEwProjectWireManager(EwErrorCode *errorCode)
To get the project wire manager.
EwErrorCode setCustomerAddress1(BSTR strValue)
Set the customer address 1 of the project.
Use this interface to manage the location inside a project.
Definition: EwProjectLocationObjects.idl:27
Use this interface to manage the Origin Destination automatic insertion.
Definition: EwProjectProcessObjects.idl:481
BSTR getTargetFilePath(EwErrorCode *errorCode)
Return the path to a file not only a reference to a *.lnk.
EwErrorCode setEwSymbolName(BSTR strSymbolName)
Sets the symbol name of the symbol.
EwErrorCode setTranslatedData(LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
Set the value of a translated text Project must be opened to be able to call this method.
EwErrorCode archive(VARIANT vProjectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies)
Archive projects.
IEwProjectInputOutputManagerX getEwProjectInputOutputManager(EwErrorCode *errorCode)
Get an IEwProjectInputOutputManagerX to manage ProjectInputOutput of this project.
EwErrorCode setName(BSTR strValue)
Set the name of the project.
IEwProjectSnapshotManagerX getEwProjectSnapshotManager(EwErrorCode *errorCode)
Get an IEwProjectSnapshotManagerX to manage snapshots of this project.
IEwProjectFunctionX newEwProjectFunction(EwErrorCode *errorCode)
Create a IEwProjectFunctionX object from the associated project.
Use this interface to manage function inside a project.
Definition: EwProjectObjects.idl:635
void deleteItemNotify(IDispatch *IEwObjectX)
this methode is an project Event of api when an item as delete to project the event is fire
EwErrorCode setDrawingOfficeAddress3(BSTR strValue)
Set the drawing office address 3 of the project.
IEwProjectNumberDocumentsX newEwProjectNumberDocumments(EwErrorCode *errorCode)
Create an IEwProjectNumberDocumentsX to manage the renumbering document marks of this project.
Use this interface to manage folder inside a project.
Definition: EwProjectObjects.idl:931
Use this interface to manage the renumber documents.
Definition: EwProjectProcessObjects.idl:664
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
IEwRoutingDataX getEwRoutingData(EwErrorCode *errorCode)
To get the routing data manager.
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object Project must be opened to be able to call this method.
EwErrorCode open()
Open the project file.
IEwProjectLocationManagerX getEwProjectLocationManager(EwErrorCode *errorCode)
Get an IEwProjectLocationManagerX to manage locations of this project.
double getYScale(EwErrorCode *errorCode)
Return the Y scale of the symbol.
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of books of associated project.
IEwProjectFileManagerX getEwProjectFileManager(EwErrorCode *errorCode)
Get an IEwProjectFileManagerX to manage files of this project.
EwErrorCode open(EwOpenProjectMode eOpenMode)
open the project
Use this interface to manage file inside a project.
Definition: EwProjectObjects.idl:355
Use this interface to manage IEwProjectFolderX objects.
Definition: EwProjectObjects.idl:1046
EwErrorCode update()
BSTR getTagPath(EwErrorCode *errorCode)
Get the tag path of this Function.
IEwProjectExportPDMX newEwProjectExportPDM(EwErrorCode *errorCode)
Create an IEwProjectExportPDMX object from the associated project.
VARIANT getEwProjectBookArray(EwErrorCode *errorCode)
Return the array of IEwProjectBook of associated project.
IEwProjectManufacturerPartManagerX getEwProjectManufacturerPartManager(EwErrorCode *errorCode)
Get an IEwProjectManufacturerPartManagerX to manage Builds of Materials of this project.
EwErrorCode setEwProjectFolderID(LONG lID)
Update the folder ID of the parent folder.
Use this interface to manage the Excel Automation inside the project.
Definition: EwProjectExportObjects.idl:1354
IEwProjectX findEwProjectByID(LONG lId, EwErrorCode *errorCode)
Look for a project from an ID.
BSTR getName(EwErrorCode *errorCode)
Get the name of the project.
EwErrorCode setDrawingOfficeAddress1(BSTR strValue)
Set the drawing office address 1 of the project.
IEwProjectExportPDFX newEwProjectExportPDF(EwErrorCode *errorCode)
Create an IEwProjectExportPDFX object from the associated project.
BSTR getColumnMark(EwErrorCode *errorCode)
Return the column mark of the symbol.
IEwProjectBookX findEwProjectBookByID(LONG lEwProjectBookID, EwErrorCode *errorCode)
Get the EwProjectBook from the book ID, for associated project.
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of files of associated project.
IEwProjectNumberWiresX newEwProjectNumberWires(EwErrorCode *errorCode)
Create an IEwProjectNumberWiresX to manage the numbering or the renumbering wires of this project.
long getFunctionID(EwErrorCode *errorCode)
Return the Function ID to the symbol.
EwErrorCode setOriginalFilePath(BSTR strFilePath, VARIANT_BOOL bAsShortCut)
Specify the path of the file to add in the project.
VARIANT getEwProjectFileArrayFromFileType(EwFileType eFileType, EwErrorCode *errorCode)
Return the array of IEwProjectFileX of given type for associated project.
VARIANT unarchive(BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode *errorCode)
Unarchive projects.
BSTR getExternID(EwErrorCode *errorCode)
Get the externID of the project.
IEwProjectCableManagerX getEwProjectCableManager(EwErrorCode *errorCode)
To get the cable manager.
BSTR getDrawingOfficeAddress3(EwErrorCode *errorCode)
Get the drawing office address 3 of the project.
Use this interface to export file in PDF inside a project.
Definition: EwProjectExportObjects.idl:1458
IEwProjectExportReportX newEwProjectExportReport(EwErrorCode *errorCode)
Create an IEwProjectExportReportX object from the associated project.
VARIANT_BOOL getGenerateAutomatedDrawings(EwErrorCode *errorCode)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
IEwProjectConfigurationX getEwProjectConfiguration(EwErrorCode *errorCode)
To get the project configuration.
VARIANT getMacroVariables(EwErrorCode *errorCode)
Get an array of strings of the automation variables of the project, usually a macro.
Use this interface to manage the command "Export to PDM".
Definition: EwProjectExportObjects.idl:713
Use this interface to manage book inside a project.
Definition: EwProjectObjects.idl:618
Use this interface to manage EwProjectFileManagerx objects.
Definition: EwProjectObjects.idl:662
EwFileType getFileType()
EwErrorCode setXScale(double dXScale)
Sets the X scale of the symbol.
VARIANT_BOOL isOpen(EwErrorCode *errorCode)
Return true if the project file is open.
LONG getID()
double getXPosition(EwErrorCode *errorCode)
Return the X coordinate of the symbol.
Use this interface to manage the optimize wire order.
Definition: EwProjectProcessObjects.idl:824
BSTR getEwSymbolName(EwErrorCode *errorCode)
Return the symbol name of the symbol in the library.


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: idl_converted/EwProjectObjects.idl Source File
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2021 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.