Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand SampleSample
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Collapse IEwObjectDispatchXIEwObjectDispatchX
Collapse IEwObjectBaseXIEwObjectBaseX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Collapse IEwObjectXIEwObjectX
IEwClassificationX
IEwProjectComponentCircuitX
IEwProjectConfigurationX
IEwProjectEntity3DX
IEwProjectInputOutputX
IEwProjectManufacturerPartX
IEwProjectMultilingualTextX
IEwProjectPrintConfigX
IEwProjectReportX
IEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
IEwProjectWireStyleGroupX
IEwProjectWireStyleX
IEwProjectWireX
IEwProjectComponentTerminalX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectWireStyleManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
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 Inspection API HelpSOLIDWORKS Inspection 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
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectPrintConfigX Interface Reference

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

Inheritance diagram for IEwProjectPrintConfigX:
Inheritance graph

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 ePageOrientation)
 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...
 
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 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 vFolioArray)
 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...
 
EwStandardScaleType getPrintStandardScaleType (EwErrorCode *errorCode)
 Get the scale type EwStandardScaleType enumeration value of the config print. More...
 
EwErrorCode setPrintStandardScaleType (EwStandardScaleType eStandardScaleType)
 Update the Scale Type with an EwStandardScaleType enumeration value. More...
 
EwPlotArea getEwPlotArea (EwErrorCode *errorCode)
 Get the plot area in print configuration. More...
 
EwErrorCode setEwPlotArea (EwPlotArea ePlotArea)
 Set the plot area in print configuration. More...
 
- Public Member Functions inherited from IEwObjectX
LONG getID ()
 
- Public Member Functions inherited from IEwObjectBaseX
EwErrorCode insert ()
 Insert the object inside the current project. More...
 
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 

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
  • EW_INVALID_OBJECT if object is not initialized
Returns
EwExportPageOrientation enum type, can be:
  • LANDSCAPE for landscape orientation
  • PORTRAIT for portrait orientation

◆ getEwPlotArea()

EwPlotArea IEwProjectPrintConfigX::getEwPlotArea ( EwErrorCode *  errorCode)

Get the plot area in print configuration.

Default value is kPlotAreaExtent.

Since
2021
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object is not initialized
Returns
the plot area of print configuration.

◆ 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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
Returns
the paper scale unit.

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ getPrintStandardScaleType()

EwStandardScaleType IEwProjectPrintConfigX::getPrintStandardScaleType ( EwErrorCode *  errorCode)

Get the scale type EwStandardScaleType enumeration value of the config print.

If nothing has been intialized the default value returned is kScaleTypeCustom.

Since
2021
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if project object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
The scale type EwStandardScaleType enumeration value of the config print.

◆ 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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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
  • EW_INVALID_OBJECT if object is not initialized
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

Warning
For print PDF file, use IEwProjectExportPDFX instead.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if print configuration is not correctly filled. Check printer name, paper source, paper format, scale type, ...
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized

◆ setEwPageOrientation()

EwErrorCode IEwProjectPrintConfigX::setEwPageOrientation ( EwPageOrientation  ePageOrientation)

Update the page orientation.

LANDSCAPE is the default enum value

Parameters
[in]ePageOrientationEwExportPageOrientation 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
  • EW_INVALID_OBJECT if object is not initialized

◆ setEwPlotArea()

EwErrorCode IEwProjectPrintConfigX::setEwPlotArea ( EwPlotArea  ePlotArea)

Set the plot area in print configuration.

Default value is kPlotAreaExtent.

Since
2021
Parameters
[in]ePlotAreaenumeration of EwPlotArea type.
Returns
errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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 it does not exist
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ setPrintSelectionFiles()

EwErrorCode IEwProjectPrintConfigX::setPrintSelectionFiles ( VARIANT  vFolioArray)

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]vFolioArrayan 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
  • EW_INVALID_OBJECT if object is not initialized

◆ setPrintStandardScaleType()

EwErrorCode IEwProjectPrintConfigX::setPrintStandardScaleType ( EwStandardScaleType  eStandardScaleType)

Update the Scale Type with an EwStandardScaleType enumeration value.

Since
2021
Parameters
[in]eStandardScaleTypethe new EwStandardScaleType enumeration value.
Returns
errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eEwStandardScaleType value is not supported
  • EW_INVALID_OBJECT if project object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized

◆ 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
  • EW_INVALID_OBJECT if object is not initialized
Generated on Mon Aug 28 2023 13:39:21 for SOLIDWORKS Electrical API by doxygen 1.9.4


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) 2024 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.

0.20.46