Hide Table of Contents
SOLIDWORKS Electrical API  2022.0.0
Electrical API
EwApplicationObjects.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 import "EnumDefinition.idl";
10 
11 import "EwProjectObjects.idl";
12 import "EwProjectLocationObjects.idl";
13 import "EwApplicationRibbon.idl";
14 
19 [
20  object,
21  uuid(5C625F66-F2A2-493A-A4A1-D4FC0ED1A83A),
22  dual,
23  nonextensible,
24  pointer_default(unique)
25 ]
34 
35 
39  DOUBLE getSpacing ();
40 
41 
45  BSTR getFaceName ();
46 
47 
52  void set3DID (BSTR strName);
53 
54 };
55 
60 [
61  object,
62  uuid(3E730B19-746D-4F31-866E-F0DA4F7AA15F),
63  dual,
64  nonextensible,
65  pointer_default(unique)
66 ]
67 interface IEwDialogManufacturerPartOrderingX : IDispatch{
72  void setEwProjectID (LONG lProjectID);
73 
74 
79  void addManufacturerPartID (LONG lID);
80 
81 
91  VARIANT show (EwErrorCode* errorCode);
92 
93 };
94 
99 [
100  object,
101  uuid(23E21DBC-1E5C-4B07-B83D-F2B6F8F3669C),
102  dual,
103  nonextensible,
104  pointer_default(unique)
105 ]
106 interface IEwRightsManagerX : IDispatch
107 {
120  VARIANT_BOOL canEditFile (LONG lEwProjectFileID, LONG lEwProjectID, VARIANT_BOOL bShowError, EwErrorCode* errorCode);
121 
122 
127  VARIANT_BOOL askForUserLogin ();
128 
129 
134  VARIANT_BOOL resetPassword ();
135 
136 
141  VARIANT_BOOL askForNewPassword ();
142 
143 
148  VARIANT_BOOL editCurrenUserAccount ();
149 
150 
155  VARIANT_BOOL manageUserRight ();
156 
157 
163  VARIANT_BOOL enableUserRight (VARIANT_BOOL bEnable);
164 
165 
170 
171 
176  void updateProtectionType (void);
177 
178 
184 
185 
190 
191 
192 };
193 
198 [
199  object,
200  uuid(5283AEC9-79A7-4183-9A4A-D22CCDE1CA1C),
201  dual,
202  nonextensible,
203  pointer_default(unique)
204 ]
205 interface IEwApplicationReactorX : IDispatch {
206 };
207 
212 [
213  object,
214  uuid(AFF14714-3DF5-47B2-B100-E8F7C9FF77D5),
215  dual,
216  nonextensible,
217  pointer_default(unique)
218 ]
219 interface IEwDialogSummaryX : IDispatch{
227  LONG addItem (BSTR strName, BSTR strDescription, EwErrorLogType eErrorLogType);
228 
229 
234  void show (BSTR strTitle);
235 
236 
240  void removeAllItems (void);
241 
242 
246  void removeItem (LONG lIndex);
247 
248 };
249 
254 [
255  object,
256  uuid(54106D74-D582-4AE0-8BAD-291F79FFBB67),
257  dual,
258  nonextensible,
259  pointer_default(unique)
260 ]
266  void setEwProjectID (LONG lProjectID);
267 
268 
273  void setEwProjectLocationID (LONG lLocationID);
274 
275 
280  void setAllowMultiSelection (VARIANT_BOOL bMultiSelection);
281 
282 
292  VARIANT show (EwErrorCode* errorCode);
293 
294 };
295 
300 [
301  object,
302  uuid(FDA5FD96-5436-4185-B3D2-1F7087F6E9D0),
303  dual,
304  nonextensible,
305  pointer_default(unique)
306 ]
307 interface IEwDialogTaskX : IDispatch{
312  void setInstructions (BSTR strInstructions);
313 
314 
319  void setContent (BSTR strContent);
320 
321 
331 
332 
339  void addButton (BSTR strText, LONG nButtonID);
340 
341 
352  LONG show (EwErrorCode* errorCode);
353 
354 
361  void setCheck (BSTR strText, VARIANT_BOOL bChecked);
362 
363 
369  VARIANT_BOOL getCheckState ();
370 
371 
372 };
373 
378 [
379  object,
380  uuid(E74A2E22-97D2-4A9B-9C59-332E7A29278D),
381  dual,
382  nonextensible,
383  pointer_default(unique)
384 ]
385 interface IEwDialogLocationSelectorX : IDispatch{
390  void setEwProjectID (LONG lProjectID);
391 
392 
397  void setEwProjectLocationID (LONG lLocationID);
398 
399 
404  void setEwProjectBundleID (LONG lBundleID);
405 
406 
411  void setAllowNoSelection (VARIANT_BOOL bAllowNoSelection);
412 
413 
420  void setFileType3d (EwFileType eFileType);
421 
422 
435 
436 };
437 
442 [
443  object,
444  uuid(87DB5F2F-318A-4FEF-8424-BAA88150F552),
445  dual,
446  nonextensible,
447  pointer_default(unique)
448 ]
449 interface IEwResumeRowX : IDispatch
450 {
458  BSTR getName (EwErrorCode* errorCode);
459 
460 
461 
469  EwErrorCode setName (BSTR strName);
470 
471 
472 
480  BSTR getDescription (EwErrorCode* errorCode);
481 
482 
490  EwErrorCode setDescription (BSTR strDescription);
491 
492 
493 
502 
503 
512 
513 
514 
522  unsigned long getBackgroundColor (EwErrorCode* errorCode);
523 
524 
532  EwErrorCode setBackgroundColor (unsigned long ulBackgroungColor);
533 
534 
535 };
536 
537 
542 [
543  object,
544  uuid(CD369693-D8A4-44D7-9345-F2DA9DC9038A),
545  dual,
546  nonextensible,
547  pointer_default(unique)
548 ]
549 interface IEwDialogResumeX : IDispatch
550 {
558  EwErrorCode setTitleName (BSTR strTitle);
559 
560 
569  EwErrorCode setIconID (LONG lIconID);
570 
571 
581 
582 
593 
594 
602 
603 };
604 
605 
610 [
611  object,
612  uuid(5D98A0F2-C36E-4CB0-B26C-A3F0CC2FCA89),
613  dual,
614  nonextensible,
615  pointer_default(unique)
616 ]
617 interface IEwDialogProgressX : IDispatch {
622  void show (BOOL bShow);
623 
624 
629  void setCancelEnable (BOOL bEnable);
630 
631 
636  void setCancelText (BSTR strMsg);
637 
638 
644  void setStop (BOOL bStop);
645 
646 
652  BOOL getStop ();
653 
654 
661  void setSnake (BOOL bSnake);
662 
663 
668  void setMessage (BSTR strMsg);
669 
670 
676  void setRange (INT lower, INT upper);
677 
678 
683  void setStep (INT nStep);
684 
685 
691  BOOL setPos (INT nPos);
692 
693 
698  BOOL stepIt ();
699 
700 
704  void showSecond (BOOL bShow);
705 
706 
713  void setSecondSnake (BOOL bSnake);
714 
715 
720  void setSecondMessage (BSTR strMsg);
721 
722 
728  void setSecondRange (INT lower, INT upper);
729 
730 
735  void setSecondStep (INT nStep);
736 
737 
743  BOOL setSecondPos (INT nPos);
744 
745 
750  BOOL stepItSecond ();
751 
752 
763  EwErrorCode setTitle (BSTR strTitle);
764 
765 
775  BSTR getTitle (EwErrorCode* pEwErrorCode);
776 
777 
778 }
779 
784 [
785  object,
786  uuid(D51DC048-995E-4D1C-A84C-5BDED57F4308),
787  dual,
788  nonextensible,
789  helpstring("Context of command containing specific data to process."),
790  pointer_default(unique)
791 ]
792 interface IEwCommandContextX : IDispatch
793 {
794 
795 };
796 
797 
803 [
804  object,
805  uuid(8BD2B37C-3C68-4546-BA43-5EC0CA5F4DD1),
806  dual,
807  nonextensible,
808  helpstring("Object for creating a command to be executed in the application."),
809  pointer_default(unique)
810 ]
811 interface IEwCommandX : IDispatch
812 {
821  BSTR getName (EwErrorCode* errorCode);
822 
823 
831  BSTR getDescription (EwErrorCode* errorCode);
832 
833 
841  int getFlags (EwErrorCode* errorCode);
842 
843 
851  EwErrorCode execute (IEwCommandContextX * iCommandContextX);
852 
853 };
854 
859 [
860  object,
861  uuid(6F9CAAB0-F7B9-4E62-BC62-AA5D70E5248E),
862  dual,
863  nonextensible,
864  helpstring("Use this manager to add or remove custom commands."),
865  pointer_default(unique)
866 ]
867 interface IEwCommandManagerX : IDispatch
868 {
879 
880 
889  EwErrorCode removeCommand (BSTR strCommandName);
890 
891 
901  VARIANT getParameterList (EwErrorCode* errorCode);
902 
903 };
904 
909 [
910  object,
911  uuid(915B6AA1-9AA5-4DAE-A527-781F7A9D070B),
912  dual,
913  oleautomation,
914  nonextensible,
915  helpstring("Use this to manage an excel sheet."),
916  pointer_default(unique)
917 ]
918 interface IEwXLSSheetX : IDispatch
919 {
926  BSTR readString (LONG lRow, LONG lCol);
927 
928 
935  void writeString (LONG lRow, LONG lColumn, BSTR strValue);
936 
937 
941  LONG firstRow ();
942 
943 
947  LONG lastRow ();
948 
949 
953  LONG firstColumn ();
954 
955 
959  LONG lastColumn ();
960 
961 
962 };
963 
964 
969 [
970  object,
971  uuid(2002AF29-2692-438D-8508-B8731B15F985),
972  dual,
973  nonextensible,
974  pointer_default(unique)
975 ]
976 interface IEwXLSBookX : IDispatch {
985 
993  EwErrorCode load (BSTR strFilePath);
994 
995 
1003  EwErrorCode save (BSTR strFilePath);
1004 
1005 
1009  LONG sheetCount ();
1010 
1011 
1021  IEwXLSSheetX getSheetAt (LONG lIndex, EwErrorCode* errorCode);
1022 
1023 
1035  IEwXLSSheetX createSheet (BSTR strSheetName, EwErrorCode* errorCode);
1036 
1037 };
1038 
1043 [
1044  object,
1045  uuid(105f0b35-f9ce-4b66-9f46-b74ae80dec02),
1046  dual,
1047  nonextensible,
1048  pointer_default(unique)
1049 ]
1050 interface IEwDialogProjectManagerX : IDispatch
1051 {
1052 
1061 
1062 
1071 
1072 
1083 
1084 
1093  VARIANT getSelectedProjectID (EwErrorCode* errorCode);
1094 
1095 };
1096 
1101 [
1102  object,
1103  uuid(53485f5d-0404-47d0-800c-30d8bde102bd),
1104  dual,
1105  nonextensible,
1106  helpstring("IEwManagerDialogX Interface"),
1107  pointer_default(unique)
1108 ]
1109 interface IEwManagerDialogX : IDispatch
1110 {
1119 
1120 
1129 
1130 
1140 
1141 
1150  VARIANT getSelectedItemID (EwErrorCode* errorCode);
1151 
1152 
1161  EwErrorCode setSelectedItemID (VARIANT vArray);
1162 
1163 
1174  int insertColumn (const BSTR strColName, EwErrorCode* pErrorCode);
1175 
1176 
1177 
1188  int insertIconOverlay (__int64 nHandle, EwErrorCode* pErrorCode);
1189 
1190 
1200 
1201 
1202 };
VARIANT getSelectedItemID(EwErrorCode *errorCode)
Return an array of Item ID selected in the manager dialog.
void setContent(BSTR strContent)
Set the content.
EwErrorCode addEwResumeRow(IEwResumeRowX *iResumeRow)
Add a resume to display.
LONG firstRow()
void setInstructions(BSTR strInstructions)
Set the main instructions.
EwFileType
File types used in a project.
Definition: EwEnumeration.idl:375
BSTR getName(EwErrorCode *errorCode)
Return the name of the command.
unsigned long getBackgroundColor(EwErrorCode *errorCode)
Get the background color of a row for the resume dialog.
int insertIconOverlay(__int64 nHandle, EwErrorCode *pErrorCode)
Insert an icon overlay to the first column if the list control of the manager.
EwErrorLogType
All possible items type for the summary dialog.
Definition: EwEnumeration.idl:329
void set3DID(BSTR strName)
set the id of 3d Application
Use this interface to manage the align parameters from the user interface.
Definition: EwApplicationObjects.idl:26
void setRange(INT lower, INT upper)
Set progress range.
void setEwProjectID(LONG lProjectID)
Sets the project from where the dialog will take the locations.
BSTR getDescription(EwErrorCode *errorCode)
Get the description of a row for the resume dialog.
LONG sheetCount()
Object for creating a command to be executed in the application.
Definition: EwApplicationObjects.idl:812
VARIANT_BOOL resetPassword()
Remove the password needed to use the application.
void setStep(INT nStep)
Set progress step.
EwErrorCode addCommand(IEwCommandX *iCommand)
Add an object derived from IEwCommandX.
VARIANT_BOOL manageUserRight()
Open user right managment dialog.
EwXLSFileType
Different types of Excel file.
Definition: EwEnumeration.idl:546
BOOL setSecondPos(INT nPos)
Set progress position for second progress bar.
LONG lastRow()
Use this interface to display a progress dialog.
Definition: EwApplicationObjects.idl:617
void setEwProjectID(LONG lProjectID)
Sets the project from where the dialog will take the manufacturer parts.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwErrorCode show()
Display the Project manager dialog.
EwErrorCode save(BSTR strFilePath)
Save the file previously loaded or created.
Use this interface to the Project Manager Dialog.
Definition: EwApplicationObjects.idl:1051
EwErrorCode setTitleName(BSTR strTitle)
Set the title of the resume dialog.
EwErrorCode execute(IEwCommandContextX *iCommandContextX)
Method called when command is executed.
Use this interface to display a dialog that allows the user to select build of materials.
Definition: EwApplicationObjects.idl:261
Use this interface to display a task dialog.
Definition: EwApplicationObjects.idl:307
IEwProjectLocationX show(EwErrorCode *errorCode)
Displays the dialog.
void setCancelEnable(BOOL bEnable)
Enable / disable cancel button.
void setMessage(BSTR strMsg)
Set message string displayed above the progress indicator.
EwErrorCode setBackgroundColor(unsigned long ulBackgroungColor)
Set the background color of a row.
void initUserRightFeatureDescription(void)
Initialize description of the user right feature.
LONG show(EwErrorCode *errorCode)
Display the dialog Warning at least one button must be added.
EwErrorCode redrawList()
Redraw list control of the manager.
EwErrorCode setTitle(BSTR strTitle)
Set the title of progress dialog.
Use this interface to manage the application events.
Definition: EwApplicationObjects.idl:205
void setCheck(BSTR strText, VARIANT_BOOL bChecked)
Add (set) check button at the dialog bottom.
LONG lastColumn()
void removeItem(LONG lIndex)
Remove the item at the target index.
Use this interface to display a summary dialog.
Definition: EwApplicationObjects.idl:219
Use this interface to manage a XLS file.
Definition: EwApplicationObjects.idl:976
Use this interface to manage the application rights.
Definition: EwApplicationObjects.idl:107
Use this interface to specify a resume row for the resume dialog.
Definition: EwApplicationObjects.idl:450
LONG firstColumn()
EwErrorCode setMainIcon(EwIconIndex iIconIndex)
Set the main icon.
IEwRibbonX getEwRibbon(EwErrorCode *errorCode)
Return an IEwRibbonX interface on the current manager dialog.
void addButton(BSTR strText, LONG nButtonID)
Call this member function to add a user defined button to the task dialog's command area.
BSTR readString(LONG lRow, LONG lCol)
return a string with the value of cell.
EwErrorCode setIconID(LONG lIconID)
Set the Icon for the resume dialog.
VARIANT_BOOL getCheckState()
Get check button state.
EwErrorCode create(EwXLSFileType eXLSFileType)
Create an xls or xlsx file.
void setSecondSnake(BOOL bSnake)
Set snake mode for second progress bar.
void showSecond(BOOL bShow)
Show / hide second progress bar 0 = true , 1 = false.
void setStop(BOOL bStop)
Set stop flag.
Context of command containing specific data to process.
Definition: EwApplicationObjects.idl:793
IEwResumeRowX newEwResumeRow(EwErrorCode *errorCode)
Create a new EwResumeRow object.
void writeString(LONG lRow, LONG lColumn, BSTR strValue)
write the string in the indicated cell
EwErrorCode close()
Close the current Project manager dialog.
Use this to manage an excel sheet.
Definition: EwApplicationObjects.idl:919
EwErrorLogType getLogType(EwErrorCode *errorCode)
Get the log type of a row for the resume dialog.
void setAllowNoSelection(VARIANT_BOOL bAllowNoSelection)
Set the possibility to return OK with no location selected.
EwErrorCode removeCommand(BSTR strCommandName)
Remove a command.
Use this interface to manage the Ribbon Bar.
Definition: EwApplicationRibbon.idl:1036
EwErrorCode setDescription(BSTR strDescription)
Set the description of a row for the resume dialog.
LONG addItem(BSTR strName, BSTR strDescription, EwErrorLogType eErrorLogType)
Add a new item to the dialog.
VARIANT_BOOL enableUserRight(VARIANT_BOOL bEnable)
Enable/disable user right, checking if current authorization are ok.
void setEwProjectLocationID(LONG lLocationID)
Sets the location where selected locations are inserted.
void show(BOOL bShow)
Show / hide the dialog.
Use this interface to display the order of manufacturer parts dialog.
Definition: EwApplicationObjects.idl:67
VARIANT_BOOL isAuthorizedToAccessLibraryManager()
BSTR getTitle(EwErrorCode *pEwErrorCode)
Get the title of progress dialog.
BOOL setPos(INT nPos)
Set progress position.
void setEwProjectID(LONG lProjectID)
Sets the project from where the dialog will take the manufacturer parts.
IEwXLSSheetX getSheetAt(LONG lIndex, EwErrorCode *errorCode)
get the sheet at index passed as parameter
EwIconIndex
Default icons.
Definition: EnumDefinition.idl:167
int insertColumn(const BSTR strColName, EwErrorCode *pErrorCode)
insert a column into the list control of the manager
void show(BSTR strTitle)
Displays the dialog.
EwErrorCode setSelectedItemID(VARIANT vArray)
Set an array of Item ID to select line in the manager dialog.
IEwXLSSheetX createSheet(BSTR strSheetName, EwErrorCode *errorCode)
Create the sheet with the name passed as a parameter.
Use this interface to manage the location inside a project.
Definition: EwProjectLocationObjects.idl:27
void setEwProjectBundleID(LONG lBundleID)
Set the ID of current bundle.
void setAllowMultiSelection(VARIANT_BOOL bMultiSelection)
Sets the possibility to do a multi selection in the manufacturer parts list.
EwErrorCode show()
Displays the resume dialog.
void setSecondMessage(BSTR strMsg)
Set message string displayed above the progress indicator for second progress bar.
Use this interface to display a location selector dialog.
Definition: EwApplicationObjects.idl:385
VARIANT show(EwErrorCode *errorCode)
Displays the dialog.
EwErrorCode show()
Display the current manager dialog.
int getFlags(EwErrorCode *errorCode)
Combination of flags to define some specific behavior for a command.
IEwRibbonX getEwRibbon(EwErrorCode *errorCode)
return an IEwRibbonX interface to EwRibbonX object.
BOOL stepItSecond()
Step the progress for second progress bar.
void setSecondStep(INT nStep)
Set progress step for second progress bar.
EwErrorCode setLogType(EwErrorLogType eErrorLogType)
Set the log type of a row for the resume dialog.
EwErrorCode load(BSTR strFilePath)
load XLS or XLSX File
EwErrorCode show()
Displays the dialog.
BOOL getStop()
Get stop flag.
VARIANT_BOOL askForNewPassword()
Prompt user to enter a new password to protect interface.
void setFileType3d(EwFileType eFileType)
Set file type for 3d layout insertion.
VARIANT show(EwErrorCode *errorCode)
Displays the dialog.
void removeAllItems(void)
Remove all the inserted items.
VARIANT_BOOL askForUserLogin()
Depending on protection type, ask for user to login if necessary.
void updateProtectionType(void)
Check if password/user login protection is enabled.
Use this manager to add or remove custom commands.
Definition: EwApplicationObjects.idl:868
Use this interface to display a resume dialog.
Definition: EwApplicationObjects.idl:550
BSTR getCurrentUserDescription()
get description of current user
EwErrorCode close()
Close the current current manager dialog.
VARIANT getParameterList(EwErrorCode *errorCode)
Return the list of parameters of the last command executed.
VARIANT_BOOL editCurrenUserAccount()
Edit properties of current user account.
Use this interface to manage the Library/Configuration manager dialogs.
Definition: EwApplicationObjects.idl:1110
BOOL stepIt()
Step the progress.
EwErrorCode setName(BSTR strName)
Set the name of a row for the resume dialog.
void setCancelText(BSTR strMsg)
Set cancel button text.
void setSecondRange(INT lower, INT upper)
Set progress range for second progress bar.
void setSnake(BOOL bSnake)
Set snake mode.
void setEwProjectLocationID(LONG lLocationID)
Sets the location where the reference parts are inserted.
VARIANT getSelectedProjectID(EwErrorCode *errorCode)
Return an array of project ID selected in the Project manager dialog.
BSTR getName(EwErrorCode *errorCode)
Get the name of a row for the resume dialog.
VARIANT_BOOL canEditFile(LONG lEwProjectFileID, LONG lEwProjectID, VARIANT_BOOL bShowError, EwErrorCode *errorCode)
Check if the current user can edit the target IEwProjectFileX.
BSTR getDescription(EwErrorCode *errorCode)
Return a sentence to fully describe the command.
void addManufacturerPartID(LONG lID)
Add a manufacturer part ID to the list that will be ordered.


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/EwApplicationObjects.idl Source File
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

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

 Never show this message again
x

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

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

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