Hide Table of Contents
SOLIDWORKS Electrical API 2023.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 "EwProjectWireObjects.idl";
16import "EwProjectCableObjects.idl";
17import "EwProjectEntity3DObjects.idl";
18import "EwProjectHarnessObjects.idl";
19import "EwProjectExportObjects.idl";
20import "EwProjectProcessObjects.idl";
21import "EwProjectInputOutputObjects.idl";
22import "EwProjectFileConfigurationObjects.idl";
23
24
25/************************************************************************/
26/* In his file, all PROJECT object */
27/************************************************************************/
28
29
30/************************************************************************/
31/* ENUMERATION */
32/************************************************************************/
33
34/************************************************************************/
35/* INTERFACES */
36/************************************************************************/
37
39
43[
44 object,
45 uuid(B13AD024-81E0-41C8-ADCA-518E347AAAE9),
46 dual,
47 oleautomation,
48 nonextensible,
49 helpstring("IEwProjectSymbolX Interface"),
50 pointer_default(unique)
51]
53{
62 long getFileID (EwErrorCode* errorCode);
63
64
74 long getLocationID (EwErrorCode* errorCode);
75
76
77
87 long getFunctionID (EwErrorCode* errorCode);
88
89
98 BSTR getEwSymbolName (EwErrorCode* errorCode);
99
100
109 EwErrorCode setEwSymbolName (BSTR strSymbolName);
110
111
121 long getObjectID (EwErrorCode* errorCode);
122
123
134
135
145
146
156
157
167
168
178
179
189
190
199 double getXPosition (EwErrorCode* errorCode);
200
201
210 EwErrorCode setXPosition (double dXCoordinate);
211
212
221 double getYPosition (EwErrorCode* errorCode);
222
223
232 EwErrorCode setYPosition (double dYCoordinate);
233
234
244
245
254 BSTR getColumnMark (EwErrorCode* errorCode);
255
256
265 BSTR getRowMark (EwErrorCode* errorCode);
266
267
268
278 double getRotationAngle (EwErrorCode* errorCode);
279
280
291
292
301 EwErrorCode setYScale (double dYScale);
302
303
312 double getYScale (EwErrorCode* errorCode);
313
314
323 double getXScale (EwErrorCode* errorCode);
324
325
334 EwErrorCode setXScale (double dXScale);
335
336
337
338
339
340
341
342
343};
344
345
350[
351 object,
352 uuid(06DD51E2-79F7-4148-9F53-02932E9A2D44),
353 dual,
354 oleautomation,
355 nonextensible,
356 pointer_default(unique)
357]
358interface IEwProjectSymbolManagerX : IDispatch
359{
369
370};
371
376[
377 object,
378 uuid(353a273d-09b7-467e-bde5-fc5e9d9d49da),
379 dual,
380 oleautomation,
381 nonextensible,
382 helpstring("IEwProjectMultilingualTextFontX Interface"),
383 pointer_default(unique)
384]
386{
396 long getObjectID (EwErrorCode* errorCode);
397
398
407 BSTR getFont (EwErrorCode* errorCode);
408
409
410
419 VARIANT_BOOL isBold (EwErrorCode* errorCode);
420
421
430 EwErrorCode setBold (VARIANT_BOOL bBold);
431
432
441 VARIANT_BOOL isItalic (EwErrorCode* errorCode);
442
443
452 EwErrorCode setItalic (VARIANT_BOOL bItalic);
453
454
463 VARIANT_BOOL isUnderline (EwErrorCode* errorCode);
464
465
474 EwErrorCode setUnderline (VARIANT_BOOL bUnderline);
475
476
485 double getHeight (EwErrorCode* errorCode);
486
487
497 EwErrorCode setHeight (double dHeight);
498
499
509
510
520 EwErrorCode setProjectConfigurationFontUsed (VARIANT_BOOL bUseConfigurationFont);
521
522
523};
524
529[
530 object,
531 uuid(887a7b94-ad63-44c0-ac60-089ba873ceca),
532 dual,
533 oleautomation,
534 nonextensible,
535 helpstring("IEwProjectMultilingualTextX Interface"),
536 pointer_default(unique)
537]
539{
548 long getFileID (EwErrorCode* errorCode);
549
550
559 double getXPosition (EwErrorCode* errorCode);
560
561
570 EwErrorCode setXPosition (double dXCoordinate);
571
572
581 double getYPosition (EwErrorCode* errorCode);
582
583
592 EwErrorCode setYPosition (double dYCoordinate);
593
594
604 double getRotationAngle (EwErrorCode* errorCode);
605
606
617
618
628 EwErrorCode setEwAlignmentType (EwAlignmentType eAlignmentType);
629
630
639 EwAlignmentType getEwAlignmentType (EwErrorCode* errorCode);
640
641
651 BSTR getText (BSTR strLanguageCode, EwErrorCode* errorCode);
652
653
663 EwErrorCode setText (BSTR strLanguageCode, BSTR strNewText);
664
665
677
678
679};
680
685[
686 object,
687 uuid(dc9e2d75-82fe-4f77-a4f3-f98377e6162f),
688 dual,
689 oleautomation,
690 nonextensible,
691 pointer_default(unique)
692]
694{
702 INT_PTR getCount (EwErrorCode* errorCode);
703
704
713
714
725 IEwProjectMultilingualTextX findEwProjectMultilingualTextByID (LONG lEwProjectMultilingualTextXID, EwErrorCode* errorCode);
726
727
738 VARIANT getEwProjectMultilingualTextByFileIDArray (LONG lEwProjectMultilingualTextXFileID, EwErrorCode* errorCode);
739
740
741};
742
747[
748 object,
749 uuid(4ac92b54-1043-11e5-9493-1697f925ec7b),
750 dual,
751 oleautomation,
752 nonextensible,
753 helpstring("IEwProjectFileX Interface"),
754 pointer_default(unique)
755]
757{
758
770
771
772
782 BSTR getFilePath (EwErrorCode* errorCode);
783
784
794
795
805
806
811
812
823 LONG getPosition (EwErrorCode* errorCode);
824
825
826
827
828
840
841
854
855
872
873
890
891
892
903 VARIANT_BOOL isOpen (EwErrorCode* errorCode);
904
905
917
918
930
931
944
945
962 EwErrorCode setOriginalFilePath (BSTR strFilePath, VARIANT_BOOL bAsShortCut);
963
964
977
978
989 VARIANT_BOOL isLockByMe (EwErrorCode* errorCode);
990
991
1002 VARIANT_BOOL isLockedByAnother (EwErrorCode* errorCode);
1003
1004
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028};
1029
1034[
1035 object,
1036 uuid(5C9A9148-129E-4FCC-AE6A-842C0F78C736),
1037 dual,
1038 nonextensible,
1039 helpstring("IEwProjectBookX Interface"),
1040 pointer_default(unique)
1041]
1043{
1044
1045};
1046
1051[
1052 object,
1053 uuid(743809C9-28AA-409F-B8F3-50907C2B68EC),
1054 dual,
1055 nonextensible,
1056 helpstring("IEwProjectFunctionX Interface"),
1057 pointer_default(unique)
1058]
1060{
1069 BSTR getTagPath (EwErrorCode* errorCode);
1070
1071
1072};
1073
1074
1079[
1080 object,
1081 uuid(BEBE7B8F-F07A-4F7B-B931-B206E6587E76),
1082 dual,
1083 oleautomation,
1084 nonextensible,
1085 helpstring("IEwProjectFileManagerX Interface"),
1086 pointer_default(unique)
1087]
1088interface IEwProjectFileManagerX : IDispatch {
1089
1097 INT_PTR getCount (EwErrorCode* errorCode);
1098
1099
1108
1109
1119 IEwProjectFileX findEwProjectFileByID (LONG lEwProjectFileID, EwErrorCode* errorCode);
1120
1121
1133
1134
1145
1146
1158
1159};
1160
1165[
1166 object,
1167 uuid(4227D81E-E027-43CF-89C4-D877A885BBB1),
1168 dual,
1169 oleautomation,
1170 nonextensible,
1171 helpstring("IEwProjectConfigurationX Interface"),
1172 pointer_default(unique)
1173]
1175{
1176
1177 /*
1178 * Get the name of the title block associated with a cabinet layout
1179 * \return Title block name
1180 */
1182
1183
1184 /*
1185 * Get the used measuremnt type
1186 * \param[out] errorCode EwErrorCode enum type, can be:
1187 * \li EW_NO_ERROR if no error detected
1188 * \li EW_UNDEFINED_ERROR if another error occurred
1189 * \li EW_INVALID_OBJECT if object is not initialized
1190 * \return Measurement type
1191 */
1193
1194
1195 /*
1196 * Get the current language code
1197 * \param[out] errorCode EwErrorCode enum type, can be:
1198 * \li EW_NO_ERROR if no error detected
1199 * \li EW_UNDEFINED_ERROR if another error occurred
1200 * \li EW_INVALID_OBJECT if object is not initialized
1201 * \return Language code
1202 */
1204
1205
1206 /*
1207 * Set a project configuration value
1208 * \param[in] eProjectConfigurationValues The project configuration property you want to apply
1209 * \param[in] vValue The value you want to apply
1210 * \return EwErrorCode enum type, can be:
1211 * \li EW_NO_ERROR if no error detected
1212 * \li EW_UNDEFINED_ERROR if another error occurred
1213 * \li EW_INVALID_OBJECT if object is not initialized
1214 */
1215 EwErrorCode setEwProjectConfigValue (EwProjectConfigValue eProjectConfigurationValues, VARIANT vValue);
1216
1217
1218
1219 /*
1220 * Get a project configuration value
1221 * \param[in] eProjectConfigurationValues The project configuration property you want to get
1222 * \param[out] errorCode EwErrorCode enum type, can be:
1223 * \li EW_NO_ERROR if no error detected
1224 * \li EW_UNDEFINED_ERROR if another error occurred
1225 * \li EW_BAD_INPUTS if the project configurations values does not exist
1226 * \li EW_INVALID_OBJECT if object is not initialized
1227 * \return project configuration value
1228 */
1229 VARIANT getEwProjectConfigValue (EwProjectConfigValue eProjectConfigurationValues, EwErrorCode* errorCode);
1230
1231
1232
1245
1246};
1247
1252[
1253 object,
1254 uuid(F984331D-9550-492C-9804-C43D9A173CA1),
1255 dual,
1256 nonextensible,
1257 pointer_default(unique)
1258]
1259interface IEwProjectBookManagerX : IDispatch
1260{
1261
1269 INT_PTR getCount (EwErrorCode* errorCode);
1270
1271
1280
1281
1291 IEwProjectBookX findEwProjectBookByID (LONG lEwProjectBookID, EwErrorCode* errorCode);
1292
1293
1302
1303};
1304
1309[
1310 object,
1311 uuid(41B046AD-FD19-4184-B6E7-A67E80FFD48F),
1312 dual,
1313 nonextensible,
1314 pointer_default(unique)
1315]
1316interface IEwProjectFunctionManagerX : IDispatch
1317{
1325 INT_PTR getCount (EwErrorCode* errorCode);
1326
1327
1336
1337
1347 IEwProjectFunctionX findEwProjectFunctionByID (LONG lEwProjectFunctionID, EwErrorCode* errorCode);
1348
1349
1358
1359};
1360
1361
1366[
1367 object,
1368 uuid(10D11ED8-FB45-4A3E-ADF6-DC349B4ECBFF),
1369 dual,
1370 nonextensible,
1371 helpstring("IEwProjectFolder Interface"),
1372 pointer_default(unique)
1373]
1375{
1376
1386
1387
1388
1399
1400
1411
1412
1424
1425
1436
1437
1449
1450
1459 VARIANT_BOOL getDefineFirstDrawingNumber (EwErrorCode* errorCode);
1460
1461
1470 EwErrorCode setDefineFirstDrawingNumber (VARIANT_BOOL bDefineFirstDrawingNumber);
1471
1472
1481 LONG getPosition (EwErrorCode* errorCode);
1482
1483
1484};
1485
1486
1491[
1492 object,
1493 uuid(85158F93-1205-4614-ABC3-F3F19F9EDCDD),
1494 dual,
1495 nonextensible,
1496 pointer_default(unique)
1497]
1498interface IEwProjectFolderManagerX : IDispatch
1499{
1507 INT_PTR getCount (EwErrorCode* errorCode);
1508
1509
1518
1519
1529 IEwProjectFolderX findEwProjectFolderByID (LONG lEwProjectFolderID, EwErrorCode* errorCode);
1530
1531
1540
1541};
1542
1543
1548[
1549 object,
1550 uuid(9442A4C0-D96C-4AAE-B679-C76877753635),
1551 dual,
1552 oleautomation,
1553 nonextensible,
1554 helpstring("IEwProjectX Interface"),
1555 pointer_default(unique)
1556]
1557interface IEwProjectX : IDispatch {
1558
1559
1560
1561
1567
1568
1578
1579
1589
1590
1600
1601
1610 IEwRoutingDataX getEwRoutingData (EwErrorCode* errorCode);
1611
1612
1622
1623
1633
1634
1644
1645
1646 /*
1647 * \return Get the ID of the project. -1 if the object is invalid
1648 */
1649 LONG getID ();
1650
1651
1661 EwErrorCode setName (BSTR strValue);
1662
1663
1672 BSTR getName (EwErrorCode* errorCode);
1673
1674
1684
1685
1694 BSTR getCustomerName (EwErrorCode* errorCode);
1695
1696
1706
1707
1717
1718
1728
1729
1739
1740
1750
1751
1761
1762
1772
1773
1783
1784
1794
1795
1805
1806
1816
1817
1827
1828
1838
1839
1849
1850
1860
1861
1871
1872
1873 /*
1874 * Update the object properties. If one of the properties has been modified, you must call this method to apply this modification.
1875 * Project must be opened to be able to call this method
1876 * \return EwErrorCode enum type, can be:
1877 * \li EW_UNDEFINED_ERROR default Error
1878 * \li EW_PROJECT_NOTOPENED Project not opened
1879 * \li EW_NO_ERROR if no error detected
1880 */
1882
1883
1894 EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
1895
1896
1907 BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
1908
1909
1922 EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
1923
1924
1936 BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
1937
1938
1948
1949
1959
1960
1970
1971
1982 VARIANT getMacroVariables (EwErrorCode* errorCode);
1983
1984
1995
1996
2005
2006
2007 /*
2008 * Remove the project. Project will be closed and mustn't be opened by someone else if you are using client and server installation.
2009 * \return EwErrorCode enum type, can be:
2010 * \li EW_UNDEFINED_ERROR if another error occurred
2011 * \li EW_INVALID_OBJECT if object is not valid
2012 * \li EW_PROJECT_NOTOPENED: project are close.
2013 * \li EW_CANNOT_REMOVE if project cannot be removed
2014 * \li EW_NO_PROJECT_OPENED_BY_SOMEONE_ELSE if project is opened on another computer by someone else
2015 * \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.
2016 * \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.
2017 * \li EW_DATABASE_CONNECTION_ERROR if connection to project database cannot be opened. You need to check the query log to investigate the reason.
2018 * \li EW_CANNOT_CLOSE_PROJECT if project cannot be closed
2019 * \li EW_NO_ERROR if no error detected
2020 */
2021 EwErrorCode remove ();
2022
2023
2032
2033
2042
2043
2053
2054
2064
2065
2074
2075
2083 EwErrorCode setExternID (BSTR strValue);
2084
2085
2093 BSTR getExternID (EwErrorCode* errorCode);
2094
2095
2105
2106
2117
2118
2127
2128
2139
2140
2152 BSTR getFolderPath (EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode* errorCode);
2153
2154
2165
2166
2177
2178
2189
2190
2201
2202
2213
2214
2225
2226
2237
2238
2249
2250
2259 BSTR getModifiedBy (EwErrorCode* eErrorCode);
2260
2261
2270
2271
2280
2281
2290 BSTR getCreatedBy (EwErrorCode* eErrorCode);
2291
2292
2303
2304
2315 EwProjectType getProjectType (EwErrorCode* errorCode);
2316
2317
2328
2329
2340
2341
2353
2354
2355 /*
2356 * Insert new empty project.
2357 * \since 2023 SP0
2358 * \return EwErrorCode enum type, can be:
2359 * \li EW_UNDEFINED_ERROR if another error occurred
2360 * \li EW_INVALID_OBJECT if object is not valid
2361 * \li EW_OBJECT_ALREADY_INSERTED project already exists
2362 * \li EW_INSERTION_FAILED if the insertion failed
2363 * \li EW_NO_ERROR if no error detected
2364 */
2366
2367
2368 /*
2369 * Insert new project from template.
2370 * \since 2023 SP0
2371 * \param[in] strTemplateName template name of project to create
2372 * \return EwErrorCode enum type, can be:
2373 * \li EW_UNDEFINED_ERROR if another error occurred
2374 * \li EW_DOES_NOT_EXIST_ERROR if path of project template not exist
2375 * \li EW_BAD_INPUTS if project Template not exist
2376 * \li EW_INVALID_OBJECT if object is not valid
2377 * \li EW_OBJECT_ALREADY_INSERTED project already exists
2378 * \li EW_INSERTION_FAILED if the insertion failed
2379 * \li EW_NO_ERROR if no error detected
2380 */
2381 EwErrorCode insertFromTemplate (BSTR strTemplateName);
2382
2383};
2384
2389[
2390 object,
2391 uuid(9A02A344-94BB-4F95-A133-45E09A42D6C5),
2392 dual,
2393 oleautomation,
2394 nonextensible,
2395 helpstring("IEwProjectManagerX Interface"),
2396 pointer_default(unique)
2397]
2398interface IEwProjectManagerX : IDispatch {
2399
2403 LONG getCount ();
2404
2405
2415 VARIANT getEwProjectArray (EwErrorCode* errorCode);
2416
2417
2427
2428
2437 IEwProjectX findEwProjectByName (BSTR strName, EwErrorCode* errorCode);
2438
2439
2451 EwErrorCode archive (VARIANT vProjectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies);
2452
2453
2464 VARIANT unarchive (BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode* errorCode);
2465
2466
2478 IEwProjectX findProjectFromFilePath (BSTR strFilePath, EwErrorCode* errorCode);
2479
2480
2491
2492
2502 EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings);
2503
2504
2515
2516}
2518
2519
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:434
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwProjectConfigValue
Values for project configuration.
Definition: EwEnumeration.idl:125
EwSymbolCrossRefType
All cross reference type of symbol.
Definition: EwEnumeration.idl:458
EwProjectFolderPathValue
Used with getFolderPath of EwProjectX object.
Definition: EwEnumeration.idl:54
EwSymbolType
All types of symbol.
Definition: EwEnumeration.idl:429
EwFileType
File types used in a project.
Definition: EwEnumeration.idl:386
EwOpenProjectMode
All possible open modes for a project.
Definition: EwEnumeration.idl:474
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:280
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:1260
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:1043
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:889
Use this interface to manage configuration of the project.
Definition: EwProjectObjects.idl:1175
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:1088
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:757
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 getPosition(EwErrorCode *errorCode)
Get the position of files inside a book/folder.
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 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.
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:1499
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:1375
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: EwProjectObjects.idl:1317
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of Functions of associated project.
IEwProjectFunctionX newEwProjectFunction(EwErrorCode *errorCode)
Create a IEwProjectFunctionX object from the associated project.
VARIANT getEwProjectFunctionArray(EwErrorCode *errorCode)
Return the array of IEwProjectFunction of associated project.
IEwProjectFunctionX findEwProjectFunctionByID(LONG lEwProjectFunctionID, EwErrorCode *errorCode)
Get the EwProjectFunction from the Function ID, for associated project.
Use this interface to manage function inside a project.
Definition: EwProjectObjects.idl:1060
BSTR getTagPath(EwErrorCode *errorCode)
Get the tag path of this Function.
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:65
Use this interface to manage the location inside a project.
Definition: EwProjectLocationObjects.idl:27
Use this interface to manage IEwProjectX objects.
Definition: EwProjectObjects.idl:2398
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:1013
Use this interface to manage a Multilingual Text Font inside a project.
Definition: EwProjectObjects.idl:386
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:694
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:539
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:359
IEwProjectSymbolX getProjectSymbolByID(LONG lID, EwErrorCode *errorCode)
return a Project Symbol by ID.
Use this interface to manage symbol inside a project.
Definition: EwProjectObjects.idl:53
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.
double getXPosition(EwErrorCode *errorCode)
Return the X coordinate of the 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.
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)
Return the Object ID associated with the 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:531
Use this interface to manage a project.
Definition: EwProjectObjects.idl:1557
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.
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) 2023 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.