Hide Table of Contents
SOLIDWORKS Electrical API  2021.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 
197 [
198  object,
199  uuid(5283AEC9-79A7-4183-9A4A-D22CCDE1CA1C),
200  dual,
201  nonextensible,
202  pointer_default(unique)
203 ]
204 interface IEwApplicationReactorX : IDispatch {
205 };
206 
211 [
212  object,
213  uuid(AFF14714-3DF5-47B2-B100-E8F7C9FF77D5),
214  dual,
215  nonextensible,
216  pointer_default(unique)
217 ]
218 interface IEwDialogSummaryX : IDispatch{
226  LONG addItem (BSTR strName, BSTR strDescription, EwErrorLogType eErrorLogType);
227 
228 
233  void show (BSTR strTitle);
234 
235 
239  void removeAllItems (void);
240 
241 
245  void removeItem (LONG lIndex);
246 
247 };
248 
253 [
254  object,
255  uuid(54106D74-D582-4AE0-8BAD-291F79FFBB67),
256  dual,
257  nonextensible,
258  pointer_default(unique)
259 ]
265  void setEwProjectID (LONG lProjectID);
266 
267 
272  void setEwProjectLocationID (LONG lLocationID);
273 
274 
279  void setAllowMultiSelection (VARIANT_BOOL bMultiSelection);
280 
281 
291  VARIANT show (EwErrorCode* errorCode);
292 
293 };
294 
299 [
300  object,
301  uuid(FDA5FD96-5436-4185-B3D2-1F7087F6E9D0),
302  dual,
303  nonextensible,
304  pointer_default(unique)
305 ]
306 interface IEwDialogTaskX : IDispatch{
311  void setInstructions (BSTR strInstructions);
312 
313 
318  void setContent (BSTR strContent);
319 
320 
330 
331 
338  void addButton (BSTR strText, LONG nButtonID);
339 
340 
351  LONG show (EwErrorCode* errorCode);
352 
353 
360  void setCheck (BSTR strText, VARIANT_BOOL bChecked);
361 
362 
368  VARIANT_BOOL getCheckState ();
369 
370 
371 };
372 
377 [
378  object,
379  uuid(E74A2E22-97D2-4A9B-9C59-332E7A29278D),
380  dual,
381  nonextensible,
382  pointer_default(unique)
383 ]
384 interface IEwDialogLocationSelectorX : IDispatch{
389  void setEwProjectID (LONG lProjectID);
390 
391 
396  void setEwProjectLocationID (LONG lLocationID);
397 
398 
403  void setEwProjectBundleID (LONG lBundleID);
404 
405 
410  void setAllowNoSelection (VARIANT_BOOL bAllowNoSelection);
411 
412 
419  void setFileType3d (EwFileType eFileType);
420 
421 
434 
435 };
436 
441 [
442  object,
443  uuid(87DB5F2F-318A-4FEF-8424-BAA88150F552),
444  dual,
445  nonextensible,
446  pointer_default(unique)
447 ]
448 interface IEwResumeRowX : IDispatch
449 {
457  BSTR getName (EwErrorCode* errorCode);
458 
459 
460 
468  EwErrorCode setName (BSTR strName);
469 
470 
471 
479  BSTR getDescription (EwErrorCode* errorCode);
480 
481 
489  EwErrorCode setDescription (BSTR strDescription);
490 
491 
492 
501 
502 
511 
512 
513 
521  unsigned long getBackgroundColor (EwErrorCode* errorCode);
522 
523 
531  EwErrorCode setBackgroundColor (unsigned long ulBackgroungColor);
532 
533 
534 };
535 
536 
541 [
542  object,
543  uuid(CD369693-D8A4-44D7-9345-F2DA9DC9038A),
544  dual,
545  nonextensible,
546  pointer_default(unique)
547 ]
548 interface IEwDialogResumeX : IDispatch
549 {
557  EwErrorCode setTitleName (BSTR strTitle);
558 
559 
568  EwErrorCode setIconID (LONG lIconID);
569 
570 
580 
581 
592 
593 
601 
602 };
603 
604 
609 [
610  object,
611  uuid(5D98A0F2-C36E-4CB0-B26C-A3F0CC2FCA89),
612  dual,
613  nonextensible,
614  pointer_default(unique)
615 ]
616 interface IEwDialogProgressX : IDispatch {
621  void show (BOOL bShow);
622 
623 
628  void setCancelEnable (BOOL bEnable);
629 
630 
635  void setCancelText (BSTR strMsg);
636 
637 
643  void setStop (BOOL bStop);
644 
645 
651  BOOL getStop ();
652 
653 
660  void setSnake (BOOL bSnake);
661 
662 
667  void setMessage (BSTR strMsg);
668 
669 
675  void setRange (INT lower, INT upper);
676 
677 
682  void setStep (INT nStep);
683 
684 
690  BOOL setPos (INT nPos);
691 
692 
697  BOOL stepIt ();
698 
699 
703  void showSecond (BOOL bShow);
704 
705 
712  void setSecondSnake (BOOL bSnake);
713 
714 
719  void setSecondMessage (BSTR strMsg);
720 
721 
727  void setSecondRange (INT lower, INT upper);
728 
729 
734  void setSecondStep (INT nStep);
735 
736 
742  BOOL setSecondPos (INT nPos);
743 
744 
749  BOOL stepItSecond ();
750 
751 
752 }
753 
758 [
759  object,
760  uuid(D51DC048-995E-4D1C-A84C-5BDED57F4308),
761  dual,
762  nonextensible,
763  helpstring("Context of command containing specific data to process."),
764  pointer_default(unique)
765 ]
766 interface IEwCommandContextX : IDispatch
767 {
768 
769 };
770 
771 
777 [
778  object,
779  uuid(8BD2B37C-3C68-4546-BA43-5EC0CA5F4DD1),
780  dual,
781  nonextensible,
782  helpstring("Object for creating a command to be executed in the application."),
783  pointer_default(unique)
784 ]
785 interface IEwCommandX : IDispatch
786 {
795  BSTR getName (EwErrorCode* errorCode);
796 
797 
805  BSTR getDescription (EwErrorCode* errorCode);
806 
807 
815  int getFlags (EwErrorCode* errorCode);
816 
817 
825  EwErrorCode execute (IEwCommandContextX * iCommandContextX);
826 
827 };
828 
833 [
834  object,
835  uuid(6F9CAAB0-F7B9-4E62-BC62-AA5D70E5248E),
836  dual,
837  nonextensible,
838  helpstring("Use this manager to add or remove custom commands."),
839  pointer_default(unique)
840 ]
841 interface IEwCommandManagerX : IDispatch
842 {
853 
854 
863  EwErrorCode removeCommand (BSTR strCommandName);
864 
865 
875  VARIANT getParameterList (EwErrorCode* errorCode);
876 
877 };
878 
883 [
884  object,
885  uuid(915B6AA1-9AA5-4DAE-A527-781F7A9D070B),
886  dual,
887  oleautomation,
888  nonextensible,
889  helpstring("Use this to manage an excel sheet."),
890  pointer_default(unique)
891 ]
892 interface IEwXLSSheetX : IDispatch
893 {
900  BSTR readString (LONG lRow, LONG lCol);
901 
902 
909  void writeString (LONG lRow, LONG lColumn, BSTR strValue);
910 
911 
915  LONG firstRow ();
916 
917 
921  LONG lastRow ();
922 
923 
927  LONG firstColumn ();
928 
929 
933  LONG lastColumn ();
934 
935 
936 };
937 
938 
943 [
944  object,
945  uuid(2002AF29-2692-438D-8508-B8731B15F985),
946  dual,
947  nonextensible,
948  pointer_default(unique)
949 ]
950 interface IEwXLSBookX : IDispatch {
959 
967  EwErrorCode load (BSTR strFilePath);
968 
969 
977  EwErrorCode save (BSTR strFilePath);
978 
979 
983  LONG sheetCount ();
984 
985 
995  IEwXLSSheetX getSheetAt (LONG lIndex, EwErrorCode* errorCode);
996 
997 
1009  IEwXLSSheetX createSheet (BSTR strSheetName, EwErrorCode* errorCode);
1010 
1011 };
1012 
1017 [
1018  object,
1019  uuid(105f0b35-f9ce-4b66-9f46-b74ae80dec02),
1020  dual,
1021  nonextensible,
1022  pointer_default(unique)
1023 ]
1024 interface IEwDialogProjectManagerX : IDispatch
1025 {
1026 
1035 
1036 
1045 
1046 
1057 
1058 
1067  VARIANT getSelectedProjectID (EwErrorCode* errorCode);
1068 
1069 };
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:361
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.
EwErrorLogType
All possible items type for the summary dialog.
Definition: EwEnumeration.idl:315
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:786
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:531
BOOL setSecondPos(INT nPos)
Set progress position for second progress bar.
LONG lastRow()
Use this interface to display a progress dialog.
Definition: EwApplicationObjects.idl:616
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:1025
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:260
Use this interface to display a task dialog.
Definition: EwApplicationObjects.idl:306
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.
Use this interface to manage the application events.
Definition: EwApplicationObjects.idl:204
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:218
Use this interface to manage a XLS file.
Definition: EwApplicationObjects.idl:950
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:449
LONG firstColumn()
EwErrorCode setMainIcon(EwIconIndex iIconIndex)
Set the main icon.
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 bas.
void setStop(BOOL bStop)
Set stop flag.
Context of command containing specific data to process.
Definition: EwApplicationObjects.idl:767
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:893
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:572
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()
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:147
void show(BSTR strTitle)
Displays the 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:384
VARIANT show(EwErrorCode *errorCode)
Displays the 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:842
Use this interface to display a resume dialog.
Definition: EwApplicationObjects.idl:549
BSTR getCurrentUserDescription()
get description of current user
VARIANT getParameterList(EwErrorCode *errorCode)
Return the list of parameters of the last command executed.
VARIANT_BOOL editCurrenUserAccount()
Edit properties of current user account.
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) 2021 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.