Welcome
Expand Getting StartedGetting Started
Collapse SolidWorks API HelpSolidWorks API Help
Functional Categories
Release Notes
Collapse SolidWorks.Interop.sldworks NamespaceSolidWorks.Interop.sldworks Namespace
Overview
Collapse InterfacesInterfaces
Expand IAdvancedSelectionCriteriaIAdvancedSelectionCriteria
Expand IAnnotationIAnnotation
Expand IAnnotationViewIAnnotationView
Expand IAssemblyDocIAssemblyDoc
Expand IAttributeIAttribute
Expand IAttributeDefIAttributeDef
Expand IBalloonStackIBalloonStack
Expand IBaseFlangeFeatureDataIBaseFlangeFeatureData
Expand IBendsFeatureDataIBendsFeatureData
Expand IBody2IBody2
Expand IBodyFolderIBodyFolder
Expand IBomFeatureIBomFeature
Expand IBomTableIBomTable
Expand IBomTableAnnotationIBomTableAnnotation
Expand IBreakCornerFeatureDataIBreakCornerFeatureData
Expand IBreakLineIBreakLine
Expand ICalloutICallout
Expand ICameraICamera
Expand ICavityFeatureDataICavityFeatureData
Expand ICenterLineICenterLine
Expand ICenterMarkICenterMark
Expand IChamferFeatureData2IChamferFeatureData2
Expand ICircularPatternFeatureDataICircularPatternFeatureData
Expand IClosedCornerFeatureDataIClosedCornerFeatureData
Expand ICoEdgeICoEdge
Expand IColorTableIColorTable
Expand ICombineBodiesFeatureDataICombineBodiesFeatureData
Expand ICommandGroupICommandGroup
Expand ICommandManagerICommandManager
Expand ICommandTabICommandTab
Expand ICommandTabBoxICommandTabBox
Expand ICommentIComment
Expand ICommentFolderICommentFolder
Expand IComponent2IComponent2
Expand ICompositeCurveFeatureDataICompositeCurveFeatureData
Expand IConfigurationIConfiguration
Expand IConfigurationManagerIConfigurationManager
Expand IConnectionPointFeatureDataIConnectionPointFeatureData
Expand ICoordinateSystemFeatureDataICoordinateSystemFeatureData
Expand ICoreFeatureDataICoreFeatureData
Expand ICosmeticThreadFeatureDataICosmeticThreadFeatureData
Expand ICThreadICThread
Expand ICurveICurve
Expand ICurveDrivenPatternFeatureDataICurveDrivenPatternFeatureData
Expand ICustomBendAllowanceICustomBendAllowance
Expand ICustomPropertyManagerICustomPropertyManager
Expand IDatumOriginIDatumOrigin
Expand IDatumTagIDatumTag
Expand IDatumTargetSymIDatumTargetSym
Expand IDecalIDecal
Expand IDeleteBodyFeatureDataIDeleteBodyFeatureData
Expand IDeleteFaceFeatureDataIDeleteFaceFeatureData
Expand IDerivedPartFeatureDataIDerivedPartFeatureData
Expand IDerivedPatternFeatureDataIDerivedPatternFeatureData
Expand IDesignTableIDesignTable
Expand IDetailCircleIDetailCircle
Expand IDiagnoseResultIDiagnoseResult
Expand IDimensionIDimension
Expand IDimensionSensorDataIDimensionSensorData
Expand IDimensionToleranceIDimensionTolerance
Expand IDimXpertManagerIDimXpertManager
Expand IDisplayDataIDisplayData
Expand IDisplayDimensionIDisplayDimension
Expand IDocumentSpecificationIDocumentSpecification
Expand IDomeFeatureData2IDomeFeatureData2
Expand IDowelSymbolIDowelSymbol
Expand IDraftFeatureData2IDraftFeatureData2
Expand IDragArrowManipulatorIDragArrowManipulator
Expand IDragOperatorIDragOperator
Expand IDrawingComponentIDrawingComponent
Expand IDrawingDocIDrawingDoc
Expand IDrSectionIDrSection
Expand IEdgeIEdge
Expand IEdgeFlangeFeatureDataIEdgeFlangeFeatureData
Expand IEdgePointIEdgePoint
Expand IEndCapFeatureDataIEndCapFeatureData
Expand IEntityIEntity
Expand IEnumBodies2IEnumBodies2
Expand IEnumCoEdgesIEnumCoEdges
Expand IEnumComponents2IEnumComponents2
Expand IEnumDisplayDimensionsIEnumDisplayDimensions
Expand IEnumDocuments2IEnumDocuments2
Expand IEnumDrSectionsIEnumDrSections
Expand IEnumEdgesIEnumEdges
Expand IEnumFaces2IEnumFaces2
Expand IEnumLoops2IEnumLoops2
Expand IEnumModelViewsIEnumModelViews
Expand IEnumSketchHatchesIEnumSketchHatches
Expand IEnumSketchPointsIEnumSketchPoints
Expand IEnumSketchSegmentsIEnumSketchSegments
Expand IEnvironmentIEnvironment
Expand IEquationMgrIEquationMgr
Expand IExplodeStepIExplodeStep
Expand IExportPdfDataIExportPdfData
Expand IExtrudeFeatureData2IExtrudeFeatureData2
Expand IFace2IFace2
Expand IFaceDecalPropertiesIFaceDecalProperties
Expand IFaceHatchIFaceHatch
Expand IFaultEntityIFaultEntity
Expand IFeatMgrViewIFeatMgrView
Expand IFeatureIFeature
Expand IFeatureManagerIFeatureManager
Expand IFeatureStatisticsIFeatureStatistics
Expand IFillSurfaceFeatureDataIFillSurfaceFeatureData
Expand IFlatPatternFeatureDataIFlatPatternFeatureData
Expand IFoldsFeatureDataIFoldsFeatureData
Expand IFrameIFrame
Expand IFreePointCurveFeatureDataIFreePointCurveFeatureData
Expand IGeneralTableFeatureIGeneralTableFeature
Expand IGtolIGtol
Expand IGussetFeatureDataIGussetFeatureData
Expand IHealEdgesFeatureDataIHealEdgesFeatureData
Expand IHelixFeatureDataIHelixFeatureData
Expand IHemFeatureDataIHemFeatureData
Expand IHoleSeriesFeatureDataIHoleSeriesFeatureData
Expand IHoleTableIHoleTable
Expand IHoleTableAnnotationIHoleTableAnnotation
Expand IImportDxfDwgDataIImportDxfDwgData
Expand IImportedCurveFeatureDataIImportedCurveFeatureData
Expand IImportIgesDataIImportIgesData
Expand IImportStepDataIImportStepData
Expand IInterferenceIInterference
Expand IInterferenceDetectionMgrIInterferenceDetectionMgr
Expand IJogFeatureDataIJogFeatureData
Expand IJoinFeatureDataIJoinFeatureData
Expand ILayerILayer
Expand ILayerMgrILayerMgr
Expand ILibraryFeatureDataILibraryFeatureData
Expand ILightILight
Expand ILightDialogILightDialog
Expand ILinearPatternFeatureDataILinearPatternFeatureData
Expand ILocalCircularPatternFeatureDataILocalCircularPatternFeatureData
Expand ILocalLinearPatternFeatureDataILocalLinearPatternFeatureData
Expand ILoftedBendsFeatureDataILoftedBendsFeatureData
Expand ILoftFeatureDataILoftFeatureData
Expand ILoop2ILoop2
Expand IMacroFeatureDataIMacroFeatureData
Expand IManipulatorIManipulator
Expand IMassPropertyIMassProperty
Expand IMate2IMate2
Expand IMateEntity2IMateEntity2
Expand IMateInPlaceIMateInPlace
Expand IMateLoadReferenceIMateLoadReference
Expand IMateReferenceIMateReference
Expand IMaterialVisualPropertiesDataIMaterialVisualPropertiesData
Expand IMathPointIMathPoint
Expand IMathTransformIMathTransform
Expand IMathUtilityIMathUtility
Expand IMathVectorIMathVector
Expand IMeasureIMeasure
Expand IMidSurface3IMidSurface3
Expand IMirrorPatternFeatureDataIMirrorPatternFeatureData
Expand IMirrorSolidFeatureDataIMirrorSolidFeatureData
Expand IMiterFlangeFeatureDataIMiterFlangeFeatureData
Expand IModelDoc2IModelDoc2
Expand IModelDocExtensionIModelDocExtension
Expand IModelerIModeler
Expand IModelViewIModelView
Expand IModelViewManagerIModelViewManager
Expand IModelWindowIModelWindow
Expand IMouseIMouse
Expand IMoveCopyBodyFeatureDataIMoveCopyBodyFeatureData
Expand IMoveFaceFeatureDataIMoveFaceFeatureData
Expand IMultiJogLeaderIMultiJogLeader
Expand INoteINote
Expand IOneBendFeatureDataIOneBendFeatureData
Expand IPageSetupIPageSetup
Expand IParameterIParameter
Expand IPartDocIPartDoc
Expand IPartingLineFeatureDataIPartingLineFeatureData
Expand IPartingSurfaceFeatureDataIPartingSurfaceFeatureData
Expand IPrint3DDialogIPrint3DDialog
Expand IProjectionArrowIProjectionArrow
Expand IProjectionCurveFeatureDataIProjectionCurveFeatureData
Expand IPropertyManagerPage2IPropertyManagerPage2
Expand IPropertyManagerPageActiveXIPropertyManagerPageActiveX
Expand IPropertyManagerPageBitmapIPropertyManagerPageBitmap
Expand IPropertyManagerPageBitmapButtonIPropertyManagerPageBitmapButton
Expand IPropertyManagerPageButtonIPropertyManagerPageButton
Expand IPropertyManagerPageCheckboxIPropertyManagerPageCheckbox
Expand IPropertyManagerPageComboboxIPropertyManagerPageCombobox
Expand IPropertyManagerPageControlIPropertyManagerPageControl
Expand IPropertyManagerPageGroupIPropertyManagerPageGroup
Expand IPropertyManagerPageLabelIPropertyManagerPageLabel
Expand IPropertyManagerPageListboxIPropertyManagerPageListbox
Expand IPropertyManagerPageNumberboxIPropertyManagerPageNumberbox
Expand IPropertyManagerPageOptionIPropertyManagerPageOption
Expand IPropertyManagerPageSelectionboxIPropertyManagerPageSelectionbox
Expand IPropertyManagerPageSliderIPropertyManagerPageSlider
Expand IPropertyManagerPageTabIPropertyManagerPageTab
Expand IPropertyManagerPageTextboxIPropertyManagerPageTextbox
Expand IRefAxisIRefAxis
Expand IRefAxisFeatureDataIRefAxisFeatureData
Expand IReferenceCurveIReferenceCurve
Expand IReferencePointCurveFeatureDataIReferencePointCurveFeatureData
Expand IRefPlaneIRefPlane
Expand IRefPlaneFeatureDataIRefPlaneFeatureData
Expand IRefPointIRefPoint
Expand IRefPointFeatureDataIRefPointFeatureData
Expand IRenderMaterialIRenderMaterial
Expand IReplaceFaceFeatureDataIReplaceFaceFeatureData
Expand IRevisionTableAnnotationIRevisionTableAnnotation
Expand IRevisionTableFeatureIRevisionTableFeature
Expand IRevolveFeatureData2IRevolveFeatureData2
Expand IRibFeatureData2IRibFeatureData2
Expand IRipFeatureDataIRipFeatureData
Expand IRuledSurfaceFeatureDataIRuledSurfaceFeatureData
Expand ISaveBodyFeatureDataISaveBodyFeatureData
Expand IScaleFeatureDataIScaleFeatureData
Expand ISectionViewDataISectionViewData
Expand ISelectDataISelectData
Expand ISelectionMgrISelectionMgr
Expand ISensorISensor
Expand ISFSymbolISFSymbol
Expand ISheetISheet
Expand ISheetMetalFeatureDataISheetMetalFeatureData
Expand IShellFeatureDataIShellFeatureData
Expand IShutOffSurfaceFeatureDataIShutOffSurfaceFeatureData
Expand ISilhouetteEdgeISilhouetteEdge
Expand ISimpleFilletFeatureData2ISimpleFilletFeatureData2
Expand ISimpleHoleFeatureData2ISimpleHoleFeatureData2
Expand ISimulation3DContactFeatureDataISimulation3DContactFeatureData
Expand ISimulationDamperFeatureDataISimulationDamperFeatureData
Expand ISimulationForceFeatureDataISimulationForceFeatureData
Expand ISimulationGravityFeatureDataISimulationGravityFeatureData
Expand ISimulationMotorFeatureDataISimulationMotorFeatureData
Expand ISimulationSpringFeatureDataISimulationSpringFeatureData
Expand ISketchISketch
Expand ISketchArcISketchArc
Expand ISketchBlockDefinitionISketchBlockDefinition
Expand ISketchBlockInstanceISketchBlockInstance
Expand ISketchContourISketchContour
Expand ISketchedBendFeatureDataISketchedBendFeatureData
Expand ISketchEllipseISketchEllipse
Expand ISketchHatchISketchHatch
Expand ISketchLineISketchLine
Expand ISketchManagerISketchManager
Expand ISketchParabolaISketchParabola
Expand ISketchPathISketchPath
Expand ISketchPatternFeatureDataISketchPatternFeatureData
Expand ISketchPictureISketchPicture
Expand ISketchPointISketchPoint
Expand ISketchRegionISketchRegion
Expand ISketchRelationISketchRelation
Expand ISketchRelationManagerISketchRelationManager
Expand ISketchSegmentISketchSegment
Expand ISketchSlotISketchSlot
Expand ISketchSplineISketchSpline
Expand ISketchTextISketchText
Collapse ISldWorksISldWorks
Members
Expand ISplineHandleISplineHandle
Expand ISplitBodyFeatureDataISplitBodyFeatureData
Expand ISplitLineFeatureDataISplitLineFeatureData
Expand ISpringISpring
Expand IStatusBarPaneIStatusBarPane
Expand IStructuralMemberFeatureDataIStructuralMemberFeatureData
Expand IStructuralMemberGroupIStructuralMemberGroup
Expand ISurfaceISurface
Expand ISurfaceCutFeatureDataISurfaceCutFeatureData
Expand ISurfaceExtendFeatureDataISurfaceExtendFeatureData
Expand ISurfaceKnitFeatureDataISurfaceKnitFeatureData
Expand ISurfaceOffsetFeatureDataISurfaceOffsetFeatureData
Expand ISurfacePlanarFeatureDataISurfacePlanarFeatureData
Expand ISurfaceRadiateFeatureDataISurfaceRadiateFeatureData
Expand ISurfaceTrimFeatureDataISurfaceTrimFeatureData
Expand ISurfExtrudeFeatureDataISurfExtrudeFeatureData
Expand ISurfRevolveFeatureDataISurfRevolveFeatureData
Expand ISweepFeatureDataISweepFeatureData
Expand ISwOLEObjectISwOLEObject
Expand ISWPropertySheetISWPropertySheet
Expand ITableAnchorITableAnchor
Expand ITableAnnotationITableAnnotation
Expand ITablePatternFeatureDataITablePatternFeatureData
Expand ITaskpaneViewITaskpaneView
Expand ITessellationITessellation
Expand ITextFormatITextFormat
Expand ITextureITexture
Expand IThickenFeatureDataIThickenFeatureData
Expand ITitleBlockITitleBlock
Expand ITitleBlockTableAnnotationITitleBlockTableAnnotation
Expand ITitleBlockTableFeatureITitleBlockTableFeature
Expand IToolingSplitFeatureDataIToolingSplitFeatureData
Expand ITreeControlItemITreeControlItem
Expand ITriadManipulatorITriadManipulator
Expand IUserProgressBarIUserProgressBar
Expand IUserUnitIUserUnit
Expand IVariableFilletFeatureData2IVariableFilletFeatureData2
Expand IVertexIVertex
Expand IViewIView
Expand IWeldBeadIWeldBead
Expand IWeldmentBeadFeatureDataIWeldmentBeadFeatureData
Expand IWeldmentCutListAnnotationIWeldmentCutListAnnotation
Expand IWeldmentCutListFeatureIWeldmentCutListFeature
Expand IWeldmentTrimExtendFeatureDataIWeldmentTrimExtendFeatureData
Expand IWeldSymbolIWeldSymbol
Expand IWizardHoleFeatureData2IWizardHoleFeatureData2
Expand IWrapSketchFeatureDataIWrapSketchFeatureData
Expand SolidWorks.Interop.swmotionstudy NamespaceSolidWorks.Interop.swmotionstudy Namespace
Expand SolidWorks.Interop.swdimxpert NamespaceSolidWorks.Interop.swdimxpert Namespace
Expand SolidWorks.Interop.swpublished NamespaceSolidWorks.Interop.swpublished Namespace
Expand SolidWorks.Interop.sw3dprinter NamespaceSolidWorks.Interop.sw3dprinter Namespace
Expand SolidWorks.Interop.dsgnchk NamespaceSolidWorks.Interop.dsgnchk Namespace
Expand SolidWorks.Interop.swhtmlcontrol NamespaceSolidWorks.Interop.swhtmlcontrol Namespace
Expand SolidWorks.Interop.swconst NamespaceSolidWorks.Interop.swconst Namespace
Expand SolidWorks.Interop.swcommands NamespaceSolidWorks.Interop.swcommands Namespace
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SolidWorks Document Manager API HelpSolidWorks Document Manager API Help
Expand eDrawings API HelpeDrawings API Help
Expand SolidWorks Routing API HelpSolidWorks Routing API Help
Expand SolidWorks Simulation API HelpSolidWorks Simulation API Help
Expand SolidWorks Utilities API HelpSolidWorks Utilities API Help
Expand SolidWorks Workgroup PDM API HelpSolidWorks Workgroup PDM API Help
Expand PhotoWorks API HelpPhotoWorks API Help
Expand SolidWorks Toolbox Browser API HelpSolidWorks Toolbox Browser API Help
Hide Table of Contents
ISldWorks Interface Members

The following tables list the members exposed by ISldWorks.

Public Properties

 NameDescription
 PropertyActiveDocGets the currently active document.  
 PropertyActivePrinterObsolete. Superseded by IModelDoc2::Printer.  
 PropertyCommandInProgressImproves performance of out-of-process applications by informing SolidWorks that a sequence of API calls will be made by the out-of-process application.  
 PropertyEnableBackgroundProcessingGets or sets whether to enable background processing.  
 PropertyEnableFileMenuGets or sets whether to enable file-related menus and toolbars.  
 PropertyFrameHeightGet or sets the height of the SolidWorks window.  
 PropertyFrameLeftGets or sets the left position of the SolidWorks window.  
 PropertyFrameStateGets or sets the window state (minimum, maximum, or normal) for the SolidWorks window.  
 PropertyFrameTopGets or sets the top position of the SolidWorks window.  
 PropertyFrameWidthGets or sets the width of the frame of the SolidWorks window.  
 PropertyIActiveDocObsolete. Superseded by ISldWorks::IActiveDoc2.  
 PropertyIActiveDoc2Gets the currently active document.  
 PropertyTaskPaneIsPinnedGets or sets whether the SolidWorks Task Pane is pinned.  
 PropertyUserControlGets and sets whether to run SolidWorks in the foreground and be visible.  
 PropertyUserControlBackgroundGets and sets whether to run SolidWorks in the background and not be visible.  
 PropertyUserTypeLibReferencesGets and sets the user-specified type library references.  
 PropertyVisibleGets and sets the visibility property of the SolidWorks application.  
Top

Public Methods

 NameDescription
 MethodActivateDocObsolete. Superseded by ISldWorks::ActivateDoc2 and ISldWorks::IActivateDoc3.  
 MethodActivateDoc2Activates a document that has already been loaded.  
 MethodActivateTaskPaneActivates the specified task pane.  
 MethodAddCallbackRegisters a general purpose callback handler.  
 MethodAddFileOpenItemObsolete. Superseded by ISldWorks::AddFileOpenItem3.  
 MethodAddFileOpenItem2Obsolete. Superseded by ISldWorks::AddFileOpenItem3.  
 MethodAddFileOpenItem3Adds file types to the SolidWorks File Open dialog box.  
 MethodAddFileSaveAsItemObsolete. Superseded by ISldWorks::AddFileSaveAsItem2.  
 MethodAddFileSaveAsItem2Adds a file type to the SolidWorks Save As dialog box.  
 MethodAddItemToThirdPartyPopupMenuAdds a menu item and icon to a third-party popup (shortcut) menu.  
 MethodAddMenuAdds a menu or sub-menu item to the SolidWorks interface for DLL applications.  
 MethodAddMenuItemObsolete. Superseded by ISldWorks::AddMenuItem3.  
 MethodAddMenuItem2Obsolete. Superseded by ISldWorks::AddMenuItem3.  
 MethodAddMenuItem3Obsolete. Superseded by ISldWorks::AddMenuItem4.  
 MethodAddMenuItem4Adds a menu item and bitmap to the SolidWorks interface.  
 MethodAddMenuPopupItemObsolete. Superseded by ISldWorks::AddMenuPopupItem2.  
 MethodAddMenuPopupItem2Obsolete. Superseded by ISldWorks::AddMenuPopupItem3.  
 MethodAddMenuPopupItem3Adds a menu item, or submenu and menu item, to a shortcut menu.  
 MethodAddToolbarObsolete. Superseded by ISldWorks::AddToolbar4.  
 MethodAddToolbar2Obsolete. Superseded by ISldWorks::AddToolbar4.  
 MethodAddToolbar3Obsolete. Superseded by ISldWorks::AddToolbar4.  
 MethodAddToolbar4
Creates a Windows-style, dockable toolbar that contains a set of application-defined buttons.  
 MethodAddToolbarCommandObsolete. Superseded by ISldWorks::AddToolbarCommand2.  
 MethodAddToolbarCommand2Specifies the application functions called by a toolbar button or sets a button to be a separator.  
 MethodAllowFailedFeatureCreationSets whether to allow the creation of a feature that has rebuild errors.  
 MethodArrangeIconsArranges the icons in SolidWorks.  
 MethodArrangeWindowsArranges the open windows in SolidWorks.  
 MethodBlockSkinningBlocks skinning a window, which prevents a window from looking like a SolidWorks window.  
 MethodCallBackAllows an out-of-process executable or SolidWorks macro to call back a function in a SolidWorks add-in DLL.  
 MethodCheckpointConvertedDocumentSaves the specified open document if its version is older than the version of the SolidWorks product being used.  
 MethodCloseAllDocumentsCloses all open documents in the SolidWorks session.  
 MethodCloseDocCloses the specified document.  
 MethodCommandOpens the specified dialog or file.  
 MethodCopyDocumentCopies a document and optionally updates references to it.  
 MethodCreateNewWindowCreates a client window containing the active document.  
 MethodCreatePropertyManagerPageCreates a PropertyManager page.  
 MethodCreateTaskpaneViewObsolete. Superseded by ISldworks::CreateTaskpaneView2.  
 MethodCreateTaskpaneView2Creates an application-level Task Pane view.  
 MethodDateCodeObsolete. Superseded by ISldWorks::RevisionNumber.  
 MethodDefineAttributeCreates an attribute definition, which is the first step in generating attributes.  
 MethodDisplayStatusBarSets whether to display the status bar.  
 MethodDocumentVisibleAllows the application to control the display of a document in a window upon creation or retrieval.  
 MethodDragToolbarButtonCopies the specified toolbar button from the specified native SolidWorks toolbar or ICommandGroup toolbar to the specified native SolidWorks toolbar or ICommandGroup toolbar.  
 MethodDragToolbarButtonFromCommandIDCopies a button to a toolbar using a command ID.  
 MethodEnablePhotoWorksProgressiveRenderEnables or disables PhotoWorks progressive rendering.  
 MethodEnableStereoDisplaySets or clears an application attribute that controls whether:
  • subsequently created windows are capable of displaying stereoscopically.

  • stereo-capable windows are currently display stereoscopically.

 
 MethodEnumDocumentsObsolete. Superseded by ISldWorks::EnumDocuments2.  
 MethodEnumDocuments2Gets a list of documents currently open in the application.  
 MethodExitAppShuts down SolidWorks.  
 MethodFrameGets the SolidWorks main frame.  
 MethodGetActiveConfigurationNameGets the name of the active configuration in the specified SolidWorks document.  
 MethodGetAddInObjectGets an object from an add-in DLL.  
 MethodGetApplySelectionFilterGets the current state of the selection filter.  
 MethodGetBuildNumbersGets the major build and major revision numbers of the SolidWorks application.  
 MethodGetButtonPositionGets the center coordinates of the specified SolidWorks toolbar button.  
 MethodGetColorTableGets a color table from the SolidWorks application.  
 MethodGetCommandIDGets the SolidWorks command ID for an instance of an add-in's control (e.g., an add-in's toolbar button).  
 MethodGetCommandManagerGets the CommandManager for the specified add-in.  
 MethodGetConfigurationCountGets the number of configurations in the SolidWorks document, whether the document is opened or closed.  
 MethodGetConfigurationNamesGets the names of the configuration in this SolidWorks document, whether the document is opened or closed.  
 MethodGetCurrentFileUserGets the name of the user who has the the specified document open.  
 MethodGetCurrentLanguageGets the current language used by SolidWorks.  
 MethodGetCurrentMacroPathFolderGets the name of the folder where the macro resides.  
 MethodGetCurrentMacroPathNameGets the path name for the macro currently running.  
 MethodGetCurrentWorkingDirectoryGets the current working directory being used by the SolidWorks application.  
 MethodGetDataFolderGets the data directory name currently used by SolidWorks.  
 MethodGetDocumentCountGets the number of open documents in the current SolidWorks session.  
 MethodGetDocumentDependenciesObsolete. Superseded by ISldWorks::GetDocumentDependencies2.  
 MethodGetDocumentDependencies2Gets all of the model dependencies for a document.  
 MethodGetDocumentDependenciesCountObsolete. Superseded by ISldWorks::IGetDocumentDependenciesCount2.  
 MethodGetDocumentsGets the open documents is this SolidWorks session.  
 MethodGetDocumentTemplateGets the name of document template that can be used in ISldWorks::NewDocument or ISldWorks::INewDocument2.  
 MethodGetDocumentVisibleGets the visibility of the document to open.  
 MethodGetEnvironmentGets the IEnvironment object.  
 MethodGetErrorMessagesGets the last 20 messages issued by SolidWorks in the current SolidWorks session.  
 MethodGetExecutablePathGets the path to the SolidWorks executable, sldworks.exe.  
 MethodGetExportFileDataGets the data interface for the specified file type to which to export one or more drawing sheets.  
 MethodGetFirstDocumentGets the document opened first in this SolidWorks session.  
 MethodGetImportFileDataGets the IGES or DXF/DWG import data for the specified file.  
 MethodGetLastSaveErrorGets the last save error issued by Microsoft in the current session.  
 MethodGetLastToolbarIDGets the ID of the last toolbar added to the CommandManager.  
 MethodGetLatestSupportedFileVersionGets the version number that this instance of SolidWorks reads and writes.  
 MethodGetLocalizedMenuNameGets a localized menu name for the specified menu ID.  
 MethodGetMacroMethodsGets the names of the modules in the specified macro.  
 MethodGetMassPropertiesObsolete. Superseded by ISldWorks::GetMassProperties2 and ISldWorks::IGetMassProperties2.  
 MethodGetMassProperties2Gets the mass properties from the specified document for the specified configuration.  
 MethodGetMaterialDatabaseCountGets the number of material databases.  
 MethodGetMaterialDatabasesGets the names of the material databases.  
 MethodGetMaterialSchemaPathNameGets the path for the XML material schema file.  
 MethodGetMathUtilityGets the IMathUtility interface.  
 MethodGetMenuStringsGets the name of the parent menu of the specified menu command.  
 MethodGetModelerGets the IModeler interface.  
 MethodGetMouseDragModeGets whether the specified command-mouse mode is in effect.  
 MethodGetOpenDocSpecGets the specifications to use when opening a model document.  
 MethodGetOpenDocumentGets the open document with the specified name.  
 MethodGetOpenDocumentByNameGets the open document with the specified name.  
 MethodGetOpenedFileInfoGets the name of the last-requested file to open and the options in effect while the file is opening or when the file finished opening.  
 MethodGetOpenFileNamePrompts the user for the name of the file to open.  
 MethodGetPreviewBitmapGets the preview bitmap (.bmp) for the specified configuration, regardless if the SolidWorks document is open or closed.  
 MethodGetPreviewBitmapFileGets the specified preview bitmap of a document and saves it as a Windows bitmap file (.bmp) using the specified filename.  
 MethodGetProcessIDGets the process ID for the current SolidWorks session.  
 MethodGetRecentFilesGets a list of the most recently used files.  
 MethodGetSearchFoldersGets the current folder search settings as shown in Tools , Options, System Options, External References.  
 MethodGetSelectionFilterGets the current selection filter settings for the specified item type.  
 MethodGetSelectionFiltersGets all active selection filters.  
 MethodGetTemplateSizesGets the sheet properties from a template document.  
 MethodGetToolbarDockObsolete. Superseded by ISldWorks::GetToolbarDock2.  
 MethodGetToolbarDock2Gets the docking state of the toolbar.  
 MethodGetToolbarStateObsolete. Superseded by ISldWorks::GetToolbarState2.  
 MethodGetToolbarState2Gets the state of the toolbar.  
 MethodGetToolbarVisibilityGets whether this toolbar is visible.  
 MethodGetUserPreferenceDoubleValueGets system default user preference values.  
 MethodGetUserPreferenceIntegerValueGets system default user preference values.  
 MethodGetUserPreferenceStringListValueGets the name of the DXF mapping file.  
 MethodGetUserPreferenceStringValueGets system default user preference values.  
 MethodGetUserPreferenceToggleGets document default user preference values.  
 MethodGetUserProgressBarGets the user progress bar.  
 MethodGetUserTypeLibReferenceCountGets the number of user-specified type library references.  
 MethodGetUserUnitGets the standalone user units.  
 MethodHideBubbleTooltipHides the bubble ToolTip displayed by ISldWorks::ShowBubbleTooltipAt2.  
 MethodHideToolbarObsolete. Superseded by ISldWorks::HideToolbar2.  
 MethodHideToolbar2Hides a toolbar created with ISldWorks::AddToolbar4.  
 MethodIActivateDocObsolete. Superseded by ISldWorks::ActivateDoc2 and ISldWorks::IActivateDoc3.  
 MethodIActivateDoc2Obsolete. Superseded by ISldWorks::ActivateDoc2 and ISldWorks::IActivateDoc3.  
 MethodIActivateDoc3Activates a document that has already been loaded. This file becomes the active document, and this method returns a pointer to that document object.  
 MethodICopyDocumentCopies a document and optionally updates references to it.  
 MethodICreatePropertyManagerPageCreates a PropertyManager page.  
 MethodIDefineAttributeCreates an attribute definition, which is the first step in generating attributes.  
 MethodIEnableStereoDisplaySets or clears an application attribute that controls whether:
  • subsequently created windows are capable of displaying stereoscopically.

  • stereo-capable windows are currently display stereoscopically.

 
 MethodIGetColorTableGets a color table from the SolidWorks application.  
 MethodIGetConfigurationNamesGets the names of the configuration in this SolidWorks document, whether the document is opened or closed.  
 MethodIGetDocumentDependenciesObsolete. Superseded by ISldWorks::IGetDocumentDependencies2.  
 MethodIGetDocumentDependencies2Gets all of the model dependencies for a document.  
 MethodIGetDocumentDependenciesCount2Gets the size of the array needed for a call to ISldWorks::IGetDocumetnDependencies2.  
 MethodIGetDocumentsGets the open documents is this SolidWorks session.  
 MethodIGetEnvironmentGets the IEnvironment object.  
 MethodIGetFirstDocumentObsolete. Superseded by ISldWorks::IGetFirstDocument2.  
 MethodIGetFirstDocument2Gets the document opened first in this SolidWorks session.  
 MethodIGetMassPropertiesObsolete. Superseded by ISldWorks::GetMassProperties2 and ISldWorks::IGetMassProperties2.  
 MethodIGetMassProperties2Gets the mass properties from the specified document for the specified configuration.  
 MethodIGetMaterialDatabasesGets the names of the material databases.  
 MethodIGetMathUtilityGets the IMathUtility interface.  
 MethodIGetModelerGets the IModeler interface.  
 MethodIGetOpenDocumentByNameObsolete. Superseded ISldWorks::IGetOpenDocumentByName2.  
 MethodIGetOpenDocumentByName2Gets the open document with the specified name.  
 MethodIGetSelectionFiltersGets all active selection filters.  
 MethodIGetSelectionFiltersCountGets the number of active selection filters.  
 MethodIGetTemplateSizesGets the sheet properties from a template document.  
 MethodIGetUserTypeLibReferencesGets the specified user-specified type library references.  
 MethodIGetUserUnitGets the standalone user units.  
 MethodIGetVersionHistoryCountGets the size of the array required to hold data returned by ISldWorks::IVersionHistory.  
 MethodIMoveDocumentMoves a document and optionally updates references to it.  
 MethodINewAssemblyObsolete. Superseded by ISldWorks::NewDocument and ISldWorks::INewDocument2.  
 MethodINewDocumentObsolete. Superseded by ISldWorks::INewDocument2.   
 MethodINewDocument2Creates a new document based on the specified template.  
 MethodINewDrawingObsolete. Superseded by ISldWorks::NewDocument and ISldWorks::INewDocument2.  
 MethodINewDrawing2Obsolete. Superseded by ISldWorks::NewDocument and ISldWorks::INewDocument2.  
 MethodINewPartObsolete. Superseded by ISldWorks::NewDocument and ISldWorks::INewDocument2.  
 MethodInstallQuickTipGuideImplements your add-in's copy of the Quick Tips.  
 MethodIOpenDocObsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodIOpenDoc2Obsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodIOpenDoc3Obsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodIOpenDoc4Obsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodIOpenDoc5Obsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodIOpenDocSilentObsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodIRemoveUserTypeLibReferencesRemoves the user-specified type library references.  
 MethodIsBackgroundProcessingCompletedGets whether SolidWorks has finished opening a document, which requires a lot of CPU time and no user input, in a background process.  
 MethodIsCommandEnabledGets whether the specified command is enabled.  
 MethodISetSelectionFiltersSets the status for multiple selection filters.  
 MethodISetUserTypeLibReferencesSets the user-specified type library references.  
 MethodIsRapidDraftGets whether the specified drawing file is in SolidWorks RapidDraft format.  
 MethodIsSameGets whether the two specified objects are the same object.  
 MethodIVersionHistoryGets a list of strings indicating the versions in which a model was saved.  
 MethodLoadAddInLoads the specified add-in in SolidWorks.  
 MethodLoadFileObsolete. Superseded by ISldWorks::LoadFile4.  
 MethodLoadFile2Obsolete. Superseded by ISldWorks::LoadFile4.  
 MethodLoadFile3Obsolete. Superseded by ISldWorks::LoadFile4.  
 MethodLoadFile4Loads a non-native SolidWorks file (for example, *.igs, *.dxf, and so on).  
 MethodMoveDocumentMoves a document and optionally updates references to it.  
 MethodNewAssemblyObsolete. Superseded by ISldWorks::NewDocument and ISldWorks::INewDocument2.  
 MethodNewDocumentCreates a new document based on the specified template.  
 MethodNewDrawingObsolete. Superseded by ISldWorks::NewDocument and ISldWorks::INewDocument2.  
 MethodNewDrawing2Obsolete. Superseded by ISldWorks::NewDocument and ISldWorks::INewDocument2.  
 MethodNewPartObsolete. Superseded by ISldWorks::NewDocument and ISldWorks::INewDocument2.  
 MethodOpenDocObsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodOpenDoc2Obsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodOpenDoc3Obsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodOpenDoc4Obsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodOpenDoc6Opens an existing document and returns a pointer to the document object.  
 MethodOpenDoc7Opens an existing document and returns a pointer to the document object.  
 MethodOpenDocSilentObsolete. Superseded by ISldWorks::OpenDoc6.  
 MethodPostMessageToApplicationPosts a message to the application that invoked this method.  
 MethodPreSelectDwgTemplateSizeEstablishes which template to use when creating a drawing.  
 MethodPresetNewDrawingParametersPresets the drawing template and sheet size parameters to avoid showing the Sheet Format/Size dialog when creating a new drawing document in the user-interface.  
 MethodPreviewDocDisplays a preview of a document to the specified window.  
 MethodPreviewDocx64Displays a preview of a document to the specified window in 64-bit applications.  
 MethodQuitDocCloses the specified document without saving changes.  
 MethodRecordLineAdds a line to the journal and macro recording files.  
 MethodRefreshQuickTipWindowTells the SolidWorks application that your add-in's state has changed and triggers a query for the current URL page.  
 MethodRefreshTaskpaneContentRefreshes the view of the Design Library tab in the Task Pane.  
 MethodRegisterThirdPartyPopupMenuRegisters a third-party popup (shortcut) menu.  
 MethodRegisterTrackingDefinitionRegisters a tracking definition.  
 MethodRemoveCallbackUnregisters a general purpose callback handler.  
 MethodRemoveFileOpenItemObsolete. Superseded by ISldWorks::RemoveFileOpenItem2.  
 MethodRemoveFileOpenItem2Removes a file type from the SolidWorks File Open dialog box added using ISldWorks::AddFileOpenItem3.  
 MethodRemoveFileSaveAsItemObsolete. Superseded by ISldWorks::RemoveFileSaveAsItem2.  
 MethodRemoveFileSaveAsItem2Removes a file type from the Save As list added using ISldWorks::AddFileSaveAsItem2.  
 MethodRemoveFromMenuRemoves:
  • the specified command from all main frame menus or a toolbar or both

  • the specified command's parent menus

 
 MethodRemoveFromPopupMenuRemoves the specified menu item from one or all specified context-sensitive menus (also called shortcut menus and pop-up menus) for the specified document types.  
 MethodRemoveItemFromThirdPartyPopupMenuRemoves a menu item and icon from a third-party popup (shortcut) menu.  
 MethodRemoveMenuRemoves a pull-down menu item or an pull-down menu from the specified document frame.  
 MethodRemoveMenuPopupItemObsolete. Superseded by ISldWorks::RemoveMenuPopupItem2.  
 MethodRemoveMenuPopupItem2Removes an item on a pop-up (shortcut) menu.  
 MethodRemoveToolbarObsolete. Superseded by ISldWorks::RemoveToobar2.  
 MethodRemoveToolbar2Removes a toolbar created with ISldWorks::AddToolbar4.  
 MethodRemoveUserMenuObsolete. Superseded by ISldWorks::RemoveMenu.  
 MethodRemoveUserTypeLibReferencesRemoves the user-specified type library references.  
 MethodReplaceReferencedDocumentReplaces a referenced document.  
 MethodResetPresetDrawingParametersResets SolidWorks back to its default behavior after calling ISldWorks::PresetNewDrawingParameters (i.e., display Sheet Format/Size dialog when opening a new drawing document).  
 MethodResetUntitledCountResets the index of untitled documents.  
 MethodResumeSkinningResumes skinning windows.  
 MethodRevisionNumberGets the version number of the SolidWorks executable.  
 MethodRunAttachedMacroRuns the specified attached macro, module, and procedure.  
 MethodRunCommandRuns the specified SolidWorks command.  
 MethodRunJournalCmd  
 MethodRunMacroObsolete. Superseded by ISldWorks::RunMacro2.  
 MethodRunMacro2Runs a macro from a project file.  
 MethodSendMsgToUserObsolete. Superseded by ISldWorks::SendMsgToUser2.  
 MethodSendMsgToUser2Displays a message box containing a message to the user, who is required to interact with it before continuing.  
 MethodSetAddinCallbackInfoSets add-in callback commands.  
 MethodSetApplySelectionFilterSets the current state of the selection filter.  
 MethodSetCurrentWorkingDirectorySets the current working directory to be used by SolidWorks.  
 MethodSetMissingReferencePathNameSets the missing reference file name. Use with the SolidWorks event ReferenceNotFoundNotify.  
 MethodSetMouseDragModeSets the command-mouse mode.  
 MethodSetMultipleFilenamesPromptSets the new filenames to open in response to the ISldWorks PromptForMultipleFileNamesNotify event.  
 MethodSetNewFilenameSets the name of the new SolidWorks file.  
 MethodSetPromptFilenameSets the new file to open in response to the SolidWorks events PromptForFileNameNotify or ReferencedFilePreNotify.  
 MethodSetSearchFoldersSets the folder search settings as shown in Tools, Options, System Options, External References.  
 MethodSetSelectionFilterSets the current selection filter values for the specified item type.  
 MethodSetSelectionFiltersSets the status for multiple selection filters.  
 MethodSetThirdPartyPopupMenuStateSets whether to show or hide a third-party popup (shortcut) menu.  
 MethodSetToolbarDockObsolete. Superseded by ISldWorks::SetToolbarDock2.  
 MethodSetToolbarDock2Sets the docking state of the toolbar.  
 MethodSetToolbarVisibilitySets whether the specified toolbar is visible.  
 MethodSetUserPreferenceDoubleValueSets system default user preference values.  
 MethodSetUserPreferenceIntegerValueSets system default user preference values.  
 MethodSetUserPreferenceStringListValueSets the name of the DXF mapping files.  
 MethodSetUserPreferenceStringValueSets system default user preference values.  
 MethodSetUserPreferenceToggleSets system default user preference values.  
 MethodShowBubbleTooltipDisplays a bubble ToolTip and flashes the specified toolbar button.  
 MethodShowBubbleTooltipAtObsolete. Superseded by ISldWorks::ShowBubbleTooltipAt2.  
 MethodShowBubbleTooltipAt2Displays a bubble ToolTip at the specified location.  
 MethodShowHelpDisplays the specified Help topic.  
 MethodShowThirdPartyPopupMenuSets where to show a third-party popup (shortcut) menu.  
 MethodShowToolbarObsolete. Superseded by ISldWorks::ShowToolbar2.  
 MethodShowToolbar2Obsolete. Not superseded.  
 MethodSolidWorksExplorerStarts SolidWorks Explorer.  
 MethodUnInstallQuickTipGuideUninstalls your add-in's Quick Tips  
 MethodUnloadAddInUnloads the specified add-in from SolidWorks.  
 MethodVersionHistoryGets a list of strings indicating the versions in which a model was saved.  
Top

See Also



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:   ISldWorks Interface Members
*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) 2010 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.