 |
SOLIDWORKS Electrical API
2020.0.5
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)
506 uuid(151AECB0-06B4-4090-9229-B2F4F01FE360),
510 helpstring(
"IEwProjectPrintConfigManagerX Interface"),
511 pointer_default(unique)
641 uuid(910619A2-421C-4F95-A196-F8685C628BD9),
645 helpstring(
"IEwProjectExportDWGFilesX Interface"),
646 pointer_default(unique)
746 uuid(415A3B4B-F774-41DD-8495-83BE794AB6A7),
749 helpstring(
"IEwProjectExportPDMX Interface"),
750 pointer_default(unique)
814 uuid(5C9D486B-EE01-4C6E-8585-68E392CA4A16),
817 helpstring(
"IEwProjectReportX Interface"),
818 pointer_default(unique)
909 uuid(9795C977-F5E4-4FA5-B527-A28E6D58C1BA),
912 helpstring(
"IEwProjectReportManagerX Interface"),
913 pointer_default(unique)
980 uuid(877D3846-16D9-4730-9FFB-1A396B873DE1),
983 pointer_default(unique)
1309 uuid(E070B6E8-63CC-4C26-B96D-A048122CC774),
1312 pointer_default(unique)
Use this interface to manage the report used inside the project.
Definition: EwProjectExportObjects.idl:821
EwErrorCode setPrintStyleSheetName(BSTR strPrintStyleSheetName)
Update the style sheet name with a new name.
EwErrorCode setPrintScaleType(BSTR strPrintScaleType)
Update the scale type with a new name.
VARIANT_BOOL getExportAllReports(EwErrorCode *errorCode)
Indicate if all reports of the project must be exported.
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.
IEwProjectPrintConfigX findProjectPrintConfigByID(LONG lId, EwErrorCode *errorCode)
Get the print configuration from ID, for associated project.
EwErrorCode setExportToPDFFileName(BSTR strExportToPDFFilePath)
Set the export to PDF file path.
EwErrorCode print()
Print project.
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.
Use this interface to manage the export reports used inside the project.
Definition: EwProjectExportObjects.idl:986
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:648
LONG getCount(EwErrorCode *errorCode)
Return the number of reports of associated project.
EwErrorCode setExportOnePDFFileByBook(VARIANT_BOOL bExportOnePDFFileByBook)
Update with true to export one pdf file by book.
BSTR getExportDirectory(EwErrorCode *errorCode)
Return the export directory path.
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:916
IEwProjectPrintConfigX duplicateEwProjectPrintConfig(LONG lId, EwErrorCode *errorCode)
Create an IEwProjectPrintConfigX object with an existant IEwProjectPrintConfigX object from the assoc...
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:513
EwErrorCode setEwProjectDataExportType(EwProjectDataExportType eProjectDataExportType)
Update the type of report to export.
EwTextIdentifer
Text identifier options.
Definition: EnumDefinition.idl:156
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.
EwErrorCode setEwTextIdentifer(EwTextIdentifer ewTextIdentifier)
Update the text identifier for text export of reports.
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.
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.
IEwProjectReportX findProjectPrintReportByID(LONG lId, EwErrorCode *pErrorCode)
Find a report from his ID.
EwErrorCode setEwProjectReportIDArray(VARIANT ewProjectReportIDArray)
Set array of ID of EwProjectReport objects.
EwTSDrawingOption
Define behavior when updating terminal strip drawings.
Definition: EwEnumeration.idl:727
EwErrorCode setOutputFolderPath(BSTR strOutputFolderPath)
Set the output folder path where all files will be exported.
EwFileExtension
All file types extension.
Definition: EwEnumeration.idl:510
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 setPrintSelectionFiles(VARIANT aFolioArray)
Set the files to print with the files ID specify in the input array.
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.
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:168
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.
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.
EwErrorCode setExportToPDFFiles(VARIANT_BOOL bExportToPDFFiles)
Set this option to true to export to a pdf file.
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 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 setTargetFolder(BSTR strFolderPath)
Update the exported target folder path.
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 exportDwg(EwDwgFileExport ewExportType)
Export previously selected files.
EwErrorCode doXMLExport()
Export reports in XML type.
EwErrorCode setExportAllReports(VARIANT_BOOL bExportAllReports)
Set this flag to true to export all reports of the project.
Use this interface to manage the generation of terminal strip drawing inside the project.
Definition: EwProjectExportObjects.idl:1315
VARIANT getSheetStylesArray(EwErrorCode *errorCode)
Return an array of string of all available plot style tables.
EwErrorCode setEwTextSeparator(EwTextSeparator ewTextSeparator)
Update the text separator for text export of reports.
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.
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...
EwErrorCode setExportToPDFBookmarkAndHyperlink(VARIANT_BOOL bExportToPDFBookmarkAndHyperlink)
Update with true to export pdf bookmark and hyperlink.
VARIANT_BOOL getExportToPDFFiles(EwErrorCode *errorCode)
Return true to export to pdf files.
EwErrorCode setEwPageOrientation(EwPageOrientation ewPageOrientation)
Update the page orientation.
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:456
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.
IEwProjectReportX at(int iIndex, EwErrorCode *errorCode)
Return an IEwProjectReportX object from the associated project.
VARIANT_BOOL getExportToPDFBookmarkAndHyperlink(EwErrorCode *errorCode)
Return true to export pdf bookmark and hyperlink.
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:446
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.
VARIANT getPrintSelectionFiles(EwErrorCode *errorCode)
Return the files to print in an array This parameter is used if "all project files" option is set to ...
EwErrorCode setReportFileName(BSTR strReportFileName)
Update the ReportFileName name of the report used inside the project.
BSTR getPrintScaleType(EwErrorCode *errorCode)
Get the scale type of the config print.
BSTR getTargetFolder(EwErrorCode *errorCode)
Return the exported target folder path.
EwErrorCode exportToPDM()
Run the command "Export to PDM" using the default configuration file or the one defined in setPDMConf...
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:472
BSTR getPaperFormat(EwErrorCode *errorCode)
Get the paper format of the config print.
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.
VARIANT_BOOL getExportOnePDFFileByBook(EwErrorCode *errorCode)
Return true to export one pdf file by book.
Use this interface to manage the command "Export to PDM".
Definition: EwProjectExportObjects.idl:752
EwErrorCode setAddCreatedFileToProject(VARIANT_BOOL bAddCreatedFileToProject)
Set this value to true to add exported files to the project.
BSTR getExportToPDFFileName(EwErrorCode *errorCode)
Get the export to PDF file path.
EwErrorCode setEwFileExtension(EwFileExtension ewExtension)
Update the report type file extension.