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
Expand 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
Collapse 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
IDocument Interface Members

The following tables list the members exposed by IDocument.

Public Properties

 PropertyDimensionScaleGets or sets the scale factor based on the ratio between the current Viewport and the drawing Sheet.  
 PropertyScaleUnitGets or sets the scale factor for DimensionStyle settings.  

Public Methods

 MethodActivateActivates the document.  
 MethodCleanPurges this document of the objects that are defined or loaded but not used.  
 MethodCopySheetCreates a new Sheet by copying the specified existing Sheet.  
 MethodCreateBlockDefinitionCreates a Block definition.  
 MethodCreateGroupCreates an EntityGroup, which combines the specified entities into a group that you can manipulate in a single operation.  
 MethodCreateHighlightSetCreates a highlight selection set containing the specified entities.  
 MethodCreateLispFunctionCreates a LISP function that can be called from LISP.  
 MethodCreateSheetCreates a Sheet using the specified name.  
 MethodCreateSheetByTemplateCreates a Sheet based on a Sheet in another file.  
 MethodErrorCheckChecks the integrity of this document and optionally corrects errors.  
 MethodGetAngleUnitExpressionGets the type of angular unit and its precision for the document.  
 MethodGetBaseAngleGets the base angle for the document.  
 MethodGetBlockDefinitionGets the specified Block definition for the document.  
 MethodGetBlockDefinitionsGets the Block definitions for the document.  
 MethodGetCommandOptionBoolGets the Boolean value of the specified command option for the document.  
 MethodGetCommandOptionDoubleGets the double value of the specified command option for the document.  
 MethodGetCommandOptionInt16Gets the 16-bit signed integer, also called Int16, value of the specified command option for the document.  
 MethodGetCommandOptionInt32Gets the 32-bit signed integer, also called Int32, value of the specified command option for the document.  
 MethodGetCommandOptionInt8Gets the 8-bit signed integer, also called Int8, value of the specified command option for the document.  
 MethodGetCommandOptionPoint2DGets the 2D point's coordinates for the specified command option in the document.  
 MethodGetCommandOptionPoint3DGets the 3D point's coordinates for the specified command option in the document.  
 MethodGetCommandOptionStringGets the string value for the specified command option in the document.  
 MethodGetCustomCoordinateSystemManagerCreates a new instance of the custom coordinate system manager.  
 MethodGetDimensionStyleManagerGets the DimensionStyle Manager.  
 MethodGetDocumentExporterGets the export feature for the document.  
 MethodGetDrawingPropertiesGets access to the standard (i.e., author, keywords, title, and subject) and custom properties of a drawing document.  
 MethodGetExternalReferencesGets the external references for the document.  
 MethodGetGroupGets the specified EntityGroup, which contains entities that have been combined into a group that you can manipulate in a single operation.  
 MethodGetGroupsGets the specified EntityGroups.  
 MethodGetHandleFromObjectGets the handle of the specified object.  
 MethodGetLayerManagerGets the Layer Manager for the document.  
 MethodGetLayerStateManagerAccesses the Layer State Manager of this document.  
 MethodGetLengthUnitExpressionGets the type of linear unit and its precision for the document.  
 MethodGetLineStyleManagerGets the LineStyle Manager.  
 MethodGetModelGets the model for the document.  
 MethodGetNamedObjectsDictionaryGets the named-objects dictionary for the drawing.  
 MethodGetObjectByHandleGets an object by its handle.  
 MethodGetPathNameGets the path and file name of the document.  
 MethodGetRegisteredApplicationsGets the names of the registered applications for the document's custom data.  
 MethodGetRichLineStyleManagerGets the RichLineStyle Manager.  
 MethodGetSelectionManagerGets the interface for selecting entities, which makes the currently and previously selected entity available.  
 MethodGetShapeManagerGets the Shape Manager.  
 MethodGetSheetGets the specified Sheet.  
 MethodGetSheetsObsolete. Superseded by IDocument::GetSheets2.  
 MethodGetSheets2Gets the Sheets for the document.  
 MethodGetTableStyleManagerGets the TableStyle Manager.  
 MethodGetTextStyleManagerGets the TextStyle Manager.  
 MethodGetViewManagerGets the View Manager.  
 MethodGetWindowGets the DraftSight document window.  
 MethodHasBlockDefinitionGets whether the specified Block definition is inserted in the document.  
 MethodHasSheetGets whether the document contains the specified Sheet.  
 MethodIsActiveGets whether the document is active.  
 MethodIsDirtyGets whether the document has been modified since it was opened and not saved.  
 MethodIsReadOnlyGets whether the document is read only.  
 MethodPanMoves the visible portion of the drawing in the direction and distance defined through a vector.  
 MethodRebuildRebuilds the document.  
 MethodRemoveLispFunctionRemoves the specified LISP function so that it can no longer be called from LISP.  
 MethodRemoveSheetDeletes the specified Sheet from the document.  
 MethodSaveSaves the document.  
 MethodSaveAsObsoleted. Superseded by IDocument::SaveAs2.  
 MethodSaveAs2Saves the document as the specified file name and file type.  
 MethodSetAngleUnitExpressionSets the type of angular unit and its precision for the document.  
 MethodSetBaseAngleSets the base angle for the document.  
 MethodSetCommandOptionBoolSets the Boolean value for the specified command option for the document.  
 MethodSetCommandOptionDoubleSets the double value for the specified command option for the document.  
 MethodSetCommandOptionInt16Sets the 16-bit signed integer, also called Int16, value for the specified command option for the document.  
 MethodSetCommandOptionInt32Sets the 32-bit signed integer, also called Int32, value for the specified command option for the document.  
 MethodSetCommandOptionInt8Sets the 8-bit signed integer, also called Int8, value for the specified command option for the document.  
 MethodSetCommandOptionPoint2DSets the command option for the specified 2D point in the document.  
 MethodSetCommandOptionPoint3DSets the command option for the specified 3D point in the document.  
 MethodSetCommandOptionStringSets the string value for the specified command option in the document.  
 MethodSetLengthUnitExpressionSets the type of linear unit and its precision for the document.  
 MethodWriteBlockByAllEntitiesSaves this entire drawing to a new drawing file.  
 MethodWriteBlockByNameSaves the specified Block in this drawing to a new drawing file.  
 MethodWriteBlockBySpecifiedEntitiesSaves the specified entities in this drawing to a new drawing file.  

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:   IDocument 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.