Hide Table of Contents
SOLIDWORKS Electrical API  2022.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 {
61  long getFileID (EwErrorCode* errorCode);
62 
63 
73  long getLocationID (EwErrorCode* errorCode);
74 
75 
76 
86  long getFunctionID (EwErrorCode* errorCode);
87 
88 
97  BSTR getEwSymbolName (EwErrorCode* errorCode);
98 
99 
108  EwErrorCode setEwSymbolName (BSTR strSymbolName);
109 
110 
120  long getObjectID (EwErrorCode* errorCode);
121 
122 
133 
134 
144 
145 
155 
156 
166 
167 
177 
178 
187  BSTR getAssociatedMacro (EwErrorCode* errorCode);
188 
189 
198  double getXPosition (EwErrorCode* errorCode);
199 
200 
209  EwErrorCode setXPosition (double dXCoordinate);
210 
211 
220  double getYPosition (EwErrorCode* errorCode);
221 
222 
231  EwErrorCode setYPosition (double dYCoordinate);
232 
233 
243 
244 
253  BSTR getColumnMark (EwErrorCode* errorCode);
254 
255 
264  BSTR getRowMark (EwErrorCode* errorCode);
265 
266 
267 
277  double getRotationAngle (EwErrorCode* errorCode);
278 
279 
289  EwErrorCode setRotationAngle (double dAngle);
290 
291 
300  EwErrorCode setYScale (double dYScale);
301 
302 
311  double getYScale (EwErrorCode* errorCode);
312 
313 
322  double getXScale (EwErrorCode* errorCode);
323 
324 
333  EwErrorCode setXScale (double dXScale);
334 
335 };
336 
337 
342 [
343  object,
344  uuid(06DD51E2-79F7-4148-9F53-02932E9A2D44),
345  dual,
346  oleautomation,
347  nonextensible,
348  pointer_default(unique)
349 ]
350 interface IEwProjectSymbolManagerX : IDispatch
351 {
361 
362 };
363 //\endcond
364 
365 
370 [
371  object,
372  uuid(4ac92b54-1043-11e5-9493-1697f925ec7b),
373  dual,
374  oleautomation,
375  nonextensible,
376  helpstring("IEwProjectFileX Interface"),
377  pointer_default(unique)
378 ]
380 {
381 
393 
394 
395 
405  BSTR getFilePath (EwErrorCode* errorCode);
406 
407 
417 
418 
428 
429 
434 
435 
446  LONG getPosition (EwErrorCode* errorCode);
447 
448 
449 
450 
451 
462  LONG getEwProjectBookID (EwErrorCode* errorCode);
463 
464 
477 
478 
495 
496 
513 
514 
515 
526  VARIANT_BOOL isOpen (EwErrorCode* errorCode);
527 
528 
540 
541 
553 
554 
567 
568 
585  EwErrorCode setOriginalFilePath (BSTR strFilePath, VARIANT_BOOL bAsShortCut);
586 
587 
599  BSTR getTargetFilePath (EwErrorCode* errorCode);
600 
601 
612  VARIANT_BOOL isLockByMe (EwErrorCode* errorCode);
613 
614 
625  VARIANT_BOOL isLockedByAnother (EwErrorCode* errorCode);
626 
627 
628 };
629 
634 [
635  object,
636  uuid(5C9A9148-129E-4FCC-AE6A-842C0F78C736),
637  dual,
638  nonextensible,
639  helpstring("IEwProjectBookX Interface"),
640  pointer_default(unique)
641 ]
643 {
644 
645 };
646 
651 [
652  object,
653  uuid(743809C9-28AA-409F-B8F3-50907C2B68EC),
654  dual,
655  nonextensible,
656  helpstring("IEwProjectFunctionX Interface"),
657  pointer_default(unique)
658 ]
660 {
669  BSTR getTagPath (EwErrorCode* errorCode);
670 
671 
672 };
673 
674 
679 [
680  object,
681  uuid(BEBE7B8F-F07A-4F7B-B931-B206E6587E76),
682  dual,
683  oleautomation,
684  nonextensible,
685  helpstring("IEwProjectFileManagerX Interface"),
686  pointer_default(unique)
687 ]
688 interface IEwProjectFileManagerX : IDispatch {
689 
697  INT_PTR getCount (EwErrorCode* errorCode);
698 
699 
707  VARIANT getEwProjectFileArray (EwErrorCode* errorCode);
708 
709 
719  IEwProjectFileX findEwProjectFileByID (LONG lEwProjectFileID, EwErrorCode* errorCode);
720 
721 
732  IEwProjectFileX findEwProjectFileFromPath (BSTR strFilePath, EwErrorCode* errorCode);
733 
734 
745 
746 
758 
759 };
760 
765 [
766  object,
767  uuid(4227D81E-E027-43CF-89C4-D877A885BBB1),
768  dual,
769  oleautomation,
770  nonextensible,
771  helpstring("IEwProjectConfigurationX Interface"),
772  pointer_default(unique)
773 ]
775 {
776 
777  /*
778  * Get the name of the title block associated with a cabinet layout
779  * \return Title block name
780  */
782 
783 
784  /*
785  * Get the used measuremnt type
786  * \param[out] errorCode EwErrorCode enum type, can be:
787  * \li EW_NO_ERROR if no error detected
788  * \li EW_UNDEFINED_ERROR if another error occurred
789  * \li EW_INVALID_OBJECT if object is not initialized
790  * \return Measurement type
791  */
793 
794 
795  /*
796  * Get the current language code
797  * \param[out] errorCode EwErrorCode enum type, can be:
798  * \li EW_NO_ERROR if no error detected
799  * \li EW_UNDEFINED_ERROR if another error occurred
800  * \li EW_INVALID_OBJECT if object is not initialized
801  * \return Language code
802  */
804 
805 
806  /*
807  * Set a project configuration value
808  * \param[in] eProjectConfigurationValues The project configuration property you want to apply
809  * \param[in] vValue The value you want to apply
810  * \return EwErrorCode enum type, can be:
811  * \li EW_NO_ERROR if no error detected
812  * \li EW_UNDEFINED_ERROR if another error occurred
813  * \li EW_INVALID_OBJECT if object is not initialized
814  */
815  EwErrorCode setEwProjectConfigValue (EwProjectConfigValue eProjectConfigurationValues, VARIANT vValue);
816 
817 
818 
819  /*
820  * Get a project configuration value
821  * \param[in] eProjectConfigurationValues The project configuration property you want to get
822  * \param[out] errorCode EwErrorCode enum type, can be:
823  * \li EW_NO_ERROR if no error detected
824  * \li EW_UNDEFINED_ERROR if another error occurred
825  * \li EW_BAD_INPUTS if the project configurations values does not exist
826  * \li EW_INVALID_OBJECT if object is not initialized
827  * \return project configuration value
828  */
829  VARIANT getEwProjectConfigValue (EwProjectConfigValue eProjectConfigurationValues, EwErrorCode* errorCode);
830 
831 
832 };
833 
838 [
839  object,
840  uuid(F984331D-9550-492C-9804-C43D9A173CA1),
841  dual,
842  nonextensible,
843  pointer_default(unique)
844 ]
845 interface IEwProjectBookManagerX : IDispatch
846 {
847 
855  INT_PTR getCount (EwErrorCode* errorCode);
856 
857 
865  VARIANT getEwProjectBookArray (EwErrorCode* errorCode);
866 
867 
877  IEwProjectBookX findEwProjectBookByID (LONG lEwProjectBookID, EwErrorCode* errorCode);
878 
879 
888 
889 };
890 
895 [
896  object,
897  uuid(41B046AD-FD19-4184-B6E7-A67E80FFD48F),
898  dual,
899  nonextensible,
900  pointer_default(unique)
901 ]
902 interface IEwProjectFunctionManagerX : IDispatch
903 {
911  INT_PTR getCount (EwErrorCode* errorCode);
912 
913 
922 
923 
933  IEwProjectFunctionX findEwProjectFunctionByID (LONG lEwProjectFunctionID, EwErrorCode* errorCode);
934 
935 
944 
945 };
946 
947 
952 [
953  object,
954  uuid(10D11ED8-FB45-4A3E-ADF6-DC349B4ECBFF),
955  dual,
956  nonextensible,
957  helpstring("IEwProjectFolder Interface"),
958  pointer_default(unique)
959 ]
961 {
962 
971  LONG getEwProjectBookID (EwErrorCode* errorCode);
972 
973 
974 
985 
986 
997 
998 
1010 
1011 
1022 
1023 
1035 
1036 
1045  VARIANT_BOOL getDefineFirstDrawingNumber (EwErrorCode* errorCode);
1046 
1047 
1056  EwErrorCode setDefineFirstDrawingNumber (VARIANT_BOOL bDefineFirstDrawingNumber);
1057 
1058 
1067  LONG getPosition (EwErrorCode* errorCode);
1068 
1069 
1070 };
1071 
1072 
1077 [
1078  object,
1079  uuid(85158F93-1205-4614-ABC3-F3F19F9EDCDD),
1080  dual,
1081  nonextensible,
1082  pointer_default(unique)
1083 ]
1084 interface IEwProjectFolderManagerX : IDispatch
1085 {
1093  INT_PTR getCount (EwErrorCode* errorCode);
1094 
1095 
1103  VARIANT getEwProjectFolderArray (EwErrorCode* errorCode);
1104 
1105 
1115  IEwProjectFolderX findEwProjectFolderByID (LONG lEwProjectFolderID, EwErrorCode* errorCode);
1116 
1117 
1126 
1127 };
1128 
1129 
1134 [
1135  object,
1136  uuid(9442A4C0-D96C-4AAE-B679-C76877753635),
1137  dual,
1138  oleautomation,
1139  nonextensible,
1140  helpstring("IEwProjectX Interface"),
1141  pointer_default(unique)
1142 ]
1143 interface IEwProjectX : IDispatch {
1144 
1145 
1146 
1147 
1152  BSTR getCreoFolderPath (EwErrorCode* errorCode);
1153 
1154 
1164 
1165 
1175 
1176 
1186 
1187 
1196  IEwRoutingDataX getEwRoutingData (EwErrorCode* errorCode);
1197 
1198 
1208 
1209 
1219 
1220 
1230 
1231 
1232  /*
1233  * \return Get the ID of the project. -1 if the object is invalid
1234  */
1235  LONG getID ();
1236 
1237 
1246  EwErrorCode setName (BSTR strValue);
1247 
1248 
1257  BSTR getName (EwErrorCode* errorCode);
1258 
1259 
1268  EwErrorCode setCustomerName (BSTR strValue);
1269 
1270 
1279  BSTR getCustomerName (EwErrorCode* errorCode);
1280 
1281 
1291 
1292 
1302 
1303 
1313 
1314 
1324 
1325 
1335 
1336 
1346 
1347 
1357 
1358 
1368 
1369 
1379 
1380 
1390 
1391 
1401 
1402 
1412 
1413 
1422 
1423 
1433 
1434 
1444 
1445 
1454  BSTR getContractNumber (EwErrorCode* errorCode);
1455 
1456 
1457  /*
1458  * Update the object properties. If one of the properties has been modified, you must call this method to apply this modification.
1459  * Project must be opened to be able to call this method
1460  * \return EwErrorCode enum type, can be:
1461  * \li EW_UNDEFINED_ERROR default Error
1462  * \li EW_NO_ERROR if no error detected
1463  * \li EW_PROJECT_NOTOPENED Project not opened
1464  */
1466 
1467 
1478  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
1479 
1480 
1491  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
1492 
1493 
1506  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
1507 
1508 
1520  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
1521 
1522 
1532 
1533 
1543 
1544 
1554 
1555 
1565  VARIANT getMacroVariables (EwErrorCode* errorCode);
1566 
1567 
1577 
1578 
1587 
1588 
1589  /*
1590  * Remove the project. Project will be closed and mustn't be opened by someone else if you are using client and server installation.
1591  * \return EwErrorCode enum type, can be:
1592  * \li EW_NO_ERROR if no error detected
1593  * \li EW_UNDEFINED_ERROR if another error occurred
1594  * \li EW_CANNOT_CLOSE_PROJECT if project cannot be closed
1595  * \li EW_CANNOT_REMOVE if project cannot be removed
1596  * \li EW_NO_PROJECT_OPENED_BY_SOMEONE_ELSE if project is opened on another computer by someone else
1597  * \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.
1598  * \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.
1599  * \li EW_DATABASE_CONNECTION_ERROR if connection to project database cannot be opened. You need to check the query log to investigate the reason.
1600  * \li EW_PROJECT_NOTOPENED: project are close.
1601  */
1602  EwErrorCode remove ();
1603 
1604 
1613 
1614 
1623 
1624 
1625 
1635 
1636 
1637 
1647 
1648 
1657 
1658 
1666  EwErrorCode setExternID (BSTR strValue);
1667 
1668 
1676  BSTR getExternID (EwErrorCode* errorCode);
1677 
1678 
1688 
1689 
1699 
1700 
1709 
1710 
1721 
1722 
1733  BSTR getFolderPath (EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode* errorCode);
1734 
1735 
1746 
1747 
1758 
1759 
1770 
1771 
1782 
1783 
1794 
1795 
1806 
1807 
1818 
1819 
1830 
1831 
1840  BSTR getModifiedBy (EwErrorCode* eErrorCode);
1841 
1842 
1851 
1852 
1861 
1862 
1871  BSTR getCreatedBy (EwErrorCode* eErrorCode);
1872 
1873 
1884 
1885 
1886 };
1887 
1892 [
1893  object,
1894  uuid(9A02A344-94BB-4F95-A133-45E09A42D6C5),
1895  dual,
1896  oleautomation,
1897  nonextensible,
1898  helpstring("IEwProjectManagerX Interface"),
1899  pointer_default(unique)
1900 ]
1901 interface IEwProjectManagerX : IDispatch {
1902 
1906  LONG getCount ();
1907 
1908 
1918  VARIANT getEwProjectArray (EwErrorCode* errorCode);
1919 
1920 
1930 
1931 
1940  IEwProjectX findEwProjectByName (BSTR strName, EwErrorCode* errorCode);
1941 
1942 
1954  EwErrorCode archive (VARIANT vProjectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies);
1955 
1956 
1967  VARIANT unarchive (BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode* errorCode);
1968 
1969 
1981  IEwProjectX findProjectFromFilePath (BSTR strFilePath, EwErrorCode* errorCode);
1982 
1983 
1993  VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode* errorCode);
1994 
1995 
2005  EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings);
2006 
2007 }
2008 
2010 [
2011  uuid(9fd7cb1e-5e41-4e5b-91c4-825a6494819a),
2012  helpstring("Event interface for EwProjectX")
2013 ]
2014 dispinterface _DIEwProjectXEvents
2015 {
2016  properties:
2017  // Event interface has no properties
2018 
2019  methods:
2020  // NOTE - ClassWizard will maintain event information here.
2021  // Use extreme caution when editing this section.
2030  void addItemNotify (IDispatch * IEwObjectX);
2031 
2038  void deleteItemNotify (IDispatch* IEwObjectX);
2039 
2046  void updateItemNotity (IDispatch* IEwObjectX);
2047 
2048 };
2049 
2050 
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:458
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:2015
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:601
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:375
Generic interface for an object that belongs to a project.
Definition: EwObjectBase.idl:103
EwErrorCode setRotationAngle(double dAngle)
Set the rotation angle in degrees of the symbol.
Use this interface to manage IEwProjectX objects.
Definition: EwProjectObjects.idl:1901
EwProjectConfigValue
Values for project configuration.
Definition: EwEnumeration.idl:119
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:478
Use this interface to manage the export reports used inside the project.
Definition: EwProjectExportObjects.idl:997
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:646
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:252
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:235
IEwProjectBookX newEwProjectBook(EwErrorCode *errorCode)
Create a IEwProjectBookX object from the associated project.
IEwProjectLocationX getEwProjectLocation(EwErrorCode *errorCode)
IEwProjectLocationX associated with the file.
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:82
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:927
EwErrorCode setEwProjectConfigValue(EwProjectConfigValue eProjectConfigurationValues, VARIANT vValue)
BSTR getCustomerAddress1(EwErrorCode *errorCode)
Get the customer address 1 of the project.
BSTR getCreoFolderPath(EwErrorCode *errorCode)
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:501
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:273
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:129
Use this interface to manage the numbering or renumbering of wires.
Definition: EwProjectProcessObjects.idl:299
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:846
Use this interface to manage IEwProjectSymbolManagerX objects.
Definition: EwProjectObjects.idl:351
EwProjectFolderPathValue
Used with getFolderPath of EwProjectX object.
Definition: EwEnumeration.idl:55
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:903
EwErrorCode setExternID(BSTR strValue)
Set the externID field in the project.
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:416
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:775
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:414
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:443
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:191
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:1326
Use this interface to manage a project.
Definition: EwProjectObjects.idl:1143
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:590
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:358
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:491
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:660
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:961
Use this interface to manage the renumber documents.
Definition: EwProjectProcessObjects.idl:674
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:380
Use this interface to manage IEwProjectFolderX objects.
Definition: EwProjectObjects.idl:1085
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:1404
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:1516
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:756
Use this interface to manage book inside a project.
Definition: EwProjectObjects.idl:643
Use this interface to manage EwProjectFileManagerx objects.
Definition: EwProjectObjects.idl:688
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:834
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) 2022 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.