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
Expand IEwObjectDispatchXIEwObjectDispatchX
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
IEwSaveDWGImageX Interface Reference

This interface for export DWG to image. More...

Inheritance diagram for IEwSaveDWGImageX:
Inheritance graph

Public Member Functions

EwErrorCode setSaveImageType (EwSaveImageType ewSaveImageType)
 Set save type (JPEG, PNG, BMP or GIF). More...
 
EwSaveImageType getSaveImageType (EwErrorCode *errorCode)
 Return save type (JPEG, PNG, BMP or GIF). More...
 
EwErrorCode setOverwriteDestination (VARIANT_BOOL bOverrideIfExist)
 Set as true if you can overwrite existing file. More...
 
VARIANT_BOOL getOverwriteDestination (EwErrorCode *errorCode)
 Get overwrite value true if overwrite. More...
 
EwErrorCode setDestinationFilePath (BSTR strFilePath)
 Set destination file to export DWG in picture. More...
 
BSTR getDestinationFilePath (EwErrorCode *errorCode)
 Get export destination file. More...
 
EwErrorCode setDWGFilePath (BSTR strFilePath)
 Set DWG file path to export. More...
 
BSTR getDWGFilePath (EwErrorCode *errorCode)
 Get file path DWG to export. More...
 
EwErrorCode setWidth (long lWidth)
 Set width (in pixel) of picture. More...
 
long getWidth (EwErrorCode *errorCode)
 Get Width (in pixel) of picture. More...
 
EwErrorCode setHeight (long lHeight)
 Set height (in pixel) of picture. More...
 
long getHeight (EwErrorCode *errorCode)
 Get height (in pixel) of picture. More...
 
EwErrorCode save ()
 Save DWG in picture. More...
 
EwErrorCode setHideAttributes (VARIANT_BOOL bHideAttributes)
 Set value to Show or Hide attribute of DWG in picture. More...
 
VARIANT_BOOL getHideAttributes (EwErrorCode *errorCode)
 Get value to Show or Hide attribute of DWG in picture. More...
 
EwErrorCode setShowInsertionPoint (VARIANT_BOOL bShowInsertionPoint)
 Set value to show or hide insertion point of DWG in picture. More...
 
VARIANT_BOOL getShowInsertionPoint (EwErrorCode *errorCode)
 Get value to show or hide insertion point of DWG in picture. More...
 

Detailed Description

This interface for export DWG to image.

Since
2022 SP0

Member Function Documentation

◆ getDestinationFilePath()

BSTR IEwSaveDWGImageX::getDestinationFilePath ( EwErrorCode errorCode)

Get export destination file.

Parameters
[out]errorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
file path of export picture

◆ getDWGFilePath()

BSTR IEwSaveDWGImageX::getDWGFilePath ( EwErrorCode errorCode)

Get file path DWG to export.

Parameters
[out]errorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
DWG file path to export

◆ getHeight()

long IEwSaveDWGImageX::getHeight ( EwErrorCode errorCode)

Get height (in pixel) of picture.

Parameters
[out]errorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
height of picture

◆ getHideAttributes()

VARIANT_BOOL IEwSaveDWGImageX::getHideAttributes ( EwErrorCode errorCode)

Get value to Show or Hide attribute of DWG in picture.

Default value : false.

Since
2022 SP2
Parameters
[out]errorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
if true, the thumbnail file generated must not have attributes inside

◆ getOverwriteDestination()

VARIANT_BOOL IEwSaveDWGImageX::getOverwriteDestination ( EwErrorCode errorCode)

Get overwrite value true if overwrite.

Parameters
[out]errorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true if file is overwrite false if not

◆ getSaveImageType()

EwSaveImageType IEwSaveDWGImageX::getSaveImageType ( EwErrorCode errorCode)

Return save type (JPEG, PNG, BMP or GIF).


Parameters
[out]errorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred return EwSaveImageType enum can be:
  • kSaveImageJPEG save picture as JPEG
  • kSaveImagePNG save picture as PNG
  • kSaveImageBMP save picture as BMP
  • kSaveImageGIF save picture as GIF
  • kSaveImageUndefined undefined format.

◆ getShowInsertionPoint()

VARIANT_BOOL IEwSaveDWGImageX::getShowInsertionPoint ( EwErrorCode errorCode)

Get value to show or hide insertion point of DWG in picture.

Default value : false.

Since
2023 SP0
Parameters
[out]errorCodeenum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
if true, the thumbnail file generated must not have insertion point inside

◆ getWidth()

long IEwSaveDWGImageX::getWidth ( EwErrorCode errorCode)

Get Width (in pixel) of picture.

Parameters
[out]errorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
width of picture

◆ save()

EwErrorCode IEwSaveDWGImageX::save ( )

Save DWG in picture.


Default format : PNG.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if DWG file path is empty or undefined export format
  • EW_CAN_NOT_WRITE impossible to create or overwrite export file
  • EW_CANNOT_OPEN cannot read DWG file
  • EW_UNDEFINED_ERROR if another error occurred

◆ setDestinationFilePath()

EwErrorCode IEwSaveDWGImageX::setDestinationFilePath ( BSTR  strFilePath)

Set destination file to export DWG in picture.

Parameters
[in]strFilePathfile path to export
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if folder of export file doesn't exist
  • EW_UNDEFINED_ERROR if another error occurred

◆ setDWGFilePath()

EwErrorCode IEwSaveDWGImageX::setDWGFilePath ( BSTR  strFilePath)

Set DWG file path to export.

Parameters
[in]strFilePathfile path to export
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if file path not exist or is empty
  • EW_UNDEFINED_ERROR if another error occurred

◆ setHeight()

EwErrorCode IEwSaveDWGImageX::setHeight ( long  lHeight)

Set height (in pixel) of picture.

Parameters
[in]lHeightheight of picture
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setHideAttributes()

EwErrorCode IEwSaveDWGImageX::setHideAttributes ( VARIANT_BOOL  bHideAttributes)

Set value to Show or Hide attribute of DWG in picture.

Default value : false.

Since
2022 SP2
Parameters
[in]bHideAttributesto Show/Hide Attribute
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setOverwriteDestination()

EwErrorCode IEwSaveDWGImageX::setOverwriteDestination ( VARIANT_BOOL  bOverrideIfExist)

Set as true if you can overwrite existing file.

Parameters
[in]bOverrideIfExisttrue to overwrite
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSaveImageType()

EwErrorCode IEwSaveDWGImageX::setSaveImageType ( EwSaveImageType  ewSaveImageType)

Set save type (JPEG, PNG, BMP or GIF).

Parameters
[in]ewSaveImageTypeEwSaveImageType enum of save type can be:
  • kSaveImageJPEG save picture as JPEG
  • kSaveImagePNG save picture as PNG
  • kSaveImageBMP save picture as BMP
  • kSaveImageGIF save picture as GIF
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if bad format pass
  • EW_UNDEFINED_ERROR if another error occurred

◆ setShowInsertionPoint()

EwErrorCode IEwSaveDWGImageX::setShowInsertionPoint ( VARIANT_BOOL  bShowInsertionPoint)

Set value to show or hide insertion point of DWG in picture.

Default value : false.

Since
2023 SP0
Parameters
[in]bShowInsertionPointto show/hide insertion point
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected

◆ setWidth()

EwErrorCode IEwSaveDWGImageX::setWidth ( long  lWidth)

Set width (in pixel) of picture.

Parameters
[in]lWidthwidth of picture
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: IEwSaveDWGImageX 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.