Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwProjectObjects.idl
Go to the documentation of this file.
1#pragma once
2
3#if (__midl >= 501)
4midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
5#endif
6
7import "oaidl.idl";
8import "ocidl.idl";
9
10import "EnumDefinition.idl";
11import "EwProjectRoutingObjects.idl";
12import "EwProjectComponentObjects.idl";
13import "EwProjectManufacturerPartObjects.idl";
14import "EwProjectLocationObjects.idl";
15import "EwProjectFunctionObjects.idl";
16import "EwProjectWireObjects.idl";
17import "EwProjectCableObjects.idl";
18import "EwProjectEntity3DObjects.idl";
19import "EwProjectHarnessObjects.idl";
20import "EwProjectExportObjects.idl";
21import "EwProjectProcessObjects.idl";
22import "EwProjectInputOutputObjects.idl";
23import "EwProjectFileConfigurationObjects.idl";
24
25
26/************************************************************************/
27/* In his file, all PROJECT object */
28/************************************************************************/
29
30
31/************************************************************************/
32/* ENUMERATION */
33/************************************************************************/
34
35/************************************************************************/
36/* INTERFACES */
37/************************************************************************/
38
40
44[
45 object,
46 uuid(B13AD024-81E0-41C8-ADCA-518E347AAAE9),
47 dual,
48 oleautomation,
49 nonextensible,
50 helpstring("IEwProjectSymbolX Interface"),
51 pointer_default(unique)
52]
54{
63 long getFileID (EwErrorCode* errorCode);
64
65
75 long getLocationID (EwErrorCode* errorCode);
76
77
78
88 long getFunctionID (EwErrorCode* errorCode);
89
90
99 BSTR getEwSymbolName (EwErrorCode* errorCode);
100
101
112 EwErrorCode setEwSymbolName (BSTR strSymbolName);
113
114
124 long getObjectID (EwErrorCode* errorCode);
125
126
137
138
148
149
159
160
170
171
181
182
192
193
202 double getXPosition (EwErrorCode* errorCode);
203
204
215 EwErrorCode setXPosition (double dXCoordinate);
216
217
226 double getYPosition (EwErrorCode* errorCode);
227
228
239 EwErrorCode setYPosition (double dYCoordinate);
240
241
251
252
261 BSTR getColumnMark (EwErrorCode* errorCode);
262
263
272 BSTR getRowMark (EwErrorCode* errorCode);
273
274
275
285 double getRotationAngle (EwErrorCode* errorCode);
286
287
300
301
312 EwErrorCode setYScale (double dYScale);
313
314
323 double getYScale (EwErrorCode* errorCode);
324
325
334 double getXScale (EwErrorCode* errorCode);
335
336
347 EwErrorCode setXScale (double dXScale);
348
349
350
351
352
353
354
355
367
368
383
384
396
397
412
413};
414
419[
420 object,
421 uuid(06DD51E2-79F7-4148-9F53-02932E9A2D44),
422 dual,
423 oleautomation,
424 nonextensible,
425 pointer_default(unique)
426]
427interface IEwProjectSymbolManagerX : IDispatch
428{
439
440
451 VARIANT getProjectSymbolsFromFileID (LONG lID, EwErrorCode* errorCode);
452
453};
454
459[
460 object,
461 uuid(353a273d-09b7-467e-bde5-fc5e9d9d49da),
462 dual,
463 oleautomation,
464 nonextensible,
465 helpstring("IEwProjectMultilingualTextFontX Interface"),
466 pointer_default(unique)
467]
469{
479 long getObjectID (EwErrorCode* errorCode);
480
481
490 BSTR getFont (EwErrorCode* errorCode);
491
492
493
502 VARIANT_BOOL isBold (EwErrorCode* errorCode);
503
504
513 EwErrorCode setBold (VARIANT_BOOL bBold);
514
515
524 VARIANT_BOOL isItalic (EwErrorCode* errorCode);
525
526
535 EwErrorCode setItalic (VARIANT_BOOL bItalic);
536
537
546 VARIANT_BOOL isUnderline (EwErrorCode* errorCode);
547
548
557 EwErrorCode setUnderline (VARIANT_BOOL bUnderline);
558
559
568 double getHeight (EwErrorCode* errorCode);
569
570
580 EwErrorCode setHeight (double dHeight);
581
582
592
593
603 EwErrorCode setProjectConfigurationFontUsed (VARIANT_BOOL bUseConfigurationFont);
604
605
606};
607
612[
613 object,
614 uuid(887a7b94-ad63-44c0-ac60-089ba873ceca),
615 dual,
616 oleautomation,
617 nonextensible,
618 helpstring("IEwProjectMultilingualTextX Interface"),
619 pointer_default(unique)
620]
622{
631 long getFileID (EwErrorCode* errorCode);
632
633
642 double getXPosition (EwErrorCode* errorCode);
643
644
653 EwErrorCode setXPosition (double dXCoordinate);
654
655
664 double getYPosition (EwErrorCode* errorCode);
665
666
675 EwErrorCode setYPosition (double dYCoordinate);
676
677
687 double getRotationAngle (EwErrorCode* errorCode);
688
689
700
701
712
713
723
724
734 BSTR getText (BSTR strLanguageCode, EwErrorCode* errorCode);
735
736
746 EwErrorCode setText (BSTR strLanguageCode, BSTR strNewText);
747
748
760
761
762};
763
768[
769 object,
770 uuid(dc9e2d75-82fe-4f77-a4f3-f98377e6162f),
771 dual,
772 oleautomation,
773 nonextensible,
774 pointer_default(unique)
775]
777{
785 INT_PTR getCount (EwErrorCode* errorCode);
786
787
796
797
808 IEwProjectMultilingualTextX findEwProjectMultilingualTextByID (LONG lEwProjectMultilingualTextXID, EwErrorCode* errorCode);
809
810
821 VARIANT getEwProjectMultilingualTextByFileIDArray (LONG lEwProjectMultilingualTextXFileID, EwErrorCode* errorCode);
822
823};
824
829[
830 object,
831 uuid(4ac92b54-1043-11e5-9493-1697f925ec7b),
832 dual,
833 oleautomation,
834 nonextensible,
835 helpstring("IEwProjectFileX Interface"),
836 pointer_default(unique)
837]
839{
840
852
853
863 BSTR getFilePath (EwErrorCode* errorCode);
864
865
875
876
886
887
892
893
904 LONG getPosition (EwErrorCode* errorCode);
905
906
907
908
920
921
934
935
952
953
970
971
972
983 VARIANT_BOOL isOpen (EwErrorCode* errorCode);
984
985
997
998
1010
1011
1024
1025
1042 EwErrorCode setOriginalFilePath (BSTR strFilePath, VARIANT_BOOL bAsShortCut);
1043
1044
1057
1058
1069 VARIANT_BOOL isLockByMe (EwErrorCode* errorCode);
1070
1071
1082 VARIANT_BOOL isLockedByAnother (EwErrorCode* errorCode);
1083
1084
1096
1097
1098
1099
1100
1101
1102
1103
1104
1116
1117
1130 EwErrorCode setEwProjectLocationID (long lID, VARIANT_BOOL bChangeInComponent);
1131
1132
1144
1145
1158 EwErrorCode setEwProjectFunctionID (long lID, VARIANT_BOOL bChangeInComponent);
1159
1160};
1161
1166[
1167 object,
1168 uuid(5C9A9148-129E-4FCC-AE6A-842C0F78C736),
1169 dual,
1170 nonextensible,
1171 helpstring("IEwProjectBookX Interface"),
1172 pointer_default(unique)
1173]
1175{
1187
1188
1201
1202
1214
1215
1228
1229};
1230
1235[
1236 object,
1237 uuid(BEBE7B8F-F07A-4F7B-B931-B206E6587E76),
1238 dual,
1239 oleautomation,
1240 nonextensible,
1241 helpstring("IEwProjectFileManagerX Interface"),
1242 pointer_default(unique)
1243]
1244interface IEwProjectFileManagerX : IDispatch {
1245
1253 INT_PTR getCount (EwErrorCode* errorCode);
1254
1255
1264
1265
1275 IEwProjectFileX findEwProjectFileByID (LONG lEwProjectFileID, EwErrorCode* errorCode);
1276
1277
1289
1290
1301
1302
1314
1315};
1316
1321[
1322 object,
1323 uuid(4227D81E-E027-43CF-89C4-D877A885BBB1),
1324 dual,
1325 oleautomation,
1326 nonextensible,
1327 helpstring("IEwProjectConfigurationX Interface"),
1328 pointer_default(unique)
1329]
1331{
1332
1333 /*
1334 * Get the name of the title block associated with a cabinet layout
1335 * \return Title block name
1336 */
1338
1339
1340 /*
1341 * Get the used measuremnt type.
1342 * \param[out] errorCode EwErrorCode enum type, can be:
1343 * \li EW_UNDEFINED_ERROR if another error occurred
1344 * \li EW_INVALID_OBJECT if object is not initialized
1345 * \li EW_NO_ERROR if no error detected
1346 * \return Measurement type
1347 */
1349
1350
1351 /*
1352 * Get the current language code.
1353 * \param[out] errorCode EwErrorCode enum type, can be:
1354 * \li EW_UNDEFINED_ERROR if another error occurred
1355 * \li EW_INVALID_OBJECT if object is not initialized
1356 * \return Language code
1357 * \li EW_NO_ERROR if no error detected
1358 */
1360
1361
1362 /*
1363 * Set a project configuration value.
1364 * \param[in] eProjectConfigurationValues The project configuration property you want to apply
1365 * \param[in] vValue The value you want to apply
1366 * \return EwErrorCode enum type, can be:
1367 * \li EW_UNDEFINED_ERROR if another error occurred
1368 * \li EW_INVALID_OBJECT if object is not initialized
1369 * \li EW_NO_ERROR if no error detected
1370 */
1371 EwErrorCode setEwProjectConfigValue (EwProjectConfigValue eProjectConfigurationValues, VARIANT vValue);
1372
1373
1374 /*
1375 * Get a project configuration value.
1376 * \param[in] eProjectConfigurationValues The project configuration property you want to get
1377 * \param[out] errorCode EwErrorCode enum type, can be:
1378 * \li EW_UNDEFINED_ERROR if another error occurred
1379 * \li EW_INVALID_OBJECT if object is not initialized
1380 * \li EW_BAD_INPUTS if the project configurations values does not exist
1381 * \li EW_NO_ERROR if no error detected
1382 * \return project configuration value
1383 */
1384 VARIANT getEwProjectConfigValue (EwProjectConfigValue eProjectConfigurationValues, EwErrorCode* errorCode);
1385
1386
1399
1400
1401
1412
1413};
1414
1419[
1420 object,
1421 uuid(F984331D-9550-492C-9804-C43D9A173CA1),
1422 dual,
1423 nonextensible,
1424 pointer_default(unique)
1425]
1426interface IEwProjectBookManagerX : IDispatch
1427{
1435 INT_PTR getCount (EwErrorCode* errorCode);
1436
1437
1446
1447
1457 IEwProjectBookX findEwProjectBookByID (LONG lEwProjectBookID, EwErrorCode* errorCode);
1458
1459
1468
1469};
1470
1475[
1476 object,
1477 uuid(10D11ED8-FB45-4A3E-ADF6-DC349B4ECBFF),
1478 dual,
1479 nonextensible,
1480 helpstring("IEwProjectFolder Interface"),
1481 pointer_default(unique)
1482]
1484{
1485
1495
1496
1497
1508
1509
1520
1521
1533
1534
1545
1546
1558
1559
1568 VARIANT_BOOL getDefineFirstDrawingNumber (EwErrorCode* errorCode);
1569
1570
1579 EwErrorCode setDefineFirstDrawingNumber (VARIANT_BOOL bDefineFirstDrawingNumber);
1580
1581
1590 LONG getPosition (EwErrorCode* errorCode);
1591
1592
1593};
1594
1595
1600[
1601 object,
1602 uuid(85158F93-1205-4614-ABC3-F3F19F9EDCDD),
1603 dual,
1604 nonextensible,
1605 pointer_default(unique)
1606]
1607interface IEwProjectFolderManagerX : IDispatch
1608{
1616 INT_PTR getCount (EwErrorCode* errorCode);
1617
1618
1627
1628
1638 IEwProjectFolderX findEwProjectFolderByID (LONG lEwProjectFolderID, EwErrorCode* errorCode);
1639
1640
1649
1650};
1651
1656[
1657 object,
1658 uuid(9442A4C0-D96C-4AAE-B679-C76877753635),
1659 dual,
1660 oleautomation,
1661 nonextensible,
1662 helpstring("IEwProjectX Interface"),
1663 pointer_default(unique)
1664]
1665interface IEwProjectX : IDispatch {
1666
1667
1668
1669
1675
1676
1686
1687
1697
1698
1708
1709
1718 IEwRoutingDataX getEwRoutingData (EwErrorCode* errorCode);
1719
1720
1730
1731
1741
1742
1752
1753
1754 /*
1755 * \return Get the ID of the project. -1 if the object is invalid
1756 */
1757 LONG getID ();
1758
1759
1769 EwErrorCode setName (BSTR strValue);
1770
1771
1780 BSTR getName (EwErrorCode* errorCode);
1781
1782
1792
1793
1802 BSTR getCustomerName (EwErrorCode* errorCode);
1803
1804
1814
1815
1825
1826
1836
1837
1847
1848
1858
1859
1869
1870
1880
1881
1891
1892
1902
1903
1913
1914
1924
1925
1935
1936
1946
1947
1957
1958
1968
1969
1979
1980
1981 /*
1982 * Update the object properties. If one of the properties has been modified, you must call this method to apply this modification.
1983 * Project must be opened to be able to call this method
1984 * \return EwErrorCode enum type, can be:
1985 * \li EW_UNDEFINED_ERROR default Error
1986 * \li EW_PROJECT_NOTOPENED Project not opened
1987 * \li EW_NO_ERROR if no error detected
1988 */
1990
1991
2003 EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
2004
2005
2016 BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
2017
2018
2032 EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
2033
2034
2046 BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
2047
2048
2058
2059
2069
2070
2080
2081
2092 VARIANT getMacroVariables (EwErrorCode* errorCode);
2093
2094
2105
2106
2115
2116
2117 /*
2118 * Remove the project. Project will be closed and mustn't be opened by someone else if you are using client and server installation.
2119 * \return EwErrorCode enum type, can be:
2120 * \li EW_UNDEFINED_ERROR if another error occurred
2121 * \li EW_INVALID_OBJECT if object is not valid
2122 * \li EW_PROJECT_NOTOPENED: project are close.
2123 * \li EW_CANNOT_REMOVE if project cannot be removed
2124 * \li EW_NO_PROJECT_OPENED_BY_SOMEONE_ELSE if project is opened on another computer by someone else
2125 * \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.
2126 * \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.
2127 * \li EW_DATABASE_CONNECTION_ERROR if connection to project database cannot be opened. You need to check the query log to investigate the reason.
2128 * \li EW_CANNOT_CLOSE_PROJECT if project cannot be closed
2129 * \li EW_NO_ERROR if no error detected
2130 */
2131 EwErrorCode remove ();
2132
2133
2142
2143
2152
2153
2163
2164
2174
2175
2184
2185
2193 EwErrorCode setExternID (BSTR strValue);
2194
2195
2203 BSTR getExternID (EwErrorCode* errorCode);
2204
2205
2215
2216
2227
2228
2237
2238
2249
2250
2262 BSTR getFolderPath (EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode* errorCode);
2263
2264
2275
2276
2287
2288
2299
2300
2311
2312
2323
2324
2335
2336
2347
2348
2359
2360
2369 BSTR getModifiedBy (EwErrorCode* eErrorCode);
2370
2371
2380
2381
2390
2391
2400 BSTR getCreatedBy (EwErrorCode* eErrorCode);
2401
2402
2413
2414
2426
2427
2438
2439
2450
2451
2463
2464
2465 /*
2466 * Insert new empty project.
2467 * \since 2023 SP0
2468 * \return EwErrorCode enum type, can be:
2469 * \li EW_UNDEFINED_ERROR if another error occurred
2470 * \li EW_INVALID_OBJECT if object is not valid
2471 * \li EW_OBJECT_ALREADY_INSERTED project already exists
2472 * \li EW_INSERTION_FAILED if the insertion failed
2473 * \li EW_NO_ERROR if no error detected
2474 */
2476
2477
2478 /*
2479 * Insert new project from template.
2480 * \since 2023 SP0
2481 * \param[in] strTemplateName template name of project to create
2482 * \return EwErrorCode enum type, can be:
2483 * \li EW_UNDEFINED_ERROR if another error occurred
2484 * \li EW_DOES_NOT_EXIST_ERROR if path of project template not exist
2485 * \li EW_BAD_INPUTS if project Template not exist
2486 * \li EW_INVALID_OBJECT if object is not valid
2487 * \li EW_OBJECT_ALREADY_INSERTED project already exists
2488 * \li EW_INSERTION_FAILED if the insertion failed
2489 * \li EW_NO_ERROR if no error detected
2490 */
2491 EwErrorCode insertFromTemplate (BSTR strTemplateName);
2492
2493
2494
2505
2506};
2507
2512[
2513 object,
2514 uuid(9A02A344-94BB-4F95-A133-45E09A42D6C5),
2515 dual,
2516 oleautomation,
2517 nonextensible,
2518 helpstring("IEwProjectManagerX Interface"),
2519 pointer_default(unique)
2520]
2521interface IEwProjectManagerX : IDispatch {
2522
2526 LONG getCount ();
2527
2528
2538 VARIANT getEwProjectArray (EwErrorCode* errorCode);
2539
2540
2550
2551
2560 IEwProjectX findEwProjectByName (BSTR strName, EwErrorCode* errorCode);
2561
2562
2574 EwErrorCode archive (VARIANT vProjectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies);
2575
2576
2587 VARIANT unarchive (BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode* errorCode);
2588
2589
2601 IEwProjectX findProjectFromFilePath (BSTR strFilePath, EwErrorCode* errorCode);
2602
2603
2614
2615
2625 EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings);
2626
2627
2638
2639}
2641
2642
EwMultilingualTextFont
Enum used to get the index of the text font used by one of the three languages defined in the project...
Definition: EnumDefinition.idl:444
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwProjectConfigValue
Values for project configuration.
Definition: EwEnumeration.idl:125
EwSymbolCrossRefType
All cross reference type of symbol.
Definition: EwEnumeration.idl:462
EwProjectType
Enumeration of type of project.
Definition: EwEnumeration.idl:1338
EwProjectFolderPathValue
Used with getFolderPath of EwProjectX object.
Definition: EwEnumeration.idl:54
EwSymbolType
All types of symbol.
Definition: EwEnumeration.idl:433
EwAlignmentType
Enumeration of type of Alignment.
Definition: EwEnumeration.idl:1366
EwFileType
File types used in a project.
Definition: EwEnumeration.idl:390
EwOpenProjectMode
All possible open modes for a project.
Definition: EwEnumeration.idl:478
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:284
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
Use this interface to manage the Origin Destination automatic insertion.
Definition: EwProjectProcessObjects.idl:594
Use this interface to manage IEwProjectBookX objects.
Definition: EwProjectObjects.idl:1427
IEwProjectBookX findEwProjectBookByID(LONG lEwProjectBookID, EwErrorCode *errorCode)
Get the EwProjectBook from the book ID, for associated project.
VARIANT getEwProjectBookArray(EwErrorCode *errorCode)
Return the array of IEwProjectBook of associated project.
IEwProjectBookX newEwProjectBook(EwErrorCode *errorCode)
Create a IEwProjectBookX object from the associated project.
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of books of associated project.
Use this interface to manage book inside a project.
Definition: EwProjectObjects.idl:1175
EwErrorCode setEwProjectFunctionID(long lID)
Set the EwProjectFunctionX ID associated to the book.
long getEwProjectLocationID(EwErrorCode *errorCode)
Get the ID of EwProjectLocationX associated to the book.
EwErrorCode setEwProjectLocationID(long lID)
Set the EwProjectLocationX ID associated to the book.
long getEwProjectFunctionID(EwErrorCode *errorCode)
Get the ID of EwProjectFunctionX associated to the book.
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:601
Use this interface to manage the components inside a project.
Definition: EwProjectComponentObjects.idl:952
Use this interface to manage configuration of the project.
Definition: EwProjectObjects.idl:1331
IEwProjectConfigurationX duplicate(EwErrorCode *errorCode)
Duplicate the current object.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
BSTR getCurrentCodeLanguage(EwErrorCode *errorCode)
EwErrorCode setEwProjectConfigValue(EwProjectConfigValue eProjectConfigurationValues, VARIANT vValue)
IEwProjectMultilingualTextFontX getEwProjectMultilingualTextFont(EwMultilingualTextFont eMultilingualTextFont, EwErrorCode *errorCode)
Return the IEwProjectMultilingualTextFontX interface object from the specified language index of the ...
VARIANT getEwProjectConfigValue(EwProjectConfigValue eProjectConfigurationValues, EwErrorCode *errorCode)
Use this interface to manage the Excel Automation inside the project.
Definition: EwProjectExportObjects.idl:1413
Use this interface to manage export DWG files inside a project.
Definition: EwProjectExportObjects.idl:646
Use this interface to export file in PDF inside a project.
Definition: EwProjectExportObjects.idl:1525
Use this interface to manage the command "Export to PDM".
Definition: EwProjectExportObjects.idl:756
Use this interface to manage the export reports used inside the project.
Definition: EwProjectExportObjects.idl:997
Use this interface to manage the file configuration.
Definition: EwProjectFileConfigurationObjects.idl:148
Use this interface to manage EwProjectFileManagerx objects.
Definition: EwProjectObjects.idl:1244
IEwProjectFileX newProjectFile(EwErrorCode *errorCode)
Create an IEwProjectFileX in the current project.
IEwProjectFileX findEwProjectFileByID(LONG lEwProjectFileID, EwErrorCode *errorCode)
Get the EwProjectFile from the file ID, for associated project.
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of files of associated project.
IEwProjectFileX findEwProjectFileFromPath(BSTR strFilePath, EwErrorCode *errorCode)
Get the EwProjectFile from a file path.
VARIANT getEwProjectFileArray(EwErrorCode *errorCode)
Return the array of IEwProjectFile of associated project.
VARIANT getEwProjectFileArrayFromFileType(EwFileType eFileType, EwErrorCode *errorCode)
Return the array of IEwProjectFileX of given type for associated project.
Use this interface to manage file inside a project.
Definition: EwProjectObjects.idl:839
VARIANT_BOOL isLockByMe(EwErrorCode *errorCode)
Return true if the project file is lock by me.
EwFileType getFileType()
EwErrorCode setFileType(EwFileType eFileType)
Set the file type of the current project file.
long getEwProjectLocationID(EwErrorCode *errorCode)
Get the ID of EwProjectLocationX associated to the file.
LONG getPosition(EwErrorCode *errorCode)
Get the position of files inside a book/folder.
EwErrorCode setEwProjectFunctionID(long lID, VARIANT_BOOL bChangeInComponent)
Set the EwProjectFunctionX ID associated to the file.
EwErrorCode open()
Open the project file.
BSTR getFilePath(EwErrorCode *errorCode)
Return the file path.
EwErrorCode setEwProjectBookID(LONG lID)
Set the Book ID of this file.
IEwProjectLocationX getEwProjectLocation(EwErrorCode *errorCode)
IEwProjectLocationX associated with the file.
LONG getEwProjectBookID(EwErrorCode *errorCode)
Get the ID of the book containing this file.
VARIANT_BOOL isOpen(EwErrorCode *errorCode)
Return true if the project file is open.
IEwProjectMultilingualTextX newEwProjectMultilingualText(EwErrorCode *errorCode)
Create a multilingual text associated with this file.
EwErrorCode setEwProjectLocationID(long lID, VARIANT_BOOL bChangeInComponent)
Set the EwProjectLocationX by ID associated to the file.
EwErrorCode lock()
Lock the file so no one connected to the collaborative server can edit or delete it.
EwErrorCode setEwProjectFolderID(LONG lID)
Set the folder ID as parent for this file.
long getEwProjectFunctionID(EwErrorCode *errorCode)
Get the ID of EwProjectFunctionX associated to the file.
EwErrorCode close()
Close the project file.
EwErrorCode setOriginalFilePath(BSTR strFilePath, VARIANT_BOOL bAsShortCut)
Specify the path of the file to add in the project.
VARIANT_BOOL isLockedByAnother(EwErrorCode *errorCode)
Return true if the project file is lock by another.
LONG getEwProjectFolderID(EwErrorCode *errorCode)
Get the ID of the folder containing this file.
BSTR getTargetFilePath(EwErrorCode *errorCode)
Return the path to a file not only a reference to a *.lnk.
EwErrorCode unlock()
Unlock the file.
Use this interface to manage IEwProjectFolderX objects.
Definition: EwProjectObjects.idl:1608
IEwProjectFolderX newEwProjectFolder(EwErrorCode *errorCode)
Create a IEwProjectFolderX object from the associated project.
VARIANT getEwProjectFolderArray(EwErrorCode *errorCode)
Return the array of IEwProjectFolder of associated project.
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of Folders of associated project.
IEwProjectFolderX findEwProjectFolderByID(LONG lEwProjectFolderID, EwErrorCode *errorCode)
Get the EwProjectFolder from the Folder ID of associated project.
Use this interface to manage folder inside a project.
Definition: EwProjectObjects.idl:1484
EwErrorCode setEwProjectBookID(LONG lID)
Update the ID of the book containing this folder.
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 setEwProjectFolderID(LONG lID)
Update the folder ID of the parent folder.
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...
LONG getEwProjectBookID(EwErrorCode *errorCode)
Get the ID of the book containing this folder.
LONG getFirstDrawingNumber(EwErrorCode *errorCode)
Get the number of the first drawing that will be created in this folder.
LONG getEwProjectFolderID(EwErrorCode *errorCode)
Get the ID of the folder containing this folder.
LONG getPosition(EwErrorCode *errorCode)
Get the position of the folder in the book.
EwErrorCode setFirstDrawingNumber(LONG lID)
Set the number of the first drawing that will be created in this folder.
Use this interface to manage IEwProjectFunctionX objects.
Definition: EwProjectFunctionObjects.idl:56
Use this interface to manage the generation of terminal strip drawing inside the project.
Definition: EwProjectExportObjects.idl:1335
Use this interface to manage the Harness objects inside a project.
Definition: EwProjectHarnessObjects.idl:129
Use this interface to manage IEwProjectInputOutputX objects.
Definition: EwProjectInputOutputObjects.idl:235
Use this interface to manage the location objects inside a project.
Definition: EwProjectLocationObjects.idl:63
Use this interface to manage the location inside a project.
Definition: EwProjectLocationObjects.idl:27
Use this interface to manage IEwProjectX objects.
Definition: EwProjectObjects.idl:2521
IEwProjectX findEwProjectByID(LONG lId, EwErrorCode *errorCode)
Look for a project from an ID.
EwErrorCode setGenerateAutomatedDrawings(VARIANT_BOOL bGenerateAutomatedDrawings)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
VARIANT_BOOL getGenerateAutomatedDrawings(EwErrorCode *errorCode)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
VARIANT getEwProjectArray(EwErrorCode *errorCode)
Return the array of IEwProjectX.
IEwProjectX newEwProject(EwErrorCode *errorCode)
Create an new IEwProjectX object that correspond at electrical project.
VARIANT unarchive(BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode *errorCode)
Unarchive projects.
IEwProjectX findEwProjectByName(BSTR strName, EwErrorCode *errorCode)
Look for the first project from a name.
IEwProjectX findProjectFromFilePath(BSTR strFilePath, EwErrorCode *errorCode)
Return an IEwProjectX from a file path.
EwErrorCode archive(VARIANT vProjectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies)
Archive projects.
Use this interface to manage IEwProjectManufacturerPartX objects.
Definition: EwProjectManufacturerPartObjects.idl:1012
Use this interface to manage a Multilingual Text Font inside a project.
Definition: EwProjectObjects.idl:469
EwErrorCode setProjectConfigurationFontUsed(VARIANT_BOOL bUseConfigurationFont)
Set true to use font project configuration, apply only on EwProjectMultilingualText.
VARIANT_BOOL isUnderline(EwErrorCode *errorCode)
Return true if the underline is used.
VARIANT_BOOL isBold(EwErrorCode *errorCode)
Return true if the bold is used.
EwErrorCode setUnderline(VARIANT_BOOL bUnderline)
Set true to use underline.
EwErrorCode setBold(VARIANT_BOOL bBold)
Set true to use bold.
EwErrorCode setItalic(VARIANT_BOOL bItalic)
Set true to use italic.
long getObjectID(EwErrorCode *errorCode)
Return the Object ID associated with the IEwProjectMultilingualTextFontX.
EwErrorCode setHeight(double dHeight)
Set the height of the Text Font.
double getHeight(EwErrorCode *errorCode)
Return the height of the Text Font.
BSTR getFont(EwErrorCode *errorCode)
Return the font of the Text Font.
VARIANT_BOOL isProjectConfigurationFontUsed(EwErrorCode *errorCode)
Return true if the font project configuration is used.
VARIANT_BOOL isItalic(EwErrorCode *errorCode)
Return true if the italic is used.
Use this interface to manage IEwProjectMultilingualTextManagerX objects.
Definition: EwProjectObjects.idl:777
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of Multilingual Text of associated project.
VARIANT getEwProjectMultilingualTextByFileIDArray(LONG lEwProjectMultilingualTextXFileID, EwErrorCode *errorCode)
Return the array of IEwProjectMultilingualTextX from one file, for associated project.
VARIANT getEwProjectMultilingualTextArray(EwErrorCode *errorCode)
Return the array of IEwProjectMultilingualTextX of associated project.
IEwProjectMultilingualTextX findEwProjectMultilingualTextByID(LONG lEwProjectMultilingualTextXID, EwErrorCode *errorCode)
Get the IEwProjectMultilingualTextX from the ID, for associated project.
Use this interface to manage a Multilingual Text inside a project.
Definition: EwProjectObjects.idl:622
EwErrorCode setText(BSTR strLanguageCode, BSTR strNewText)
Sets the Text from the specified language code of the Multilingual Text.
EwErrorCode setYPosition(double dYCoordinate)
Sets the Y coordinate of the Multilingual Text.
IEwProjectMultilingualTextFontX getEwProjectMultilingualTextFont(EwMultilingualTextFont eMultilingualTextFont, EwErrorCode *errorCode)
Return the IEwProjectMultilingualTextFontX interface object from the specified language index of the ...
EwErrorCode setRotationAngle(double dAngle)
Set the rotation angle in degrees of the Multilingual Text.
double getXPosition(EwErrorCode *errorCode)
Return the X coordinate of the Multilingual Text.
EwErrorCode setEwAlignmentType(EwAlignmentType eAlignmentType)
Set the Alignement type of the Multilingual Text.
BSTR getText(BSTR strLanguageCode, EwErrorCode *errorCode)
Return the Text from the specified language code of the Multilingual Text.
EwAlignmentType getEwAlignmentType(EwErrorCode *errorCode)
Return the EwAlignmentType enum type of the Multilingual Text.
double getRotationAngle(EwErrorCode *errorCode)
Return the rotation angle in degrees of the Multilingual Text.
double getYPosition(EwErrorCode *errorCode)
Return the Y coordinate of the Multilingual Text.
EwErrorCode setXPosition(double dXCoordinate)
Sets the X coordinate of the Multilingual Text.
long getFileID(EwErrorCode *errorCode)
Return the file ID containing the Multilingual Text.
Use this interface to manage the renumber documents.
Definition: EwProjectProcessObjects.idl:777
Use this interface to manage the renumber marks.
Definition: EwProjectProcessObjects.idl:414
Use this interface to manage the numbering or renumbering of wires.
Definition: EwProjectProcessObjects.idl:299
Use this interface to manage the optimize wire order.
Definition: EwProjectProcessObjects.idl:938
Use this interface to manage a print configuration manager inside a project.
Definition: EwProjectExportObjects.idl:501
Use this interface to manage for reports used inside the project.
Definition: EwProjectExportObjects.idl:927
Use this interface to manage snapshot manager inside a project.
Definition: EwProjectProcessObjects.idl:191
Use this interface to manage IEwProjectSymbolManagerX objects.
Definition: EwProjectObjects.idl:428
IEwProjectSymbolX getProjectSymbolByID(LONG lID, EwErrorCode *errorCode)
return a Project Symbol by ID.
VARIANT getProjectSymbolsFromFileID(LONG lID, EwErrorCode *errorCode)
Return the array of symbols of the associated project file identifier.
Use this interface to manage symbol inside a project.
Definition: EwProjectObjects.idl:54
double getXScale(EwErrorCode *errorCode)
Return the X scale of the symbol.
EwSymbolType getEwSymbolType(EwErrorCode *errorCode)
Return the type of the symbol.
double getYPosition(EwErrorCode *errorCode)
Return the Y coordinate of the symbol.
BSTR getAssociatedMacro(EwErrorCode *errorCode)
Return the associated macro of the symbol.
long getEwProjectFunctionID(EwErrorCode *errorCode)
Get the ID of EwProjectFunctionX associated at the symbol.
double getXPosition(EwErrorCode *errorCode)
Return the X coordinate of the symbol.
long getEwProjectLocationID(EwErrorCode *errorCode)
Get the ID of EwProjectLocationX associated at symbol.
double getYScale(EwErrorCode *errorCode)
Return the Y scale of the symbol.
BSTR getColumnMark(EwErrorCode *errorCode)
Return the column mark of the symbol.
EwErrorCode setObjectID(long lID)
Sets the Object associated with the symbol.
EwErrorCode setRotationAngle(double dAngle)
Set the rotation angle in degrees of the symbol.
long getFileID(EwErrorCode *errorCode)
Return the file ID containing the symbol.
long getManufacturerPartID(EwErrorCode *errorCode)
Return the ManufacturerPart ID associated with the symbol.
BSTR getRowMark(EwErrorCode *errorCode)
Return the row mark of the symbol.
EwErrorCode setYScale(double dYScale)
Sets the Y scale of the symbol.
long getFunctionID(EwErrorCode *errorCode)
Return the Function ID to the symbol.
EwErrorCode setXPosition(double dXCoordinate)
Sets the X coordinate of the symbol.
EwSymbolCrossRefType getEwSymbolCrossRefType(EwErrorCode *errorCode)
Return the cross reference type of the symbol.
EwErrorCode setXScale(double dXScale)
Sets the X scale of the symbol.
EwErrorCode setEwSymbolName(BSTR strSymbolName)
Sets the symbol name of the symbol.
long getLocationID(EwErrorCode *errorCode)
Return the Location ID of the symbol.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Return the measurement type of the symbol.
BSTR getEwSymbolName(EwErrorCode *errorCode)
Return the symbol name of the symbol in the library.
EwErrorCode setEwProjectLocationID(long lID)
Set the EwProjectLocationX by ID associated at symbol.
double getRotationAngle(EwErrorCode *errorCode)
Return the rotation angle in degrees of the symbol.
EwErrorCode setEwMeasurementType(EwMeasurementType eMeasurementType)
Set the measurement type of the symbol.
EwErrorCode setYPosition(double dYCoordinate)
Sets the Y coordinate of the symbol.
long getObjectID(EwErrorCode *errorCode)
EwErrorCode setEwProjectFunctionID(long lID)
Set the EwProjectFunctionX ID associated at symbol.
Generic interface for an object that belongs to a project.
Definition: EwObjectBaseObjects.idl:118
Use this interface to manage the update of project data from libraries.
Definition: EwProjectProcessObjects.idl:252
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:523
Use this interface to manage IEwProjectWireStyleX objects.
Definition: EwProjectWireObjects.idl:1293
Use this interface to manage a project.
Definition: EwProjectObjects.idl:1665
IEwProjectMultilingualTextManagerX getEwProjectMultilingualTextManager(EwErrorCode *errorCode)
Get an IEwProjectMultilingualTextManagerX to manage Project Multilingual Text of this project.
EwErrorCode setExternID(BSTR strValue)
Set the externID field in the project.
IEwProjectWireManagerX getEwProjectWireManager(EwErrorCode *errorCode)
To get the project wire manager.
IEwProjectExportReportX newEwProjectExportReport(EwErrorCode *errorCode)
Create an IEwProjectExportReportX object from the associated project.
EwErrorCode setName(BSTR strValue)
Set the name of the project.
IEwProjectSnapshotManagerX getEwProjectSnapshotManager(EwErrorCode *errorCode)
Get an IEwProjectSnapshotManagerX to manage snapshots of this project.
IEwProjectFunctionManagerX getEwProjectFunctionManager(EwErrorCode *errorCode)
Get an IEwProjectFunctionManagerX to manage Functions of this project.
IEwProjectFileManagerX getEwProjectFileManager(EwErrorCode *errorCode)
Get an IEwProjectFileManagerX to manage files of this project.
IEwProjectReportManagerX getEwProjectReportManager(EwErrorCode *errorCode)
Get an IEwProjectReportManagerX to manage reports of this project.
BSTR getCreoFolderPath(EwErrorCode *errorCode)
IEwProjectOptimizeWireOrderX newEwProjectOptimizeWireOrder(EwErrorCode *errorCode)
Create an IEwProjectOptimizeWireOrderX to optimize the wire order of this project.
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object Project must be opened to be able to call this method.
EwErrorCode setCustomerAddress1(BSTR strValue)
Set the customer address 1 of the project.
IEwProjectFolderManagerX getEwProjectFolderManager(EwErrorCode *errorCode)
Get an IEwProjectFolderManagerX to manage Folders of this project.
BSTR getExternID(EwErrorCode *errorCode)
Get the externID of the project.
LONG getID()
EwErrorCode insert()
BSTR getDrawingOfficeAddress3(EwErrorCode *errorCode)
Get the drawing office address 3 of the project.
IEwProjectFileConfigurationManagerX getEwProjectFileConfigurationManager(EwErrorCode *errorCode)
Get an IEwProjectFileConfigurationManagerX to manage Project Report Configuration.
IEwProjectSymbolManagerX getEwProjectSymbolManager(EwErrorCode *errorCode)
Get an IEwProjectSymbolManagerX to manage ProjectSymbolManager of this project.
IEwProjectUpdateReplaceDataX getEwProjectUpdateData(EwErrorCode *errorCode)
Get an IEwProjectUpdateReplaceDataX to manage the update or replacedata of this project.
IEwProjectNumberWiresX newEwProjectNumberWires(EwErrorCode *errorCode)
Create an IEwProjectNumberWiresX to manage the numbering or the renumbering wires of this project.
EwErrorCode setDrawingOfficeAddress1(BSTR strValue)
Set the drawing office address 1 of the project.
IEwProjectExportDWGFilesX newEwProjectExportDWGFiles(EwErrorCode *errorCode)
Create an IEwProjectExportDWGFilesX object from the associated project.
IEwProjectLocationManagerX getEwProjectLocationManager(EwErrorCode *errorCode)
Get an IEwProjectLocationManagerX to manage locations of this project.
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.
BSTR getCustomerAddress1(EwErrorCode *errorCode)
Get the customer address 1 of the project.
IEwProjectNumberMarksX newEwProjectNumberMarks(EwErrorCode *errorCode)
Create an IEwProjectNumberMarksX to manage the renumbering marks of this project.
BSTR getPreviewFilePath(EwErrorCode *errorCode)
Get the path of the first file of the project for the preview.
IEwProjectInputOutputManagerX getEwProjectInputOutputManager(EwErrorCode *errorCode)
Get an IEwProjectInputOutputManagerX to manage ProjectInputOutput of this project.
BSTR getCustomerName(EwErrorCode *errorCode)
Get the name of the customer of the project.
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
IEwProjectPrintConfigManagerX getEwProjectPrintConfigManager(EwErrorCode *errorCode)
Get an IEwProjectPrintConfigManagerX to manage print config of this project.
BSTR getFolderPath(EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode *errorCode)
Return folder path associated to the current project.
IEwProjectCableManagerX getEwProjectCableManager(EwErrorCode *errorCode)
To get the cable manager.
BSTR getCustomerAddress2(EwErrorCode *errorCode)
Get the customer address 2 of the project.
IEwProjectComponentManagerX getEwProjectComponentManager(EwErrorCode *errorCode)
Get an IEwProjectComponentManagerX to manage components of this project.
EwProjectType getProjectType(EwErrorCode *errorCode)
Get an EwProjectType enum type, can be EwProjectType.kProject for a project or EwProjectType....
IEwProjectExportPDFX newEwProjectExportPDF(EwErrorCode *errorCode)
Create an IEwProjectExportPDFX object from the associated project.
IEwProjectExcelAutomationX newEwProjectExcelAutomation(EwErrorCode *errorCode)
Create an IEwProjectExcelAutomationX object from the associated project.
IEwProjectGenerateTSDrawingX newEwProjectGenerateTSDrawing(EwErrorCode *errorCode)
Create an IEwProjectGenerateTSDrawingX object to draw terminal strip in a project.
EwErrorCode setContractNumber(BSTR strValue)
Set the contract number of the project.
DATE getModificationDate(EwErrorCode *errorCode)
Get the modification date of the project.
EwErrorCode close()
close the project
IEwProjectNumberDocumentsX newEwProjectNumberDocumments(EwErrorCode *errorCode)
Create an IEwProjectNumberDocumentsX to manage the renumbering document marks of this project.
IEwProjectExportPDMX newEwProjectExportPDM(EwErrorCode *errorCode)
Create an IEwProjectExportPDMX object from the associated project.
EwErrorCode setDrawingOfficeAddress3(BSTR strValue)
Set the drawing office address 3 of the project.
IEwProjectWireStyleManagerX getEwProjectWireStyleManagerX(EwErrorCode *errorCode)
Get an IEwProjectWireStyleManagerX to manage project wire style.
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object Project must be opened to be able to call this method.
EwErrorCode setDrawingOfficeAddress2(BSTR strValue)
Set the drawing office address 2 of the project.
EwErrorCode setCustomerName(BSTR strValue)
Set the name of the customer of the project.
EwErrorCode setCustomerAddress3(BSTR strValue)
Set the customer address 3 of the project.
BSTR getDrawingOfficeAddress1(EwErrorCode *errorCode)
Get the drawing office address 1 of the project.
EwErrorCode setCustomerAddress2(BSTR strValue)
Set the customer address 2 of the project.
VARIANT getMacroVariables(EwErrorCode *errorCode)
Get an array of strings of the automation variables of the project, usually a macro.
BSTR getCreatedBy(EwErrorCode *eErrorCode)
Get the user name that created the current object.
IEwProjectAutomaticArrowsX newEwProjectAutomaticArrows(EwErrorCode *errorCode)
Create an IEwProjectAutomaticArrowsX to manage the Origin Destination automatic insertion.
EwErrorCode open(EwOpenProjectMode eOpenMode)
open the project
BSTR getDrawingOfficeAddress2(EwErrorCode *errorCode)
Get the drawing office address 2 of the project.
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
IEwProjectConfigurationX getEwProjectConfiguration(EwErrorCode *errorCode)
To get the project configuration.
BSTR getContractNumber(EwErrorCode *errorCode)
Get the contract number of the project.
EwErrorCode setDrawingOfficeName(BSTR strValue)
Set the Drawing office name of the project.
BSTR getDrawingOfficeName(EwErrorCode *errorCode)
Get the drawing office name of the project.
BSTR getName(EwErrorCode *errorCode)
Get the name of the project.
EwErrorCode insertFromTemplate(BSTR strTemplateName)
BSTR getCustomerAddress3(EwErrorCode *errorCode)
Get the customer address 3 of the project.
IEwProjectManufacturerPartManagerX getEwProjectManufacturerPartManager(EwErrorCode *errorCode)
Get an IEwProjectManufacturerPartManagerX to manage Builds of Materials of this project.
EwErrorCode update()
IEwRoutingDataX getEwRoutingData(EwErrorCode *errorCode)
To get the routing data manager.
IEwProjectBookManagerX getEwProjectBookManager(EwErrorCode *errorCode)
Get an IEwProjectBookManagerX to manage Books of this project.
IEwProjectHarnessManagerX getEwProjectHarnessManager(EwErrorCode *errorCode)
Get an IEwProjectHarnessManagerX to manage Harness of this project.


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) 2024 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.