Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
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 
22 
23 /************************************************************************/
24 /* In his file, all PROJECT object */
25 /************************************************************************/
26 
27 
28 /************************************************************************/
29 /* ENUMERATION */
30 /************************************************************************/
31 
32 /************************************************************************/
33 /* INTERFACES */
34 /************************************************************************/
35 
37 
41 [
42  object,
43  uuid(B13AD024-81E0-41C8-ADCA-518E347AAAE9),
44  dual,
45  oleautomation,
46  nonextensible,
47  helpstring("IEwProjectSymbolX Interface"),
48  pointer_default(unique)
49 ]
51 {
59  long getFileID (EwErrorCode* errorCode);
60 
61 
70  long getLocationID (EwErrorCode* errorCode);
71 
72 
73 
82  long getFunctionID (EwErrorCode* errorCode);
83 
84 
92  BSTR getEwSymbolName (EwErrorCode* errorCode);
93 
94 
102  EwErrorCode setEwSymbolName (BSTR strSymbolName);
103 
104 
113  long getObjectID (EwErrorCode* errorCode);
114 
115 
125 
126 
135 
136 
145 
146 
155 
156 
165 
166 
174  BSTR getAssociatedMacro (EwErrorCode* errorCode);
175 
176 
184  double getXPosition (EwErrorCode* errorCode);
185 
186 
194  EwErrorCode setXPosition (double dXCoordinate);
195 
196 
204  double getYPosition (EwErrorCode* errorCode);
205 
206 
214  EwErrorCode setYPosition (double dYCoordinate);
215 
216 
225 
226 
234  BSTR getColumnMark (EwErrorCode* errorCode);
235 
236 
244  BSTR getRowMark (EwErrorCode* errorCode);
245 
246 
247 
256  double getRotationAngle (EwErrorCode* errorCode);
257 
258 
267  EwErrorCode setRotationAngle (double dAngle);
268 
269 
277  EwErrorCode setYScale (double dYScale);
278 
279 
287  double getYScale (EwErrorCode* errorCode);
288 
289 
297  double getXScale (EwErrorCode* errorCode);
298 
299 
307  EwErrorCode setXScale (double dXScale);
308 
309 };
310 
311 
316 [
317  object,
318  uuid(06DD51E2-79F7-4148-9F53-02932E9A2D44),
319  dual,
320  oleautomation,
321  nonextensible,
322  pointer_default(unique)
323 ]
324 interface IEwProjectSymbolManagerX : IDispatch
325 {
335 
336 };
337 //\endcond
338 
339 
344 [
345  object,
346  uuid(4ac92b54-1043-11e5-9493-1697f925ec7b),
347  dual,
348  oleautomation,
349  nonextensible,
350  helpstring("IEwProjectFileX Interface"),
351  pointer_default(unique)
352 ]
354 {
355 
367 
368 
369 
379  BSTR getFilePath (EwErrorCode* errorCode);
380 
381 
391 
392 
402 
403 
408 
409 
420  LONG getPosition (EwErrorCode* errorCode);
421 
422 
423 
424 
425 
436  LONG getEwProjectBookID (EwErrorCode* errorCode);
437 
438 
451 
452 
469 
470 
487 
488 
489 
500  VARIANT_BOOL isOpen (EwErrorCode* errorCode);
501 
502 
514 
515 
527 
528 
541 
542 
559  EwErrorCode setOriginalFilePath (BSTR strFilePath, VARIANT_BOOL asShortCut);
560 
561 
573  BSTR getTargetFilePath (EwErrorCode* errorCode);
574 
575 };
576 
581 [
582  object,
583  uuid(5C9A9148-129E-4FCC-AE6A-842C0F78C736),
584  dual,
585  nonextensible,
586  helpstring("IEwProjectBookX Interface"),
587  pointer_default(unique)
588 ]
590 {
591 
592 };
593 
598 [
599  object,
600  uuid(743809C9-28AA-409F-B8F3-50907C2B68EC),
601  dual,
602  nonextensible,
603  helpstring("IEwProjectFunctionX Interface"),
604  pointer_default(unique)
605 ]
607 {
615  BSTR getTagPath (EwErrorCode* errorCode);
616 
617 
618 };
619 
620 
625 [
626  object,
627  uuid(BEBE7B8F-F07A-4F7B-B931-B206E6587E76),
628  dual,
629  oleautomation,
630  nonextensible,
631  helpstring("IEwProjectFileManagerX Interface"),
632  pointer_default(unique)
633 ]
634 interface IEwProjectFileManagerX : IDispatch{
635 
643  INT_PTR getCount (EwErrorCode* errorCode);
644 
645 
653  VARIANT getEwProjectFileArray (EwErrorCode* errorCode);
654 
655 
665  IEwProjectFileX findEwProjectFileByID (LONG lEwProjectFileID, EwErrorCode* errorCode);
666 
667 
678  IEwProjectFileX findEwProjectFileFromPath (BSTR strFilePath, EwErrorCode* errorCode);
679 
680 
691 
692 
704 
705 };
706 
711 [
712  object,
713  uuid(4227D81E-E027-43CF-89C4-D877A885BBB1),
714  dual,
715  oleautomation,
716  nonextensible,
717  helpstring("IEwProjectConfigurationX Interface"),
718  pointer_default(unique)
719 ]
721 {
722 
723  /*
724  * Get the name of the title block associated with a cabinet layout
725  * \return Title block name
726  */
728 
729 
730  /*
731  * Get the used measuremnt type
732  * \param[out] errorCode EwErrorCode enum type, can be:
733  * \li EW_NO_ERROR if no error detected
734  * \li EW_UNDEFINED_ERROR if another error occurred
735  * \return Measurement type
736  */
738 
739 
740  /*
741  * Get the current language code
742  * \param[out] errorCode EwErrorCode enum type, can be:
743  * \li EW_NO_ERROR if no error detected
744  * \li EW_UNDEFINED_ERROR if another error occurred
745  * \return Language code
746  */
748 
749 
750  /*
751  * Set a project configuration value
752  * \param[in] ewProjectConfigurationValues The project configuration property you want to apply
753  * \param[in] ewProjectConfigurationValues The value you want to apply
754  * \return EwErrorCode enum type, can be:
755  * \li EW_NO_ERROR if no error detected
756  * \li EW_UNDEFINED_ERROR if another error occurred
757  */
758  EwErrorCode setEwProjectConfigValue (EwProjectConfigValue ewProjectConfigurationValues, VARIANT value);
759 
760 
761 
762  /*
763  * Get a project configuration value
764  * \param[in] ewProjectConfigurationValues The project configuration property you want to get
765  * \param[out] errorCode EwErrorCode enum type, can be:
766  * \li EW_NO_ERROR if no error detected
767  * \li EW_UNDEFINED_ERROR if another error occurred
768  * \li EW_BAD_INPUTS if the project configurations values does not exist
769  * \return project configuration value
770  */
771  VARIANT getEwProjectConfigValue (EwProjectConfigValue ewProjectConfigurationValues, EwErrorCode* errorCode);
772 
773 
774 };
775 
780 [
781  object,
782  uuid(F984331D-9550-492C-9804-C43D9A173CA1),
783  dual,
784  nonextensible,
785  pointer_default(unique)
786 ]
787 interface IEwProjectBookManagerX : IDispatch
788 {
789 
797  INT_PTR getCount (EwErrorCode* errorCode);
798 
799 
807  VARIANT getEwProjectBookArray (EwErrorCode* errorCode);
808 
809 
819  IEwProjectBookX findEwProjectBookByID (LONG lEwProjectBookID, EwErrorCode* errorCode);
820 
821 
830 
831 };
832 
837 [
838  object,
839  uuid(41B046AD-FD19-4184-B6E7-A67E80FFD48F),
840  dual,
841  nonextensible,
842  pointer_default(unique)
843 ]
844 interface IEwProjectFunctionManagerX : IDispatch
845 {
853  INT_PTR getCount (EwErrorCode* errorCode);
854 
855 
864 
865 
875  IEwProjectFunctionX findEwProjectFunctionByID (LONG lEwProjectFunctionID, EwErrorCode* errorCode);
876 
877 
886 
887 };
888 
889 
894 [
895  object,
896  uuid(10D11ED8-FB45-4A3E-ADF6-DC349B4ECBFF),
897  dual,
898  nonextensible,
899  helpstring("IEwProjectFolder Interface"),
900  pointer_default(unique)
901 ]
903 {
904 
912  LONG getEwProjectBookID (EwErrorCode* errorCode);
913 
914 
915 
925 
926 
936 
937 
948 
949 
959 
960 
971 
972 
980  VARIANT_BOOL getDefineFirstDrawingNumber (EwErrorCode* errorCode);
981 
982 
990  EwErrorCode setDefineFirstDrawingNumber (VARIANT_BOOL bDefineFirstDrawingNumber);
991 
992 
1000  LONG getPosition (EwErrorCode* errorCode);
1001 
1002 
1003 
1004 
1005 };
1006 
1007 
1008 
1013 [
1014  object,
1015  uuid(85158F93-1205-4614-ABC3-F3F19F9EDCDD),
1016  dual,
1017  nonextensible,
1018  pointer_default(unique)
1019 ]
1020 interface IEwProjectFolderManagerX : IDispatch
1021 {
1029  INT_PTR getCount (EwErrorCode* errorCode);
1030 
1031 
1039  VARIANT getEwProjectFolderArray (EwErrorCode* errorCode);
1040 
1041 
1051  IEwProjectFolderX findEwProjectFolderByID (LONG lEwProjectFolderID, EwErrorCode* errorCode);
1052 
1053 
1062 
1063 };
1064 
1065 
1070 [
1071  object,
1072  uuid(9442A4C0-D96C-4AAE-B679-C76877753635),
1073  dual,
1074  oleautomation,
1075  nonextensible,
1076  helpstring("IEwProjectX Interface"),
1077  pointer_default(unique)
1078 ]
1079 interface IEwProjectX : IDispatch{
1080 
1081 
1082 
1083 
1088  BSTR getCreoFolderPath (EwErrorCode* errorCode);
1089 
1090 
1100 
1101 
1111 
1112 
1122 
1123 
1132  IEwRoutingDataX getEwRoutingData (EwErrorCode* errorCode);
1133 
1134 
1144 
1145 
1155 
1156 
1166 
1167 
1168  /*
1169  * \return Get the ID of the project. -1 if the object is invalid
1170  */
1171  LONG getID ();
1172 
1173 
1182  EwErrorCode setName (BSTR strValue);
1183 
1184 
1193  BSTR getName (EwErrorCode* errorCode);
1194 
1195 
1204  EwErrorCode setCustomerName (BSTR strValue);
1205 
1206 
1215  BSTR getCustomerName (EwErrorCode* errorCode);
1216 
1217 
1227 
1228 
1238 
1239 
1249 
1250 
1260 
1261 
1271 
1272 
1282 
1283 
1293 
1294 
1304 
1305 
1315 
1316 
1326 
1327 
1337 
1338 
1348 
1349 
1358 
1359 
1369 
1370 
1380 
1381 
1390  BSTR getContractNumber (EwErrorCode* errorCode);
1391 
1392 
1393  /*
1394  * Update the object properties. If one of the properties has been modified, you must call this method to apply this modification.
1395  * Project must be opened to be able to call this method
1396  * \return EwErrorCode enum type, can be:
1397  * \li EW_UNDEFINED_ERROR default Error
1398  * \li EW_NO_ERROR if no error detected
1399  * \li EW_PROJECT_NOTOPENED Project not opened
1400  */
1402 
1403 
1414  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
1415 
1416 
1427  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
1428 
1429 
1442  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
1443 
1444 
1456  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
1457 
1458 
1468 
1469 
1479 
1480 
1490 
1491 
1501  VARIANT getMacroVariables (EwErrorCode* errorCode);
1502 
1503 
1513 
1514 
1523 
1524 
1525  /*
1526  * Remove the project. Project will be closed and mustn't be opened by someone else if you are using client and server installation.
1527  * \return EwErrorCode enum type, can be:
1528  * \li EW_NO_ERROR if no error detected
1529  * \li EW_UNDEFINED_ERROR if another error occurred
1530  * \li EW_CANNOT_CLOSE_PROJECT if project cannot be closed
1531  * \li EW_CANNOT_REMOVE if project cannot be removed
1532  * \li EW_NO_PROJECT_OPENED_BY_SOMEONE_ELSE if project is opened on another computer by someone else
1533  * \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.
1534  * \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.
1535  * \li EW_DATABASE_CONNECTION_ERROR if connection to project database cannot be opened. You need to check the query log to investigate the reason.
1536  * \li EW_PROJECT_NOTOPENED: project are close.
1537  */
1538  EwErrorCode remove ();
1539 
1540 
1549 
1550 
1559 
1560 
1561 
1571 
1572 
1573 
1583 
1584 
1593 
1594 
1602  EwErrorCode setExternID (BSTR strValue);
1603 
1604 
1612  BSTR getExternID (EwErrorCode* errorCode);
1613 
1614 
1624 
1625 
1635 
1636 
1645 
1646 
1657 
1658 
1669  BSTR getFolderPath (EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode* errorCode);
1670 
1671 
1682 
1683 
1694 
1695 
1706 
1707 
1718 
1719 
1730 
1731 
1742 
1743 
1754 
1755 
1766 
1767 
1776  BSTR getModifiedBy (EwErrorCode* eErrorCode);
1777 
1778 };
1779 
1784 [
1785  object,
1786  uuid(9A02A344-94BB-4F95-A133-45E09A42D6C5),
1787  dual,
1788  oleautomation,
1789  nonextensible,
1790  helpstring("IEwProjectManagerX Interface"),
1791  pointer_default(unique)
1792 ]
1793 interface IEwProjectManagerX : IDispatch{
1794 
1798  LONG getCount ();
1799 
1800 
1810  VARIANT getEwProjectArray (EwErrorCode* errorCode);
1811 
1812 
1822 
1823 
1832  IEwProjectX findEwProjectByName (BSTR strName, EwErrorCode* errorCode);
1833 
1834 
1845  EwErrorCode archive (VARIANT projectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies);
1846 
1847 
1858  VARIANT unarchive (BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode* errorCode);
1859 
1860 
1872  IEwProjectX findProjectFromFilePath (BSTR strFilePath, EwErrorCode* errorCode);
1873 
1874 
1884  VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode* errorCode);
1885 
1886 
1896  EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings);
1897 
1898 }
1899 
1901 [
1902  uuid(9fd7cb1e-5e41-4e5b-91c4-825a6494819a),
1903  helpstring("Event interface for EwProjectX")
1904 ]
1905  dispinterface _DIEwProjectXEvents
1906  {
1907  properties:
1908  // Event interface has no properties
1909 
1910  methods:
1911  // NOTE - ClassWizard will maintain event information here.
1912  // Use extreme caution when editing this section.
1921  void addItemNotify (IDispatch* IEwObjectX);
1922 
1929  void deleteItemNotify (IDispatch* IEwObjectX);
1930 
1937  void updateItemNotity (IDispatch* IEwObjectX);
1938 
1939  };
1940 
1941 
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:434
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:1906
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:161
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:352
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:1793
EwProjectConfigValue
Values for project configuration.
Definition: EwEnumeration.idl:101
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:350
Use this interface to manage the export reports used inside the project.
Definition: EwProjectExportObjects.idl:986
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:648
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of Folders of associated project.
IEwProjectSymbolManagerX getEwProjectSymbolManager(EwErrorCode *pErrorCode)
Get an IEwProjectSymbolManagerX to manage ProjectSymbolManager of this 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.
IEwProjectBookX newEwProjectBook(EwErrorCode *errorCode)
Create a IEwProjectBookX object from the associated project.
IEwProjectLocationX getEwProjectLocation(EwErrorCode *errorCode)
IEwProjectLocationX associated with the file.
EwErrorCode archive(VARIANT projectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies)
Archive projects.
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:916
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:513
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:252
IEwProjectSymbolX getProjectSymbolByID(LONG lId, EwErrorCode *pErrorCode)
return a Project Symbol by id.
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.
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:44
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:788
Use this interface to manage IEwProjectSymbolManagerX objects.
Definition: EwProjectObjects.idl:325
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:845
EwErrorCode setExternID(BSTR strValue)
Set the externID field in the project.
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:26
VARIANT getEwProjectConfigValue(EwProjectConfigValue ewProjectConfigurationValues, EwErrorCode *errorCode)
IEwProjectAutomaticArrowsX newEwProjectAutomaticArrows(EwErrorCode *errorCode)
Create an IEwProjectAutomaticArrowsX to manage the Origin Destination automatic insertion.
VARIANT getEwProjectArray(EwErrorCode *errorCode)
Return the array of IEwProjectX.
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:51
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 initialised 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:392
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.
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:721
double getYPosition(EwErrorCode *errorCode)
Return the Y coordinate of the symbol.
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:419
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)
EwErrorCode setFileType(EwFileType eFileType)
Set the file type of the current project file.
EwErrorCode setEwMeasurementType(EwMeasurementType ewMeasurementType)
Set the measurement type of the symbol.
Use this interface to manage the generation of terminal strip drawing inside the project.
Definition: EwProjectExportObjects.idl:1315
Use this interface to manage a project.
Definition: EwProjectObjects.idl:1079
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:178
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:207
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:480
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 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:607
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:903
Use this interface to manage the renumber documents.
Definition: EwProjectProcessObjects.idl:663
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:354
Use this interface to manage IEwProjectFolderX objects.
Definition: EwProjectObjects.idl:1021
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.
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.
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.
VARIANT getEwProjectFileArrayFromFileType(EwFileType eFileType, EwErrorCode *errorCode)
Return the array of IEwProjectFileX of given type for associated project.
EwErrorCode setEwProjectConfigValue(EwProjectConfigValue ewProjectConfigurationValues, VARIANT value)
VARIANT unarchive(BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode *errorCode)
Unarchive projects.
BSTR getExternID(EwErrorCode *errorCode)
Get the externID of the project.
EwErrorCode setOriginalFilePath(BSTR strFilePath, VARIANT_BOOL asShortCut)
Specify the path of the file to add in the project.
IEwProjectCableManagerX getEwProjectCableManager(EwErrorCode *errorCode)
To get the cable manager.
BSTR getDrawingOfficeAddress3(EwErrorCode *errorCode)
Get the drawing office address 3 of the project.
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:752
Use this interface to manage book inside a project.
Definition: EwProjectObjects.idl:590
Use this interface to manage EwProjectFileManagerx objects.
Definition: EwProjectObjects.idl:634
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:821
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) 2020 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.