 |
SOLIDWORKS Electrical API
2021.0.0
Electrical API
|
Go to the documentation of this file.
4 midl_pragma warning(disable:2111)
9 import "EnumDefinition.idl";
11 import "EwProjectObjects.idl";
12 import "EwProjectLocationObjects.idl";
13 import "EwApplicationRibbon.idl";
21 uuid(5C625F66-F2A2-493A-A4A1-D4FC0ED1A83A),
24 pointer_default(unique)
62 uuid(3E730B19-746D-4F31-866E-F0DA4F7AA15F),
65 pointer_default(unique)
101 uuid(23E21DBC-1E5C-4B07-B83D-F2B6F8F3669C),
104 pointer_default(unique)
199 uuid(5283AEC9-79A7-4183-9A4A-D22CCDE1CA1C),
202 pointer_default(unique)
213 uuid(AFF14714-3DF5-47B2-B100-E8F7C9FF77D5),
216 pointer_default(unique)
255 uuid(54106D74-D582-4AE0-8BAD-291F79FFBB67),
258 pointer_default(unique)
301 uuid(FDA5FD96-5436-4185-B3D2-1F7087F6E9D0),
304 pointer_default(unique)
360 void setCheck (BSTR strText, VARIANT_BOOL bChecked);
379 uuid(E74A2E22-97D2-4A9B-9C59-332E7A29278D),
382 pointer_default(unique)
443 uuid(87DB5F2F-318A-4FEF-8424-BAA88150F552),
446 pointer_default(unique)
543 uuid(CD369693-D8A4-44D7-9345-F2DA9DC9038A),
546 pointer_default(unique)
611 uuid(5D98A0F2-C36E-4CB0-B26C-A3F0CC2FCA89),
614 pointer_default(unique)
760 uuid(D51DC048-995E-4D1C-A84C-5BDED57F4308),
763 helpstring(
"Context of command containing specific data to process."),
764 pointer_default(unique)
779 uuid(8BD2B37C-3C68-4546-BA43-5EC0CA5F4DD1),
782 helpstring(
"Object for creating a command to be executed in the application."),
783 pointer_default(unique)
835 uuid(6F9CAAB0-F7B9-4E62-BC62-AA5D70E5248E),
838 helpstring(
"Use this manager to add or remove custom commands."),
839 pointer_default(unique)
885 uuid(915B6AA1-9AA5-4DAE-A527-781F7A9D070B),
889 helpstring(
"Use this to manage an excel sheet."),
890 pointer_default(unique)
945 uuid(2002AF29-2692-438D-8508-B8731B15F985),
948 pointer_default(unique)
1019 uuid(105f0b35-f9ce-4b66-9f46-b74ae80dec02),
1022 pointer_default(unique)
void setContent(BSTR strContent)
Set the content.
EwErrorCode addEwResumeRow(IEwResumeRowX *iResumeRow)
Add a resume to display.
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.
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.
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.
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
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.