Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
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 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
Collapse DraftSight API HelpDraftSight API Help
Welcome
Getting Started
Release Notes
Access Diagram
Collapse Interop.dsAutomation NamespaceInterop.dsAutomation Namespace
Overview
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
Collapse 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
ICommandMessage Interface Members

The following tables list the members exposed by ICommandMessage.

Public Properties

 NameDescription
PropertyPromptExplanationGets or sets the text for the prompt in the command window.  
Top

Public Methods

 NameDescription
MethodAddTrackerAdds a tracker, the mechanism that draws temporary entities along the cursor's path when prompting a user for a value, keyword, or selection.  
MethodGetLastErrorDisplays the status of the last-run command in the command window.  
MethodGetLastUserInputGets the last value input by a user in the command window.  
MethodPrintLineDisplays the specified string in the command window.  
MethodPromptForAngleDisplays the specified prompt and default value for an angle in the command window and gets the angle input by the user.  
MethodPromptForAngleOrKeywordObsolete. Superseded by ICommandMessage::PromptForAngleOrKeyword2.  
MethodPromptForAngleOrKeyword2Displays the specified prompt, local keywords, and default value for an angle in the command window and gets the user's input.  
MethodPromptForBlockInsertionPrompts the user for the insertion point, scale factors, and rotation angle to use when inserting a Block Instance.  
MethodPromptForBoolDisplays the specified prompt and default Boolean value in the command window and gets the Boolean input by the user.  
MethodPromptForBoolOrKeywordDisplays the specified prompt, local keywords, and default value for the Boolean in the command window and gets the user's input.  
MethodPromptForDistanceDisplays the specified prompt and default value for the linear distance in the command window and gets the linear distance input by the user.  
MethodPromptForDistanceOrKeywordObsolete. Superseded by ICommandMessage::PromptForDistanceOrKeyword2.  
MethodPromptForDistanceOrKeyword2Displays the specified prompt, local keywords, and default value for the linear distance in the command window and gets the user's input.  
MethodPromptForDoubleDisplays the specified prompt and default value for the double in the command window and gets the double input by the user.  
MethodPromptForDoubleOrKeywordDisplays the specified prompt, local keywords, and default value for the double in the command window and gets the user's input.  
MethodPromptForFileNameDisplays the specified prompt in the command window and gets the file name input by the user.  
MethodPromptForFileNameOrKeywordDisplays the specified prompt, local keywords, and default value for the file name in command window and gets the user's input.  
MethodPromptForIntegerDisplays the specified prompt and default value for the integer or long in the command window and gets the integer or long input by the user.  
MethodPromptForIntegerOrKeywordDisplays the specified prompt, local keywords, and default value for the integer or long in the command window and gets the user's input.  
MethodPromptForKeywordObsoleted. Superseded by ICommandMessage::PromptForKeyword2.  
MethodPromptForKeyword2Displays the specified prompt, local keywords, and default value for the keyword in the command window and gets the keyword input by the user.  
MethodPromptForOrientationDisplays the specified prompt and default value for the orientation in the command window and gets the orientation input by the user.  
MethodPromptForOrientationOrKeywordObsolete. Superseded by ICommandMessage::PromptForOrientationOrKeyword2.  
MethodPromptForOrientationOrKeyword2Displays the specified prompt, local keywords, and default value for the orientation in the command window and gets the user's input.  
MethodPromptForPointObsolete. Superseded by ICommandMessage::PromptForPoint2.  
MethodPromptForPoint2Displays the specified prompt in the command window gets the x, y, and z coordinates specified by the user.  
MethodPromptForPointOrKeywordDisplays the specified prompt, local keywords, and default value for the point in the command window and gets the user's input.  
MethodPromptForSelectionDisplays the specified prompt for selecting one or more entities.  
MethodPromptForSelectionOrKeywordDisplays the specified prompt and local keywords for selecting one or more entities in the command window and gets the user's input.  
MethodPromptForStringDisplays the specified prompt and default value in the command window and gets the user's input.  
MethodPromptForStringOrKeywordDisplays the specified prompt, local keywords, and default string in the command window and gets the user's input.  
MethodRemoveTrackerRemoves the tracker, the mechanism that draws temporary entities along the cursor's path when prompting a user for a value, keyword, or selection.  
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:   ICommandMessage 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) 2019 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.21