 |
SOLIDWORKS Electrical API
2021.0.0
Electrical API
|
Go to the documentation of this file.
4 midl_pragma warning(disable:2111)
10 import "EwObjectBase.idl";
18 uuid(9AF0A2A1-FF19-47F8-9EC7-BFD20499CF6E),
22 helpstring(
"IEwProjectPrintConfigX Interface"),
23 pointer_default(unique)
458 uuid(151AECB0-06B4-4090-9229-B2F4F01FE360),
462 helpstring(
"IEwProjectPrintConfigManagerX Interface"),
463 pointer_default(unique)
603 uuid(910619A2-421C-4F95-A196-F8685C628BD9),
607 helpstring(
"IEwProjectExportDWGFilesX Interface"),
608 pointer_default(unique)
707 uuid(415A3B4B-F774-41DD-8495-83BE794AB6A7),
710 helpstring(
"IEwProjectExportPDMX Interface"),
711 pointer_default(unique)
775 uuid(5C9D486B-EE01-4C6E-8585-68E392CA4A16),
778 helpstring(
"IEwProjectReportX Interface"),
779 pointer_default(unique)
870 uuid(9795C977-F5E4-4FA5-B527-A28E6D58C1BA),
873 helpstring(
"IEwProjectReportManagerX Interface"),
874 pointer_default(unique)
941 uuid(877D3846-16D9-4730-9FFB-1A396B873DE1),
944 pointer_default(unique)
1270 uuid(E070B6E8-63CC-4C26-B96D-A048122CC774),
1273 pointer_default(unique)
1347 uuid(3efe1ef7-fc16-45e1-817b-b13428fba5ba),
1349 helpstring(
"Use this interface to manage the Excel Automation inside the project."),
1351 pointer_default(unique)
1451 uuid(36ba15fb-8d9f-4a70-9d22-c7274b2ef60f),
1453 helpstring(
"Use this interface to export in PDF the current project files."),
1455 pointer_default(unique)
Use this interface to manage the report used inside the project.
Definition: EwProjectExportObjects.idl:782
BSTR getLogFilePath(EwErrorCode *errorCode)
Return The log file path for Excel automation.
EwErrorCode setPrintStyleSheetName(BSTR strPrintStyleSheetName)
Update the style sheet name with a new name.
EwErrorCode setAllProjectFiles(VARIANT_BOOL bAllProjectFiles)
Update with true to export all project files.
VARIANT_BOOL getExportAllReports(EwErrorCode *errorCode)
Indicate if all reports of the project must be exported.
EwErrorCode setExportToPDFFileName(BSTR strExportToPDFFilePath)
Set the export to PDF file path.
EwErrorCode doExcelExport()
Export reports in Excel type.
EwErrorCode setInversePrintOrder(VARIANT_BOOL bInversePrintOrder)
Update the inverse print order.
EwTextIdentifer getEwTextIdentifer(EwErrorCode *errorCode)
Return the text identifier for text export of reports.
VARIANT_BOOL getInversePrintOrder(EwErrorCode *errorCode)
Return true to print from last page, false to print from first page.
VARIANT_BOOL getAllProjectFiles(EwErrorCode *errorCode)
Return true to export all project files.
EwErrorCode setPrintStandardScaleType(EwStandardScaleType eStandardScaleType)
Update the Scale Type with an EwStandardScaleType enumeration value.
IEwProjectPrintConfigX findProjectPrintConfigByID(LONG lId, EwErrorCode *errorCode)
Get the print configuration from ID, for associated project.
EwErrorCode setGenerateLog(VARIANT_BOOL bGenerateLog)
Specify if a log file is generated.
IEwProjectReportX findProjectPrintReportByID(LONG lID, EwErrorCode *errorCode)
Find a report from his ID.
BSTR getExcelFilePath(EwErrorCode *errorCode)
Return the full path to the Excel file for automation.
EwErrorCode print()
Print project.
EwErrorCode setPaperFormat(EwPDFPaperFormat ePDFPaperFormat)
Update the paper format with a new name.
EwErrorCode generate()
Go through all the terminal strips of the project and generate terminal strip drawings if terminal st...
EwPageOrientation getEwPageOrientation(EwErrorCode *errorCode)
Return the page orientation of the config print.
EwErrorCode setExportDirectory(BSTR strExportDirectory)
Update the export directory path.
EwErrorCode setPaperSource(BSTR strPaperSource)
Update the paper source.
VARIANT_BOOL getGenerateAutomatedDrawings(EwErrorCode *errorCode)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
long getDestinationBookOrFolderID(long lEwProjectComponentID, EwErrorCode *errorCode)
Indicates the destination book associated to a component ID.
EwErrorCode setPrinterName(BSTR strPrinterName)
Update the printer name with a new name.
EwStandardScaleType getPrintStandardScaleType(EwErrorCode *errorCode)
Get the scale type EwStandardScaleType enumeration value of the config print.
EwStandardScaleType
All standard print drawing scale type.
Definition: EwEnumeration.idl:960
Use this interface to manage the export reports used inside the project.
Definition: EwProjectExportObjects.idl:947
EwErrorCode exportDwg(EwDwgFileExport eExportType)
Export previously selected files.
BSTR getFilter(EwErrorCode *errorCode)
Return the filter name of the report used inside the project.
Use this interface to manage export DWG files inside a project.
Definition: EwProjectExportObjects.idl:610
LONG getCount(EwErrorCode *errorCode)
Return the number of reports of associated project.
VARIANT_BOOL getGenerateAutomatedDrawings(EwErrorCode *errorCode)
Return the option to update all generated files like Terminal strips or Reports which have been added...
BSTR getExportDirectory(EwErrorCode *errorCode)
Return the export directory path.
double getPaperScaleUnit(EwErrorCode *errorCode)
Get the paper scale unit for the scale type, or a custom paper scale type.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwErrorCode setPrintdrawingScaleUnit(double dPrintdrawingScaleUnit)
Update the drawing scale unit for custom drawing scale type.
Use this interface to manage for reports used inside the project.
Definition: EwProjectExportObjects.idl:877
EwErrorCode setSelectionFiles(VARIANT aFolioArray)
Set the files to export with the files ID specify in the input array.
EwErrorCode setOpenFile(VARIANT_BOOL bOpenFile)
Set this flag to true if you want to open the reports after the export.
Use this interface to manage a print configuration manager inside a project.
Definition: EwProjectExportObjects.idl:465
EwErrorCode setEwProjectDataExportType(EwProjectDataExportType eProjectDataExportType)
Update the type of report to export.
EwTextIdentifer
Text identifier options.
Definition: EnumDefinition.idl:158
VARIANT getPrinterNamesArray(EwErrorCode *errorCode)
Return the array of string of printers name.
LONG getBookOrFolderId(EwErrorCode *errorCode)
Return the selected book id or folder id.
VARIANT_BOOL getOpenFile(EwErrorCode *errorCode)
Indicate if reports will be opened after the export.
VARIANT_BOOL getPrintUsingStyleSheet(EwErrorCode *errorCode)
Return true to print using style sheet.
EwErrorCode setPaperFormat(BSTR strPaperFormat)
Update the paper format with a new name.
EwPDFPaperFormat
All standard PDF paper format types.
Definition: EwEnumeration.idl:1007
EwErrorCode setPlotWithSymmetry(VARIANT_BOOL bPlotWithSymmetry)
Update the export PDF file with symmetry.
BSTR getOutputFolderPath(EwErrorCode *errorCode)
Return the output folder path where all files will be exported.
LONG getOrderNo(EwErrorCode *errorCode)
Return the Order No of the report used inside the project.
VARIANT_BOOL getPlotWithSymmetry(EwErrorCode *errorCode)
Return true to export PDF file with symmetry, false for standard export.
EwErrorCode setPrintSelectionFiles(VARIANT vFolioArray)
Set the files to print with the files ID specify in the input array.
IEwProjectPrintConfigX duplicateEwProjectPrintConfig(LONG lID, EwErrorCode *errorCode)
Create an IEwProjectPrintConfigX object with an existant IEwProjectPrintConfigX object from the assoc...
EwErrorCode setBookOrFolderId(long lBookOrFolderId)
Set the id of the destination folder or book where the reports will be exported.
EwErrorCode setStrFileNameFormula(BSTR strFileNameFormula)
Update the formula for naming dwg file.
VARIANT_BOOL getPrintAllProjectFiles(EwErrorCode *errorCode)
Return true to print all project files.
VARIANT getSelectionFiles(EwErrorCode *errorCode)
Return the files to export in an array This parameter is used if "all project files" option is set to...
EwTSDrawingOption
Define behavior when updating terminal strip drawings.
Definition: EwEnumeration.idl:736
EwErrorCode setOutputFolderPath(BSTR strOutputFolderPath)
Set the output folder path where all files will be exported.
EwFileExtension
All file types extension.
Definition: EwEnumeration.idl:519
IEwProjectReportX newEwProjectReport(EwErrorCode *errorCode)
Create an IEwProjectReportX object from the associated project.
EwErrorCode doTxtExport()
Export reports in Txt type.
EwErrorCode setPDMConfigFilePath(BSTR strPDMConfigFilePath)
Update the PDM config file.
EwErrorCode setPrintConfigName(BSTR strPrintConfigName)
Update the config name with a new unique name.
EwErrorCode setPrintWithSymmetry(VARIANT_BOOL bPrintWithSymmetry)
Update the print with symmetry.
EwErrorCode setPrintAllProjectFiles(VARIANT_BOOL bPrintAllProjectFiles)
Update with true to print all project files.
EwErrorCode setExportOnePDFFileByBook(VARIANT_BOOL bExportOnePDFFileByBook)
Update with true to export one PDF file by book.
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:26
VARIANT_BOOL getPrintWithSymmetry(EwErrorCode *errorCode)
Return true to print with symmetry, false for standard print.
BSTR getPrinterName(EwErrorCode *errorCode)
Get the printer name of the config print.
EwTextSeparator
Text separator options.
Definition: EnumDefinition.idl:170
EwStandardScaleType getStandardScaleType(EwErrorCode *errorCode)
Get the scale type EwStandardScaleType enumeration value for export PDF file.
EwErrorCode setDrawingOption(EwTSDrawingOption eTSDrawingOption)
Define the behavior when a terminal strip is already drawn and destination folder has changed.
EwErrorCode setPrintCopiesNumber(int nCopiesNumbery)
Update the number of copies to print.
EwErrorCode exportPDF()
Export PDF file inside this project.
LONG getCount(EwErrorCode *errorCode)
Return the number of print configuration of associated project.
EwErrorCode setIncludeColumnHeader(VARIANT_BOOL bIncludeColumnHeader)
Set this flag to true if you want column header exported on the first row.
EwErrorCode setFilter(BSTR strFilter)
Update the filter name of the report used inside the project.
EwPageOrientation getEwPageOrientation(EwErrorCode *errorCode)
Return the page orientation to the PDF file export.
EwErrorCode setDestinationBookOrFolderID(long lEwProjectComponentID, long lEwBookOrFolderID)
Specify the destination book or folder when generating terminal strip drawings.
EwTextSeparator getEwTextSeparator(EwErrorCode *errorCode)
Return the text separator for text export ofreports.
EwErrorCode setEwPageOrientation(EwPageOrientation ePageOrientation)
Update the page orientation.
EwErrorCode setPrintCollate(VARIANT_BOOL bPrintCollate)
Update with true to print collate, or with false for standard print or numbers of copies is 1.
VARIANT getScaleValuesArray(EwErrorCode *errorCode)
Return the array of string of scale values.
IEwProjectPrintConfigX findProjectPrintConfigByName(BSTR strPrintConfigName, EwErrorCode *errorCode)
Get the print configuration from name, for associated project.
BSTR getReportFileName(EwErrorCode *errorCode)
Return the Report FileName of the report used inside the project.
EwErrorCode setGenerateAutomatedDrawings(VARIANT_BOOL bGenerateAutomatedDrawings)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
EwErrorCode setEwProjectReportIDArray(VARIANT vProjectReportIDArray)
Set array of ID of EwProjectReport objects.
VARIANT_BOOL getGenerateLog(EwErrorCode *errorCode)
Return True if a log is generated.
EwErrorCode setEwFileExtension(EwFileExtension eFileExtension)
Update the report type file extension.
EwErrorCode setTargetFolder(BSTR strFolderPath)
Update the exported target folder path.
double getDrawingScaleUnit(EwErrorCode *errorCode)
Get the drawing scale unit for the the scale type, or a custom drawing scale type.
VARIANT_BOOL getOneSheetByBreak(EwErrorCode *errorCode)
Indicate if the export will create one sheet by break.
EwProjectDataExportType getEwProjectDataExportType(EwErrorCode *errorCode)
Return the type of the report used inside the project.
VARIANT_BOOL getAddCreatedFileToProject(EwErrorCode *errorCode)
Indicates if exported files will be added to the project.
EwErrorCode doXMLExport()
Export reports in XML type.
EwErrorCode setExportAllReports(VARIANT_BOOL bExportAllReports)
Set this flag to true to export all reports of the project.
VARIANT getPdfExportPaperFormatsArray(EwErrorCode *errorCode)
Return the array of string of paper formats for the PDF export.
Use this interface to manage the generation of terminal strip drawing inside the project.
Definition: EwProjectExportObjects.idl:1276
VARIANT getSheetStylesArray(EwErrorCode *errorCode)
Return an array of string of all available plot style tables.
VARIANT getProjectPrintConfigArray(EwErrorCode *errorCode)
Return the array of IEwProjectPrintConfigX of given type for associated project.
EwTSDrawingOption getDrawingOption(EwErrorCode *errorCode)
Get the drawing option.
BSTR getPrintStyleSheetName(EwErrorCode *errorCode)
Get the style sheet name of the config print.
EwErrorCode doExcelAutomation()
Start the Excel Automation.
EwPlotArea getEwPlotArea(EwErrorCode *errorCode)
Get the plot area in print configuration.
double getPrintDrawingScaleUnit(EwErrorCode *errorCode)
Get the drawing scale unit for the the scale type, or a custom drawing scale type.
EwErrorCode setOneSheetByBreak(VARIANT_BOOL bOneSheetByBreak)
Set this flag to true to export one sheet by break.
int getPrintCopiesNumber(EwErrorCode *errorCode)
Return the number of copies to print.
IEwProjectReportX find(BSTR strFileName, BSTR strFilterName, EwErrorCode *errorCode)
Find a report from his file name and a filter name.
VARIANT getPrinterPaperSourcesArray(BSTR strPrinterName, EwErrorCode *errorCode)
Return the array of string of paper sources.
EwProjectDataExportType getEwProjectDataExportType(EwErrorCode *errorCode)
Return the type of report to export.
BSTR getPDMConfigFilePath(EwErrorCode *errorCode)
Return the PDM config file name.
BSTR getPaperSource(EwErrorCode *errorCode)
Get the paper source of the config print.
EwErrorCode setExportDwgSelectionFiles(VARIANT aFolioArray)
Set the files to export with the files ID specify in the input array.
Use this interface to manage a print configuration inside a project.
Definition: EwProjectExportObjects.idl:26
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 getPrintCollate(EwErrorCode *errorCode)
Return true to print collate, false for standard print or numbers of copies is 1.
EwFileExtension getEwFileExtension(EwErrorCode *errorCode)
Return the type of the report file extension.
EwProjectDataExportType
All data export configuration.
Definition: EwEnumeration.idl:465
VARIANT_BOOL getGenerateAutomatedDrawings(EwErrorCode *errorCode)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
VARIANT getEwProjectReportIDArray(EwErrorCode *errorCode)
Return array of ID of EwProjectReport objects.
EwErrorCode setEwPlotArea(EwPlotArea ePlotArea)
Set the plot area in print configuration.
IEwProjectReportX at(int iIndex, EwErrorCode *errorCode)
Return an IEwProjectReportX object from the associated project.
BSTR getPrintConfigName(EwErrorCode *errorCode)
Get the config name of the config print.
EwErrorCode setOrderNo(LONG lOrderNo)
Update the Order No of thereport used inside the project.
EwErrorCode setGenerateAutomatedDrawings(VARIANT_BOOL bGenerateAutomatedDrawings)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
EwDwgFileExport
All possible export DWG file type for a project.
Definition: EwEnumeration.idl:455
IEwProjectPrintConfigX newEwProjectPrintConfig(EwErrorCode *errorCode)
Create an IEwProjectPrintConfigX object from the associated project.
EwErrorCode setPrintPaperScaleUnit(double dPrintPaperScaleUnit)
Update the paper scale unit for custom paper scale type.
EwErrorCode setExportToPDFBookmarkAndHyperlink(VARIANT_BOOL bExportToPDFBookmarkAndHyperlink)
Update with true to export PDF bookmark and hyperlink.
VARIANT getPrintSelectionFiles(EwErrorCode *errorCode)
Return the files to print in an array This parameter is used if "all project files" option is set to ...
VARIANT_BOOL getExportToPDFBookmarkAndHyperlink(EwErrorCode *errorCode)
Return true to export PDF bookmark and hyperlink.
EwErrorCode setReportFileName(BSTR strReportFileName)
Update the ReportFileName name of the report used inside the project.
VARIANT getEwResumeRowXArray(EwErrorCode *errorCode)
Return an array of EwResumeRowX that contains all Log from the last excel automation launch.
BSTR getTargetFolder(EwErrorCode *errorCode)
Return the exported target folder path.
EwErrorCode setLogFilePath(BSTR strLogFilePath)
Specify the Log file path.
Use this interface to manage the Excel Automation inside the project.
Definition: EwProjectExportObjects.idl:1354
EwErrorCode exportToPDM()
Run the command "Export to PDM" using the default configuration file or the one defined in setPDMConf...
BSTR getExportToPDFFileName(EwErrorCode *errorCode)
Get the export to PDF file path.
EwErrorCode setPrintUsingStyleSheet(VARIANT_BOOL bPrintUsingStyleSheet)
Update with true to print using style sheet.
VARIANT getPrinterPaperFormatsArray(BSTR strPrinterName, EwErrorCode *errorCode)
Return the array of string of paper formats.
EwPageOrientation
All Page orientation.
Definition: EwEnumeration.idl:481
BSTR getPaperFormat(EwErrorCode *errorCode)
Get the paper format of the config print.
EwErrorCode setPaperScaleUnit(double dPaperScaleUnit)
Update the paper scale unit for custom paper scale type.
EwErrorCode setEwTextIdentifer(EwTextIdentifer eTextIdentifier)
Update the text identifier for text export of reports.
EwErrorCode setEwTextSeparator(EwTextSeparator eTextSeparator)
Update the text separator for text export of reports.
double getPrintPaperScaleUnit(EwErrorCode *errorCode)
Get the paper scale unit for the scale type, or a custom paper scale type.
VARIANT_BOOL getIncludeColumnHeader(EwErrorCode *errorCode)
Indicate if column header is exported on the first row.
Use this interface to export file in PDF inside a project.
Definition: EwProjectExportObjects.idl:1458
EwErrorCode setStandardScaleType(EwStandardScaleType eEwStandardScaleType)
Update the Scale Type with an EwStandardScaleType enumeration value.
EwPDFPaperFormat getPaperFormat(EwErrorCode *errorCode)
Get the enum EwPDFPaperFormat paper format of the PDF export files.
Use this interface to manage the command "Export to PDM".
Definition: EwProjectExportObjects.idl:713
EwErrorCode setDrawingScaleUnit(double dDrawingScaleUnit)
Update the drawing scale unit for custom drawing scale type.
EwErrorCode setExcelFilePath(BSTR strExcelFilePath)
Specify the full path to the Excel file for automation.
EwErrorCode setAddCreatedFileToProject(VARIANT_BOOL bAddCreatedFileToProject)
Set this value to true to add exported files to the project.
VARIANT_BOOL getExportOnePDFFileByBook(EwErrorCode *errorCode)
Return true to export one PDF file by book.
EwErrorCode setEwPageOrientation(EwPageOrientation ewPageOrientation)
Update the page orientation.