Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
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  void set3DID (BSTR strName);
48 
49 };
50 
55 [
56  object,
57  uuid(3E730B19-746D-4F31-866E-F0DA4F7AA15F),
58  dual,
59  nonextensible,
60  pointer_default(unique)
61 ]
62 interface IEwDialogManufacturerPartOrderingX : IDispatch{
67  void setEwProjectID (LONG lProjectID);
68 
69 
74  void addManufacturerPartID (LONG lID);
75 
76 
86  VARIANT show (EwErrorCode* errorCode);
87 
88 };
89 
94 [
95  object,
96  uuid(23E21DBC-1E5C-4B07-B83D-F2B6F8F3669C),
97  dual,
98  nonextensible,
99  pointer_default(unique)
100 ]
101 interface IEwRightsManagerX : IDispatch
102 {
115  VARIANT_BOOL canEditFile (LONG lEwProjectFileID, LONG lEwProjectID, VARIANT_BOOL bShowError, EwErrorCode* errorCode);
116 
117 
122  VARIANT_BOOL askForUserLogin ();
123 
124 
129  VARIANT_BOOL resetPassword ();
130 
131 
136  VARIANT_BOOL askForNewPassword ();
137 
138 
143  VARIANT_BOOL editCurrenUserAccount ();
144 
145 
150  VARIANT_BOOL manageUserRight ();
151 
152 
158  VARIANT_BOOL enableUserRight (VARIANT_BOOL bEnable);
159 
160 
165 
166 
171  void updateProtectionType (void);
172 
173 
179 
180 
185 
186 };
187 
192 [
193  object,
194  uuid(5283AEC9-79A7-4183-9A4A-D22CCDE1CA1C),
195  dual,
196  nonextensible,
197  pointer_default(unique)
198 ]
199 interface IEwApplicationReactorX : IDispatch {
200 };
201 
206 [
207  object,
208  uuid(AFF14714-3DF5-47B2-B100-E8F7C9FF77D5),
209  dual,
210  nonextensible,
211  pointer_default(unique)
212 ]
213 interface IEwDialogSummaryX : IDispatch{
221  LONG addItem (BSTR strName, BSTR strDescription, EwErrorLogType eEwErrorLogType);
222 
223 
228  void show (BSTR strTitle);
229 
230 
234  void removeAllItems (void);
235 
236 
240  void removeItem (LONG lIndex);
241 
242 };
243 
248 [
249  object,
250  uuid(54106D74-D582-4AE0-8BAD-291F79FFBB67),
251  dual,
252  nonextensible,
253  pointer_default(unique)
254 ]
260  void setEwProjectID (LONG lProjectID);
261 
262 
267  void setEwProjectLocationID (LONG lLocationID);
268 
269 
274  void setAllowMultiSelection (VARIANT_BOOL bMultiSelection);
275 
276 
286  VARIANT show (EwErrorCode* errorCode);
287 
288 };
289 
294 [
295  object,
296  uuid(FDA5FD96-5436-4185-B3D2-1F7087F6E9D0),
297  dual,
298  nonextensible,
299  pointer_default(unique)
300 ]
301 interface IEwDialogTaskX : IDispatch{
306  void setInstructions (BSTR strInstructions);
307 
308 
313  void setContent (BSTR strContent);
314 
315 
325 
326 
333  void addButton (BSTR strText, LONG nButtonID);
334 
335 
346  LONG show (EwErrorCode* errorCode);
347 
348 
355  void setCheck (BSTR strText, VARIANT_BOOL bChecked);
356 
357 
363  VARIANT_BOOL getCheckState ();
364 
365 
366 };
367 
372 [
373  object,
374  uuid(E74A2E22-97D2-4A9B-9C59-332E7A29278D),
375  dual,
376  nonextensible,
377  pointer_default(unique)
378 ]
379 interface IEwDialogLocationSelectorX : IDispatch{
384  void setEwProjectID (LONG lProjectID);
385 
386 
391  void setEwProjectLocationID (LONG lLocationID);
392 
393 
398  void setEwProjectBundleID (LONG lBundleID);
399 
400 
405  void setAllowNoSelection (VARIANT_BOOL bAllowNoSelection);
406 
407 
414  void setFileType3d (EwFileType eFileType);
415 
416 
429 
430 };
431 
436 [
437  object,
438  uuid(87DB5F2F-318A-4FEF-8424-BAA88150F552),
439  dual,
440  nonextensible,
441  pointer_default(unique)
442 ]
443 interface IEwResumeRowX : IDispatch
444 {
452  BSTR getName (EwErrorCode* errorCode);
453 
454 
455 
463  EwErrorCode setName (BSTR strName);
464 
465 
466 
474  BSTR getDescription (EwErrorCode* errorCode);
475 
476 
484  EwErrorCode setDescription (BSTR strDescription);
485 
486 
487 
496 
497 
506 
507 
508 
516  unsigned long getBackgroundColor (EwErrorCode* errorCode);
517 
518 
526  EwErrorCode setBackgroundColor (unsigned long ulBackgroungColor);
527 
528 
529 };
530 
531 
536 [
537  object,
538  uuid(CD369693-D8A4-44D7-9345-F2DA9DC9038A),
539  dual,
540  nonextensible,
541  pointer_default(unique)
542 ]
543 interface IEwDialogResumeX : IDispatch
544 {
552  EwErrorCode setTitleName (BSTR strTitle);
553 
554 
563  EwErrorCode setIconID (LONG lIconID);
564 
565 
575 
576 
587 
588 
596 
597 };
598 
599 
604 [
605  object,
606  uuid(5D98A0F2-C36E-4CB0-B26C-A3F0CC2FCA89),
607  dual,
608  nonextensible,
609  pointer_default(unique)
610 ]
611 interface IEwDialogProgressX : IDispatch {
616  void show (BOOL bShow);
617 
618 
623  void setCancelEnable (BOOL bEnable);
624 
625 
630  void setCancelText (BSTR strMsg);
631 
632 
638  void setStop (BOOL bStop);
639 
640 
646  BOOL getStop ();
647 
648 
655  void setSnake (BOOL bSnake);
656 
657 
662  void setMessage (BSTR strMsg);
663 
664 
670  void setRange (INT lower, INT upper);
671 
672 
677  void setStep (INT nStep);
678 
679 
685  BOOL setPos (INT nPos);
686 
687 
692  BOOL stepIt ();
693 
694 
698  void showSecond (BOOL bShow);
699 
700 
707  void setSecondSnake (BOOL bSnake);
708 
709 
714  void setSecondMessage (BSTR strMsg);
715 
716 
722  void setSecondRange (INT lower, INT upper);
723 
724 
729  void setSecondStep (INT nStep);
730 
731 
737  BOOL setSecondPos (INT nPos);
738 
739 
744  BOOL stepItSecond ();
745 
746 
747 }
748 
753 [
754  object,
755  uuid(D51DC048-995E-4D1C-A84C-5BDED57F4308),
756  dual,
757  nonextensible,
758  helpstring("Context of command containing specific data to process."),
759  pointer_default(unique)
760 ]
761 interface IEwCommandContextX : IDispatch
762 {
763 
764 };
765 
766 
772 [
773  object,
774  uuid(8BD2B37C-3C68-4546-BA43-5EC0CA5F4DD1),
775  dual,
776  nonextensible,
777  helpstring("Object for creating a command to be executed in the application."),
778  pointer_default(unique)
779 ]
780 interface IEwCommandX : IDispatch
781 {
790  BSTR getName (EwErrorCode* errorCode);
791 
792 
800  BSTR getDescription (EwErrorCode* errorCode);
801 
802 
810  int getFlags (EwErrorCode* errorCode);
811 
812 
821 
822 };
823 
828 [
829  object,
830  uuid(6F9CAAB0-F7B9-4E62-BC62-AA5D70E5248E),
831  dual,
832  nonextensible,
833  helpstring("Use this manager to add or remove custom commands."),
834  pointer_default(unique)
835 ]
836 interface IEwCommandManagerX : IDispatch
837 {
848 
849 
858  EwErrorCode removeCommand (BSTR strCommandName);
859 
860 
870  VARIANT getParameterList (EwErrorCode* errorCode);
871 
872 };
873 
878 [
879  object,
880  uuid(915B6AA1-9AA5-4DAE-A527-781F7A9D070B),
881  dual,
882  oleautomation,
883  nonextensible,
884  helpstring("Use this to manage an excel sheet."),
885  pointer_default(unique)
886 ]
887 interface IEwXLSSheetX : IDispatch
888 {
895  BSTR readString (LONG lRow, LONG lCol);
896 
897 
904  void writeString (LONG lRow, LONG lColumn, BSTR strValue);
905 
906 
910  LONG firstRow ();
911 
912 
916  LONG lastRow ();
917 
918 
922  LONG firstColumn ();
923 
924 
928  LONG lastColumn ();
929 
930 
931 };
932 
933 
938 [
939  object,
940  uuid(2002AF29-2692-438D-8508-B8731B15F985),
941  dual,
942  nonextensible,
943  pointer_default(unique)
944 ]
945 interface IEwXLSBookX : IDispatch {
954 
962  EwErrorCode load (BSTR strFilePath);
963 
964 
972  EwErrorCode save (BSTR strFilePath);
973 
974 
978  LONG sheetCount ();
979 
980 
990  IEwXLSSheetX getSheetAt (LONG lIndex, EwErrorCode* errorCode);
991 
992 
1004  IEwXLSSheetX createSheet (BSTR strSheetName, EwErrorCode* errorCode);
1005 
1006 };
1007 
1012 [
1013  object,
1014  uuid(105f0b35-f9ce-4b66-9f46-b74ae80dec02),
1015  dual,
1016  nonextensible,
1017  pointer_default(unique)
1018 ]
1019 interface IEwDialogProjectManagerX : IDispatch
1020 {
1021 
1030 
1031 
1040 
1041 
1052 
1053 
1062  VARIANT getSelectedProjectID (EwErrorCode* errorCode);
1063 
1064 };
void setContent(BSTR strContent)
Set the content.
LONG firstRow()
void setInstructions(BSTR strInstructions)
Set the main instructions.
EwFileType
File types used in a project.
Definition: EwEnumeration.idl:352
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:306
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:781
VARIANT_BOOL resetPassword()
Remove the password needed to use the application.
void setStep(INT nStep)
Set progress step.
VARIANT_BOOL manageUserRight()
Open user right managment dialog.
EwXLSFileType
Different types of Excel file.
Definition: EwEnumeration.idl:522
BOOL setSecondPos(INT nPos)
Set progress position for second progress bar.
LONG lastRow()
Use this interface to display a progress dialog.
Definition: EwApplicationObjects.idl:611
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:1020
EwErrorCode setTitleName(BSTR strTitle)
Set the title of the resume dialog.
Use this interface to display a dialog that allows the user to select build of materials.
Definition: EwApplicationObjects.idl:255
Use this interface to display a task dialog.
Definition: EwApplicationObjects.idl:301
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.
EwErrorCode setLogType(EwErrorLogType eLogType)
Set the log type of a row for the resume dialog.
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:199
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.
EwErrorCode addCommand(IEwCommandX *lpEwCommand)
Add an object derived from IEwCommandX.
EwErrorCode execute(IEwCommandContextX *commandContextX)
Method called when command is executed.
Use this interface to display a summary dialog.
Definition: EwApplicationObjects.idl:213
Use this interface to manage a XLS file.
Definition: EwApplicationObjects.idl:945
Use this interface to manage the application rights.
Definition: EwApplicationObjects.idl:102
Use this interface to specify a resume row for the resume dialog.
Definition: EwApplicationObjects.idl:444
LONG firstColumn()
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:762
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 addEwResumeRow(IEwResumeRowX *resumeRow)
Add a resume to display.
EwErrorCode close()
Close the current Project manager dialog.
Use this to manage an excel sheet.
Definition: EwApplicationObjects.idl:888
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:556
EwErrorCode setDescription(BSTR strDescription)
Set the description of a row for the resume 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.
LONG addItem(BSTR strName, BSTR strDescription, EwErrorLogType eEwErrorLogType)
Add a new item to the dialog.
Use this interface to display the order of manufacturer parts dialog.
Definition: EwApplicationObjects.idl:62
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:145
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:379
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 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.
EwErrorCode setMainIcon(EwIconIndex ewIconIndex)
Set the main icon.
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:837
Use this interface to display a resume dialog.
Definition: EwApplicationObjects.idl:544
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) 2020 SP05

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

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