Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Collapse IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentCircuitX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExportDWGFilesX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwXLSBookX
IEwXLSSheetX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
IEwProjectPrintConfigX Interface Reference

Use this interface to manage a print configuration inside a project. More...

Inheritance diagram for IEwProjectPrintConfigX:
[legend]

Public Member Functions

BSTR getPrinterName (EwErrorCode *errorCode)
 Get the printer name of the config print. More...
 
EwErrorCode setPrinterName (BSTR strPrinterName)
 Update the printer name with a new name. More...
 
BSTR getPaperFormat (EwErrorCode *errorCode)
 Get the paper format of the config print. More...
 
EwErrorCode setPaperFormat (BSTR strPaperFormat)
 Update the paper format with a new name. More...
 
BSTR getPaperSource (EwErrorCode *errorCode)
 Get the paper source of the config print. More...
 
EwErrorCode setPaperSource (BSTR strPaperSource)
 Update the paper source. More...
 
EwPageOrientation getEwPageOrientation (EwErrorCode *errorCode)
 Return the page orientation of the config print. More...
 
EwErrorCode setEwPageOrientation (EwPageOrientation ewPageOrientation)
 Update the page orientation. More...
 
VARIANT_BOOL getPrintWithSymmetry (EwErrorCode *errorCode)
 Return true to print with symmetry, false for standard print. More...
 
EwErrorCode setPrintWithSymmetry (VARIANT_BOOL bPrintWithSymmetry)
 Update the print with symmetry. More...
 
VARIANT_BOOL getInversePrintOrder (EwErrorCode *errorCode)
 Return true to print from last page, false to print from first page. More...
 
EwErrorCode setInversePrintOrder (VARIANT_BOOL bInversePrintOrder)
 Update the inverse print order. More...
 
int getPrintCopiesNumber (EwErrorCode *errorCode)
 Return the number of copies to print. More...
 
EwErrorCode setPrintCopiesNumber (int nCopiesNumbery)
 Update the number of copies to print. More...
 
VARIANT_BOOL getPrintCollate (EwErrorCode *errorCode)
 Return true to print collate, false for standard print or numbers of copies is 1. More...
 
EwErrorCode setPrintCollate (VARIANT_BOOL bPrintCollate)
 Update with true to print collate, or with false for standard print or numbers of copies is 1. More...
 
VARIANT_BOOL getPrintUsingStyleSheet (EwErrorCode *errorCode)
 Return true to print using style sheet. More...
 
EwErrorCode setPrintUsingStyleSheet (VARIANT_BOOL bPrintUsingStyleSheet)
 Update with true to print using style sheet. More...
 
BSTR getPrintStyleSheetName (EwErrorCode *errorCode)
 Get the style sheet name of the config print. More...
 
EwErrorCode setPrintStyleSheetName (BSTR strPrintStyleSheetName)
 Update the style sheet name with a new name. More...
 
BSTR getPrintScaleType (EwErrorCode *errorCode)
 Get the scale type of the config print. More...
 
EwErrorCode setPrintScaleType (BSTR strPrintScaleType)
 Update the scale type with a new name. More...
 
double getPrintPaperScaleUnit (EwErrorCode *errorCode)
 Get the paper scale unit for the scale type, or a custom paper scale type. More...
 
EwErrorCode setPrintPaperScaleUnit (double dPrintPaperScaleUnit)
 Update the paper scale unit for custom paper scale type. More...
 
double getPrintDrawingScaleUnit (EwErrorCode *errorCode)
 Get the drawing scale unit for the the scale type, or a custom drawing scale type. More...
 
EwErrorCode setPrintdrawingScaleUnit (double dPrintdrawingScaleUnit)
 Update the drawing scale unit for custom drawing scale type. More...
 
VARIANT_BOOL getExportToPDFFiles (EwErrorCode *errorCode)
 Return true to export to pdf files. More...
 
EwErrorCode setExportToPDFFiles (VARIANT_BOOL bExportToPDFFiles)
 Set this option to true to export to a pdf file. More...
 
BSTR getExportToPDFFileName (EwErrorCode *errorCode)
 Get the export to PDF file path. More...
 
EwErrorCode setExportToPDFFileName (BSTR strExportToPDFFilePath)
 Set the export to PDF file path. More...
 
VARIANT_BOOL getExportToPDFBookmarkAndHyperlink (EwErrorCode *errorCode)
 Return true to export pdf bookmark and hyperlink. More...
 
EwErrorCode setExportToPDFBookmarkAndHyperlink (VARIANT_BOOL bExportToPDFBookmarkAndHyperlink)
 Update with true to export pdf bookmark and hyperlink. More...
 
VARIANT_BOOL getExportOnePDFFileByBook (EwErrorCode *errorCode)
 Return true to export one pdf file by book. More...
 
EwErrorCode setExportOnePDFFileByBook (VARIANT_BOOL bExportOnePDFFileByBook)
 Update with true to export one pdf file by book. More...
 
VARIANT_BOOL getPrintAllProjectFiles (EwErrorCode *errorCode)
 Return true to print all project files. More...
 
EwErrorCode setPrintAllProjectFiles (VARIANT_BOOL bPrintAllProjectFiles)
 Update with true to print all project files. More...
 
VARIANT getPrintSelectionFiles (EwErrorCode *errorCode)
 Return the files to print in an array This parameter is used if "all project files" option is set to false. More...
 
EwErrorCode setPrintSelectionFiles (VARIANT aFolioArray)
 Set the files to print with the files ID specify in the input array. More...
 
EwErrorCode print ()
 Print project. More...
 
BSTR getPrintConfigName (EwErrorCode *errorCode)
 Get the config name of the config print. More...
 
EwErrorCode setPrintConfigName (BSTR strPrintConfigName)
 Update the config name with a new unique name. More...
 
VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode *errorCode)
 Option to update all generated files like Terminal strips or Reports which have been added to the project. More...
 
EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings)
 Option to update all generated files like Terminal strips or Reports which have been added to the project. More...
 
- Public Member Functions inherited from IEwObjectBaseX
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 
LONG getID ()
 

Detailed Description

Use this interface to manage a print configuration inside a project.

Since
2018 SP0

Member Function Documentation

◆ getEwPageOrientation()

EwPageOrientation IEwProjectPrintConfigX::getEwPageOrientation ( EwErrorCode errorCode)

Return the page orientation of the config print.

LANDSCAPE is the default enum value

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the paper orientation is not found
  • EW_UNDEFINED_ERROR if another error occurred
Returns
EwExportPageOrientation enum type, can be:
  • LANDSCAPE for landscape orientation
  • PORTRAIT for portrait orientation

◆ getExportOnePDFFileByBook()

VARIANT_BOOL IEwProjectPrintConfigX::getExportOnePDFFileByBook ( EwErrorCode errorCode)

Return true to export one pdf file by book.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true to export one pdf file by book.

◆ getExportToPDFBookmarkAndHyperlink()

VARIANT_BOOL IEwProjectPrintConfigX::getExportToPDFBookmarkAndHyperlink ( EwErrorCode errorCode)

Return true to export pdf bookmark and hyperlink.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true to export pdf bookmark and hyperlink.

◆ getExportToPDFFileName()

BSTR IEwProjectPrintConfigX::getExportToPDFFileName ( EwErrorCode errorCode)

Get the export to PDF file path.

Example: "C:\ExportToPDF\MyProject.pdf"

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the paper format of the config print.

◆ getExportToPDFFiles()

VARIANT_BOOL IEwProjectPrintConfigX::getExportToPDFFiles ( EwErrorCode errorCode)

Return true to export to pdf files.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true to export to pdf files.

◆ getGenerateAutomatedDrawings()

VARIANT_BOOL IEwProjectPrintConfigX::getGenerateAutomatedDrawings ( EwErrorCode errorCode)

Option to update all generated files like Terminal strips or Reports which have been added to the project.

Default value is true.

Since
2020 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Returns true by default, false otherwise.

◆ getInversePrintOrder()

VARIANT_BOOL IEwProjectPrintConfigX::getInversePrintOrder ( EwErrorCode errorCode)

Return true to print from last page, false to print from first page.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true to print from last page, false for print from first page.

◆ getPaperFormat()

BSTR IEwProjectPrintConfigX::getPaperFormat ( EwErrorCode errorCode)

Get the paper format of the config print.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the paper format is not found
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the paper format of the config print.

◆ getPaperSource()

BSTR IEwProjectPrintConfigX::getPaperSource ( EwErrorCode errorCode)

Get the paper source of the config print.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the paper source is not found
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the paper source of the config print.

◆ getPrintAllProjectFiles()

VARIANT_BOOL IEwProjectPrintConfigX::getPrintAllProjectFiles ( EwErrorCode errorCode)

Return true to print all project files.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true to print all project files.

◆ getPrintCollate()

VARIANT_BOOL IEwProjectPrintConfigX::getPrintCollate ( EwErrorCode errorCode)

Return true to print collate, false for standard print or numbers of copies is 1.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true to print collate, false for standard print or numbers of copies is 1.

◆ getPrintConfigName()

BSTR IEwProjectPrintConfigX::getPrintConfigName ( EwErrorCode errorCode)

Get the config name of the config print.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the property name is not found
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the config name of the config print.

◆ getPrintCopiesNumber()

int IEwProjectPrintConfigX::getPrintCopiesNumber ( EwErrorCode errorCode)

Return the number of copies to print.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the number of copies to print

◆ getPrintDrawingScaleUnit()

double IEwProjectPrintConfigX::getPrintDrawingScaleUnit ( EwErrorCode errorCode)

Get the drawing scale unit for the the scale type, or a custom drawing scale type.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the drawing scale unit.

◆ getPrinterName()

BSTR IEwProjectPrintConfigX::getPrinterName ( EwErrorCode errorCode)

Get the printer name of the config print.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the property name is not found
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the printer name of the config print.

◆ getPrintPaperScaleUnit()

double IEwProjectPrintConfigX::getPrintPaperScaleUnit ( EwErrorCode errorCode)

Get the paper scale unit for the scale type, or a custom paper scale type.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the paper scale unit.

◆ getPrintScaleType()

BSTR IEwProjectPrintConfigX::getPrintScaleType ( EwErrorCode errorCode)

Get the scale type of the config print.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the paper format of the config print.

◆ getPrintSelectionFiles()

VARIANT IEwProjectPrintConfigX::getPrintSelectionFiles ( EwErrorCode errorCode)

Return the files to print in an array This parameter is used if "all project files" option is set to false.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if "all project files" option is set to true
  • EW_UNDEFINED_ERROR if another error occurred

◆ getPrintStyleSheetName()

BSTR IEwProjectPrintConfigX::getPrintStyleSheetName ( EwErrorCode errorCode)

Get the style sheet name of the config print.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the paper format of the config print.

◆ getPrintUsingStyleSheet()

VARIANT_BOOL IEwProjectPrintConfigX::getPrintUsingStyleSheet ( EwErrorCode errorCode)

Return true to print using style sheet.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true to print using style sheet

◆ getPrintWithSymmetry()

VARIANT_BOOL IEwProjectPrintConfigX::getPrintWithSymmetry ( EwErrorCode errorCode)

Return true to print with symmetry, false for standard print.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true to print with symmetry, false for standard print

◆ print()

EwErrorCode IEwProjectPrintConfigX::print ( )

Print project.

if "Export PDF File" option is set to true, the printer name is changed to TrPs

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if print project configuration are not correctly filled
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEwPageOrientation()

EwErrorCode IEwProjectPrintConfigX::setEwPageOrientation ( EwPageOrientation  ewPageOrientation)

Update the page orientation.

LANDSCAPE is the default enum value

Parameters
[in]ewPageOrientationEwExportPageOrientation enum type, can be:
  • LANDSCAPE for landscape orientation
  • PORTRAIT for portrait orientation
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the paper orientation is not found
  • EW_UNDEFINED_ERROR if another error occurred

◆ setExportOnePDFFileByBook()

EwErrorCode IEwProjectPrintConfigX::setExportOnePDFFileByBook ( VARIANT_BOOL  bExportOnePDFFileByBook)

Update with true to export one pdf file by book.

Parameters
[in]bExportOnePDFFileByBooktrue for export one pdf file by book.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setExportToPDFBookmarkAndHyperlink()

EwErrorCode IEwProjectPrintConfigX::setExportToPDFBookmarkAndHyperlink ( VARIANT_BOOL  bExportToPDFBookmarkAndHyperlink)

Update with true to export pdf bookmark and hyperlink.

Parameters
[in]bExportToPDFBookmarkAndHyperlinktrue for export to pdf files.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setExportToPDFFileName()

EwErrorCode IEwProjectPrintConfigX::setExportToPDFFileName ( BSTR  strExportToPDFFilePath)

Set the export to PDF file path.

Example: "C:\ExportToPDF\MyProject.pdf"

Parameters
[in]strExportToPDFFilePaththe path and the name of the output pdf.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the export to pdf file path is not found
  • EW_UNDEFINED_ERROR if another error occurred

◆ setExportToPDFFiles()

EwErrorCode IEwProjectPrintConfigX::setExportToPDFFiles ( VARIANT_BOOL  bExportToPDFFiles)

Set this option to true to export to a pdf file.

When the option is set to true, if default postscript printer is not existing in the list of printers, the printer name is changed to 'PDFCreator' if it exists.

Parameters
[in]bExportToPDFFilestrue for export to pdf files.
Returns
EwErrorCode enum type, can be:
  • EW_INVALID_OBJECT if print configuration name is not <PDF>
  • EW_BAD_INPUTS If default postscript printer and 'PDFCreator' are not existing in the list of printers
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setGenerateAutomatedDrawings()

EwErrorCode IEwProjectPrintConfigX::setGenerateAutomatedDrawings ( VARIANT_BOOL  bGenerateAutomatedDrawings)

Option to update all generated files like Terminal strips or Reports which have been added to the project.

Default value is true.

Since
2020 SP0
Parameters
[in]bGenerateAutomatedDrawingscan be true or false. True for update all generated files.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setInversePrintOrder()

EwErrorCode IEwProjectPrintConfigX::setInversePrintOrder ( VARIANT_BOOL  bInversePrintOrder)

Update the inverse print order.

Parameters
[in]bInversePrintOrdertrue for print from last page, false for print from first page.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPaperFormat()

EwErrorCode IEwProjectPrintConfigX::setPaperFormat ( BSTR  strPaperFormat)

Update the paper format with a new name.

Parameters
[in]strPaperFormatthe new paper format
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the paper format is not found
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPaperSource()

EwErrorCode IEwProjectPrintConfigX::setPaperSource ( BSTR  strPaperSource)

Update the paper source.

Parameters
[in]strPaperSourcethe new paper source
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the paper source is not found
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintAllProjectFiles()

EwErrorCode IEwProjectPrintConfigX::setPrintAllProjectFiles ( VARIANT_BOOL  bPrintAllProjectFiles)

Update with true to print all project files.

Parameters
[in]bPrintAllProjectFilestrue for print all project files.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintCollate()

EwErrorCode IEwProjectPrintConfigX::setPrintCollate ( VARIANT_BOOL  bPrintCollate)

Update with true to print collate, or with false for standard print or numbers of copies is 1.

Parameters
[in]bPrintCollatetrue for print collate, false for standard print or numbers of copies is 1
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintConfigName()

EwErrorCode IEwProjectPrintConfigX::setPrintConfigName ( BSTR  strPrintConfigName)

Update the config name with a new unique name.

Parameters
[in]strPrintConfigNamethe new config name
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the print config name already exist or is empty
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintCopiesNumber()

EwErrorCode IEwProjectPrintConfigX::setPrintCopiesNumber ( int  nCopiesNumbery)

Update the number of copies to print.

1 is the default value.

Parameters
[in]nCopiesNumberythe number of copies to print
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the number of copies is < 1
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintdrawingScaleUnit()

EwErrorCode IEwProjectPrintConfigX::setPrintdrawingScaleUnit ( double  dPrintdrawingScaleUnit)

Update the drawing scale unit for custom drawing scale type.

Parameters
[in]dPrintdrawingScaleUnitthe drawing scale unit.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the scale type is "Fit to format" or dPrintdrawingScaleUnit is under 0
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrinterName()

EwErrorCode IEwProjectPrintConfigX::setPrinterName ( BSTR  strPrinterName)

Update the printer name with a new name.

Parameters
[in]strPrinterNamethe new printer name
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the printer name is not found or the printer configuration name is <PDF>
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintPaperScaleUnit()

EwErrorCode IEwProjectPrintConfigX::setPrintPaperScaleUnit ( double  dPrintPaperScaleUnit)

Update the paper scale unit for custom paper scale type.

Parameters
[in]dPrintPaperScaleUnitpaper scale unit.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the scale type is "Fit to format" or dPrintPaperScaleUnit is under 0
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintScaleType()

EwErrorCode IEwProjectPrintConfigX::setPrintScaleType ( BSTR  strPrintScaleType)

Update the scale type with a new name.

Update the paper and the drawing scale unit if type is not "Fit to format" or "Custom". Warning: the input parameter are case sensitive.

Parameters
[in]strPrintScaleTypethe new name for scale type.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the scale type is not found
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintSelectionFiles()

EwErrorCode IEwProjectPrintConfigX::setPrintSelectionFiles ( VARIANT  aFolioArray)

Set the files to print with the files ID specify in the input array.

This parameter is used if "all project files" option is set to false. This function remove the previous selected files and fill the selection file with the input array.

Parameters
[in]aFolioArrayan array of id files.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if "all project files" option is set to true or the aFolioArray array is not a long array
  • EW_BAD_INPUTS if aFolioArray array size = 0
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintStyleSheetName()

EwErrorCode IEwProjectPrintConfigX::setPrintStyleSheetName ( BSTR  strPrintStyleSheetName)

Update the style sheet name with a new name.

Parameters
[in]strPrintStyleSheetNamethe new name for style sheet.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the style sheet name is not found
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintUsingStyleSheet()

EwErrorCode IEwProjectPrintConfigX::setPrintUsingStyleSheet ( VARIANT_BOOL  bPrintUsingStyleSheet)

Update with true to print using style sheet.

Parameters
[in]bPrintUsingStyleSheettrue for print using style sheet
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setPrintWithSymmetry()

EwErrorCode IEwProjectPrintConfigX::setPrintWithSymmetry ( VARIANT_BOOL  bPrintWithSymmetry)

Update the print with symmetry.

Parameters
[in]bPrintWithSymmetrytrue for print with symmetry false for standard print
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred


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: IEwProjectPrintConfigX Interface Reference
*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.