Expand Getting StartedGetting Started
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Collapse DraftSight API HelpDraftSight API Help
Getting Started
Release Notes
Access Diagram
Collapse Interop.dsAutomation NamespaceInterop.dsAutomation Namespace
Collapse InterfacesInterfaces
Expand IAlignedDimensionIAlignedDimension
Expand IAngularDimensionIAngularDimension
Collapse IApplicationIApplication
Expand IApplicationOptionsIApplicationOptions
Expand IArcAlignedTextIArcAlignedText
Expand IArcLengthDimensionIArcLengthDimension
Expand IAttributeDefinitionIAttributeDefinition
Expand IAttributeInstanceIAttributeInstance
Expand IBlockDefinitionIBlockDefinition
Expand IBlockInstanceIBlockInstance
Expand ICircleICircle
Expand ICircleArcICircleArc
Expand IColorIColor
Expand IColorPickerIColorPicker
Expand ICommandICommand
Expand ICommandMessageICommandMessage
Expand IContextMenuItemIContextMenuItem
Expand ICurvedSettingsICurvedSettings
Expand ICustomCoordinateSystemICustomCoordinateSystem
Expand ICustomCoordinateSystemManagerICustomCoordinateSystemManager
Expand ICustomDataICustomData
Expand ICustomPropertyControlICustomPropertyControl
Expand IDiameterDimensionIDiameterDimension
Expand IDictionaryIDictionary
Expand IDimensionStyleIDimensionStyle
Expand IDimensionStyleAngularDimensionOptionsIDimensionStyleAngularDimensionOptions
Expand IDimensionStyleArrowsOptionsIDimensionStyleArrowsOptions
Expand IDimensionStyleDualDimensionOptionsIDimensionStyleDualDimensionOptions
Expand IDimensionStyleFitOptionsIDimensionStyleFitOptions
Expand IDimensionStyleLinearDimensionOptionsIDimensionStyleLinearDimensionOptions
Expand IDimensionStyleLineOptionsIDimensionStyleLineOptions
Expand IDimensionStyleManagerIDimensionStyleManager
Expand IDimensionStyleRadialDiameterDimensionOptionsIDimensionStyleRadialDiameterDimensionOptions
Expand IDimensionStyleTextOptionsIDimensionStyleTextOptions
Expand IDimensionStyleToleranceOptionsIDimensionStyleToleranceOptions
Expand IDimensionStyleUserDataIDimensionStyleUserData
Expand IDocumentIDocument
Expand IDocumentExporterIDocumentExporter
Expand IDrawingPropertiesIDrawingProperties
Expand IDrawingSupportFilesIDrawingSupportFiles
Expand IDSWindowIDSWindow
Expand IEllipseArcIEllipseArc
Expand IEmbeddedObjectIEmbeddedObject
Expand IEntityHelperIEntityHelper
Expand IExportSettingsIExportSettings
Expand IExternalReferenceIExternalReference
Expand IFaceIFace
Expand IGeneralDimensionIGeneralDimension
Expand IGradientBackgroundIGradientBackground
Expand IGroupIGroup
Expand IHatchIHatch
Expand IHatchBoundaryLoopIHatchBoundaryLoop
Expand IHatchPatternIHatchPattern
Expand IHighlightSetIHighlightSet
Expand IHyperLinkIHyperLink
Expand IImageBackgroundIImageBackground
Expand IInfiniteLineIInfiniteLine
Expand IInterfaceFilesIInterfaceFiles
Expand IJoggedDimensionIJoggedDimension
Expand ILayerILayer
Expand ILayerManagerILayerManager
Expand ILayerPropertiesILayerProperties
Expand ILayerStateILayerState
Expand ILayerStateManagerILayerStateManager
Expand ILeaderILeader
Expand ILineILine
Expand ILineStyleILineStyle
Expand ILineStyleManagerILineStyleManager
Expand ILispFunctionILispFunction
Expand ILispParameterILispParameter
Expand IMacroManagerIMacroManager
Expand IMathCircArcIMathCircArc
Expand IMathEllipArcIMathEllipArc
Expand IMathLineIMathLine
Expand IMathPlaneIMathPlane
Expand IMathPointIMathPoint
Expand IMathTransformIMathTransform
Expand IMathUtilityIMathUtility
Expand IMathVectorIMathVector
Expand IMenuItemIMenuItem
Expand IModelIModel
Expand IModelNamedViewIModelNamedView
Expand INamedViewINamedView
Expand INoteINote
Expand IOrdinateDimensionIOrdinateDimension
Expand IPointIPoint
Expand IPolyFaceMeshIPolyFaceMesh
Expand IPolygonMeshIPolygonMesh
Expand IPolyLineIPolyLine
Expand IPolyLine3DIPolyLine3D
Expand IPrintManagerIPrintManager
Expand IPrintSpecificationIPrintSpecification
Expand IRadialDimensionIRadialDimension
Expand IRayIRay
Expand IReferenceImageIReferenceImage
Expand IRegionIRegion
Expand IRibbonCommandButtonIRibbonCommandButton
Expand IRibbonPanelIRibbonPanel
Expand IRibbonQuickAccessBarIRibbonQuickAccessBar
Expand IRibbonQuickAccessBarItemIRibbonQuickAccessBarItem
Expand IRibbonRowIRibbonRow
Expand IRibbonRowItemIRibbonRowItem
Expand IRibbonRowPanelIRibbonRowPanel
Expand IRibbonSeparatorIRibbonSeparator
Expand IRibbonSplitButtonIRibbonSplitButton
Expand IRibbonSystemMenuIRibbonSystemMenu
Expand IRibbonSystemMenuItemIRibbonSystemMenuItem
Expand IRibbonTabIRibbonTab
Expand IRichLineIRichLine
Expand IRichLineStyleIRichLineStyle
Expand IRichLineStyleManagerIRichLineStyleManager
Expand IRotatedDimensionIRotatedDimension
Expand ISelectionFilterISelectionFilter
Expand ISelectionManagerISelectionManager
Expand IShapeIShape
Expand IShapeManagerIShapeManager
Expand ISheetISheet
Expand ISheetNamedViewISheetNamedView
Expand ISimpleNoteISimpleNote
Expand ISketchManagerISketchManager
Expand ISolidISolid
Expand ISolidBackgroundISolidBackground
Expand ISplineISpline
Expand ISystemFilesISystemFiles
Expand ITableITable
Expand ITableStyleITableStyle
Expand ITableStyleManagerITableStyleManager
Expand ITextStyleITextStyle
Expand ITextStyleManagerITextStyleManager
Expand IToleranceITolerance
Expand IToolbarIToolbar
Expand IToolbarItemIToolbarItem
Expand ITraceITrace
Expand ITrackerITracker
Expand ITransparencyITransparency
Expand IUnknownEntityIUnknownEntity
Expand IUserCommandIUserCommand
Expand IViewManagerIViewManager
Expand IViewportIViewport
Expand IViewTileIViewTile
Expand IWorkspaceIWorkspace
Expand IXRecordIXRecord
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Hide Table of Contents
IApplication Interface Members

The following tables list the members exposed by IApplication.

Public Properties

 PropertyTemporaryEntityModeGets or sets temporary entity mode on or off.  
 PropertyVisibleGets or sets whether to show the DraftSight application.  
 PropertyWindowStateGets or sets the state of the DraftSight application window.  

Public Methods

 MethodAbortRunningCommandAborts the command that is executing.  
 MethodAddCommandContextMenuAdds a menu item to the specified command's context-sensitive menu.  
 MethodAddDefaultContextMenuAdds a menu item to the DraftSight default context-sensitive menu.  
 MethodAddMenuObsolete. Superseded by IWorkspace::AddMenu.  
 MethodAddObjectContextMenuAdds a menu item to the specified object type's context-sensitive menu.  
 MethodAddToolbarObsolete. Superseded by IWorkspace::AddToolbar.  
 MethodAddWorkspaceAdds the specified workspace to the list of DraftSight user-interface workspaces.  
 MethodCloseDocumentCloses the specified document.  
 MethodCreateColorPickerGets access to the DraftSight color picker, which allows users to assign standard and custom LineColors directly to entities, by Layer, or by Block.  
 MethodCreateCommandObsolete. Superseded by IApplication::CreateCommand2.  
 MethodCreateCommand2Obsolete. Superseded by IApplication::CreateCommand3 and IApplication::CreateCommand4.  
 MethodCreateCommand3Creates the specified command for the command window with support for the specified context-sensitive (F1) help.  
 MethodCreateCommand4Creates the specified command for the command window with support for the specified context-sensitive (F1) help.  
 MethodCreateCustomPropertyControlObsolete. Superseded by IApplication::CreateCustomPropertyControl2.  
 MethodCreateCustomPropertyControl2Creates a custom tab.  
 MethodCreateLineStyleCreates a simple LineStyle.  
 MethodCreateTrackerCreates a tracker, the mechanism that draws temporary entities along the cursor's path when prompting a user for a value, keyword, or selection.  
 MethodCreateUserCommandCreates a command for a menu item and toolbar.  
 MethodExitApplicationExits DraftSight.  
 MethodGetActiveDocumentGets the active document.  
 MethodGetActiveWorkspaceGets the active workspace for the DraftSight user interface.  
 MethodGetApplicationOptionsGets access to DraftSight application options.  
 MethodGetColorByIndexGets the LineColor using the specified index within the Standard Colors.  
 MethodGetCommandMessageGets the message in the command window.  
 MethodGetContextMenuItemsGets the top-level context-sensitive menu items added by IApplication::AddCommandContextMenu, IApplication::AddDefaultContextMenu, and IApplication::AddObjectContextMenu.  
 MethodGetDocumentsGets the open documents.  
 MethodGetDrawingSupportFilesGets access to the DraftSight options that get and set default paths and file names for these drawing-support files: alternate font, drawing, drawing template, external references, font mapping, library, LineStyle, and RichLineStyle.  
 MethodGetEntityHelperGets the IEntityHelper interface.  
 MethodGetHWNDGets the DraftSight application window handle.  
 MethodGetInterfaceFilesGets access to the DraftSight options that get and set default paths for these user-interface files: alias, custom icon, main customization, and custom menu.  
 MethodGetLanguageGets the name of the language supported by this DraftSight installation.  
 MethodGetLineStyleListFromFileGets the names of the simple LineStyles and their descriptions contained in the specified LineStyle file.  
 MethodGetMacroManagerGets the macro manager, which manages macro recording and which is available in DraftSight Premium only.  
 MethodGetMainWindowGets the DraftSight application window.  
 MethodGetMathUtilityGets the IMathUtility interface.  
 MethodGetMenuItemsObsolete. Superseded by IWorkspace::GetMenuItems.  
 MethodGetMessageFolderGets the path of DraftSight's messages folder.  
 MethodGetNamedColorGets the named LineColor.  
 MethodGetObjectTypeGets the type of specified object.  
 MethodGetPreviewBitmapGets the preview bitmap of the specified document.  
 MethodGetPreviewBitmapBytesGets a byte array of the preview bitmap for the specified document.  
 MethodGetPreviewBitmapFileGets the preview bitmap of the specified document and saves it as a Windows bitmap file (.bmp) using the specified file name.  
 MethodGetPreviewOfEntitiesCreates a preview bitmap of the specified entities and returns a byte array of the bitmap.  
 MethodGetPrintManagerGets the interface for printing.  
 MethodGetRecentFilesGets the paths and file names of the files most recently opened in DraftSight.  
 MethodGetRGBColorGets the LineColor for the specified RGB (Red, Green, Blue) color model values.  
 MethodGetRunningCommandGets the name of the executing command.  
 MethodGetSystemFilesGets access to the DraftSight options that get and set these system files: dictionary, font, Help, log, and support.  
 MethodGetToolbarsObsolete. Superseded by IWorkspace::GetToolbars.  
 MethodGetVersionGets the version of DraftSight.  
 MethodGetWebLinkGets the web URL of the landing page of an online HTML help system.  
 MethodGetWorkspaceGets the specified workspace for the DraftSight user interface.  
 MethodGetWorkspacesGets all workspaces in the specified user-interface state.  
 MethodIsTemporaryEntityGets whether the specified entity is a temporary entity.  
 MethodIsWebHelpEnabledGets whether DraftSight web help is enabled.  
 MethodNewDocumentCreates a new document using the specified template.  
 MethodOpenChmHelpOpens the specified help topic in the specified CHM file.  
 MethodOpenDocumentObsolete. Superseded by IApplication::OpenDocument2.  
 MethodOpenDocument2Opens the specified document.  
 MethodOpenHelpOpens the specified system help topic in the specified system help.  
 MethodOpenWebHelpOpens the specified web help URL.  
 MethodRecoverRecovers a damaged drawing file.  
 MethodRegisterOnIdleNotifyPost an event to the event queue.  
 MethodRemoveCommandRemoves the specified command.  
 MethodRemoveUserInterfaceRemoves an add-in's user interface from the DraftSight user interface.  
 MethodRunCommandRuns the specified command.  
 MethodRunScriptRuns the specified script.  
 MethodZoomZooms to a region of the drawing determined by the specified range and entities.  

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

Subject:   Feedback on Help Topics
Page:   IApplication Interface Members
*   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:


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

Web Help Content Version: API Help (English only) 2019 SP04

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.