WIXLIB

AutoLISP Developer's Guide Introduction Related DocumentsIn addition to the AutoLISP Reference and the AutoLISP Tutorial, several otherAutoCAD publications may be required by users building applications withVisual LISP:AutoCAD ActiveX and VBA Reference contains information onaccessing ActiveX methods, properties, and objects. If you developAutoLISP applications that use ActiveX automation to referenceAutoCAD objects, you will need to refer to this reference. It is availablethrough the AutoCAD and Visual LISP Help menus.AutoCAD Customization Guide contains basic information on creatingcustomized AutoCAD applications. For example, it includes informationon creating customized menus, linetypes, and hatch patterns. TheCustomization Guide is available through the AutoCAD and Visual LISPHelp menus.The DXF Reference describes drawing interchange format (DXFTM) andthe DXF group codes that identify attributes of AutoCAD objects. Youmay need to refer to the DXF Reference when working with associationlists describing entity data. The DXF Reference is available through theAutoCAD and Visual LISP Help menus.The ObjectARX Reference contains information on using ObjectARX to develop customized AutoCAD applications. AutoCAD reactorfunctionality is implemented through ObjectARX. If you developAutoLISP applications that implement reactor functions, you may wantto refer to this manual.The ObjectARX Reference is not included when you install AutoCAD.To obtain the manual, download the ObjectARX SDK (SoftwareDevelopment Kit) from the www.autodesk.com.

Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP EnvironmentGetting StartedYou can use Visual LISP to increase your productivity by compilingprograms, stepping through code, and debugging.Developing Programs with Visual LISPWith Visual LISP, you can format your code and automatically detectsyntax errors.Debugging ProgramsTo debug a program, you can trace execution, trace the values ofvariables during execution, and view the sequence in which expressionsare evaluated.Building ApplicationsYou can compile your program files and create a single executablemodule that you can distribute to users.Maintaining Visual LISP ApplicationsYou can maintain large programs by creating a Visual LISP project andoptimizing code.Working with ActiveXWith Visual LISP, you can access the AutoCAD object model.Advanced TopicsYou can use reactors for event notification.Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment Getting StartedYou can use Visual LISP to increase your productivity by compiling programs,stepping through code, and debugging.This chapter introduces you to the look and feel of the Visual LISP interactivedevelopment environment (IDE), and shows you how to run AutoLISP programs in Visual LISP.Starting Visual LISPExploring the Visual LISP User InterfaceTouring the Visual LISP MenusUnderstanding the Console WindowUnderstanding the Visual LISP Text EditorLoading and Running AutoLISP ProgramsExiting Visual LISPPlease send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Starting Visual LISPThe Visual LISP (VLISP) interactive development environment runs in aseparate set of windows from the rest of AutoCAD . You must explicitly startVLISP to work in the interactive development environment.To start Visual LISP1. Start AutoCAD.2. Choose Tools AutoLISP Visual LISP Editor from the AutoCADmenu, or enter the following at the Command prompt:vlispYou can use either the menu or the vlisp command to return to the VLISP IDEat any time.Note that AutoCAD also recognizes the vlide command to start or return toVisual LISP. This command name stands for “Visual LISP interactivedevelopment environment.” AutoCAD issues the vlide command to callVLISP, and as a result you may sometimes see “VLIDE” displayed in theAutoCAD Command window.Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Exploring the Visual LISP User InterfaceWhen you first start Visual LISP, the following components are displayed:MenuYou can issue VLISP commands by choosing from the various menu items. Ifyou highlight an item on a menu, VLISP displays a brief description of thecommand's function in the status bar at the bottom of the screen.ToolbarsClick toolbar buttons to issue VLISP commands quickly. There are fivetoolbars—Debug, Edit, Find, Inspect, and Run—each representing a distinctfunctional group of VLISP commands. You can execute many, but not all,menu commands from the toolbars. If you move your mouse pointer over atoolbar button and leave it there for a couple of seconds, VLISP displays atooltip indicating the function of the button. A more descriptive explanationappears in the status bar at the bottom of the VLISP screen.Console WindowThis is a separate, scrollable window within the main VLISP window. In theConsole window, you can type AutoLISP commands, similar to the way youdo in the AutoCAD Command window. You can also issue many Visual LISPcommands from this window, instead of using the menu or toolbars. SeeUnderstanding the Console Window for more information on the Consolewindow.Status BarThe information displayed in the status bar located at the bottom of thescreen varies according to what you are doing in VLISP.You may also see a minimized Trace window. During startup, this window

contains informational messages about the current release of VLISP, and maycontain additional information if VLISP encounters errors during startup.Introducing the Visual LISP Text EditorOther Visual LISP WindowsPlease send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Exploring the Visual LISP User Interface Introducing the Visual LISP Text EditorYou will spend much of your time in VLISP creating or modifying AutoLISPprograms. VLISP comes with an integrated text editor for you to use withAutoLISP code.To see how the text editor window displays code, open a sample AutoLISPprogram. Begin with the drawline.lsp file provided with VLISP.The sample files are only included in your installation if you chose a Fullinstallation, or if you chose a Custom installation and selected the Visual LISPSamples item. If you previously installed AutoCAD and did not install thesamples, rerun the install, choose Custom, and select the Visual LISP Samplesitem.NoteTo view a LISP program in the VLISP text editor1. From the VLISP menu, choose FileOpen File.2. In the Open File dialog box, select the Sample\VisualLISP folder, whichis in your AutoCAD installation directory.3. Double-click the drawline.lsp file.VLISP opens the file in a new window—the text editor window—anddisplays the name of the file in the status bar. If you make a change tothe text in the editor window, or add new text, VLISP places an asterisk(*) next to the file name in the status bar. The asterisk remains next tothat file name until you either save your changes or close the file.You can work on more than one file at a time. Each time you open a file,VLISP displays the file in a new text editor window.

Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Exploring the Visual LISP User Interface Other Visual LISP WindowsVLISP displays some output in the Console window, but several VLISPfunctions create their own windows in which to display results. For example,when you trace the sequence of events during a running AutoLISP program, theTrace function opens a window and displays program events. You cannot entertext in these output windows, but you can copy text from them and paste the textinto the editor or Console windows.Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Touring the Visual LISP MenusYou can issue VLISP commands by choosing from the various menu items. Forexample, from the File menu you can create a new AutoLISP program file, selectan existing program file to edit, and print the file you're editing.Variable Menu ContentsVisual LISP Menu SummaryPlease send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Touring the Visual LISP Menus Variable Menu ContentsMenu contents may vary depending on which VLISP window (for example, texteditor, Console) is active. To activate a different window, click in the window'stitle bar, or in any empty area of that window.As an example, click in the text editor window containing the drawline.lsp file,then choose Edit from the VLISP menu. You'll see the following list:Note that the last items on the menu are Parentheses Matching and ExtraCommands.Now click in the title bar of the VLISP Console window, then select the Editmenu item again:

Notice that Extra Commands is no longer the last item on the menu. ParenthesesMatching is followed by two new items, Console History Up and ConsoleHistory Down; these items apply only to a Console window.Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Touring the Visual LISP Menus Visual LISP Menu SummaryThe following table summarizes the VLISP menu items.Visual LISP menu itemsMenuitemUsesFileCreate a new AutoLISP program file forediting, open an existing file, savechanges to program files, build VisualLISP application files, and print programfiles.EditCopy and paste text, undo the last changeyou made to text (or undo the lastcommand entered in the Consolewindow), select text in the VLISP editoror Console windows, match parenthesesin expressions, and redisplay previouscommands entered in the Consolewindow. See the chapter titledDeveloping Programs with Visual LISPfor more information on Edit features.SearchFind and replace text strings, setbookmarks, and navigate amongbookmarked text. See Using the TextEditor for information on these topics.

ViewFind and display the value of variablesand symbols in your AutoLISP code. Formore information on this topic, seechapter 3, Debugging Programs.ProjectWork with projects and compileprograms. See Managing Multiple LISPFiles, and Compiling and LinkingPrograms for information on these topics.DebugSet and remove breakpoints in yourprogram and step through programexecution one expression at a time. Youcan then check the state of variables andthe results of expressions. See chapter 3,Debugging Programs, for moreinformation on these features.ToolsSet VLISP options for text formattingand various environment options, such asthe placement of windows and toolbars.WindowOrganize the windows currentlydisplayed in your VLISP session, oractivate another VLISP or AutoCADwindow.HelpDisplay Help.Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Understanding the Console WindowFrom the VLISP Console window, you can enter and run AutoLISP commandsand see the results. This is similar to what you can do in the AutoCADCommand window, but there are a few differences—some subtle—in how youaccomplish the same task in these two windows. For example, to display thecurrent value of an AutoLISP variable in VLISP, you simply type the variablename in the Console window and press ENTER. To view the value of a variablein AutoCAD, you must precede the variable name with an exclamation point (!)when you type it in the Command window.The Console window is also where VLISP displays AutoLISP diagnosticmessages and the results of many AutoLISP functions. For example, output fromthe print and princ functions is displayed in the Console window. You can scrollthrough the Console window to view previously entered text and output.For a description of VLISP Console window features, see Using the ConsoleWindow. The following is a brief summary of these features:Evaluating AutoLISP expressions and displaying the return values fromthose expressions.Entering AutoLISP expressions on multiple lines by pressing CTRL ENTER to continue on the next line.Evaluating multiple expressions at one time.Copying and transferring text between the Console and text editorwindows. Most text editor commands are also available in the Consolewindow.Retrieving previous commands entered in the Console by pressing TAB.You can press TAB repeatedly to retrieve earlier commands. PressSHIFT TAB to reverse the direction of command retrieval.

Performing an associative search through the input history by pressingTAB. For example, if you begin an expression with ( and then pressTAB, VLISP retrieves the last command you entered that begins with ( .To reverse the direction of the search, press SHIFT TAB.Pressing ESC clears any text following the Console prompt.Pressing SHIFT ESC leaves the text you entered at the Consoleprompt without evaluating the text, and displays a new Console prompt.Right-clicking or pressing SHIFT F10 anywhere in the Consolewindow displays a menu of VLISP commands and options. For example,you can use this feature to copy and paste text in the Console commandline, search for text, and initiate VLISP debugging features.Note that if you type text at the Console prompt but switch to the AutoCADwindow before pressing ENTER, the text will no longer be at the prompt whenyou return to the VLISP window.Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Understanding the Visual LISP Text EditorThe VLISP text editor is much more than a writing tool, it's a central componentof the VLISP programming environment. To appreciate the versatility and valueof the VLISP text editor, you need to be familiar with the AutoLISP language. Ifyou are not yet familiar with AutoLISP, you can learn the basics in chapter 8,AutoLISP Basics and find additional information in chapter 9, Using AutoLISPto Communicate with AutoCAD and chapter 10, Using AutoLISP to ManipulateAutoCAD ObjectsHere are some of the major features of the text editor:Color Coding of FilesThe text editor identifies different parts of an AutoLISP program and assignsdistinct colors to them. This allows you to find program components easilysuch as function calls and variable names, and helps you find typographicalerrors.Formatting of TextThe text editor can format AutoLISP code for you, making the code easier toread. You can choose from a number of different formatting styles.Parenthesis MatchingAutoLISP code contains many parentheses, and the editor helps you detectmissing parentheses by finding the close parenthesis that goes with an openparenthesis.Execution of AutoLISP ExpressionsYou can test expressions and lines of code without leaving the text editor.Multiple File SearchingThe text editor can search for a word or expression in several files with a

single command.Syntax Checking of AutoLISP CodeThe text editor can evaluate AutoLISP code and highlight syntax errors.Details on using the VLISP text editor begin with Using the Text Editor.Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Loading and Running AutoLISP ProgramsOnce you have opened an AutoLISP program file in the VLISP text editor, youcan load and run it. Loading is the process by which functions in a program fileare made available to the VLISP command interpreter. You can try this with thedrawline.lsp sample program.To load and run a program in a Visual LISP text editor window1. Make sure the text editor window containing the drawline.lsp program isactive. If you are not sure whether the window is active, click anywherein the window to activate it.2. Choose the Load Active Edit Window button from the Run toolbar, orchoose Tools Load Text in Editor from the VLISP menu.VLISP responds by displaying a message in the Console windowindicating it has loaded the program.3. Run the drawline function from the Console prompt by entering thefunction name in parentheses, then pressing ENTER: (drawline)The drawline function will ask you to specify two points, and willthen draw a straight line between those points. When drawline asksfor user input, VLISP turns control over to AutoCAD to prompt you forthe points. What you see next depends on whether or not the AutoCADwindows are currently displayed on your desktop. If AutoCAD isalready on your desktop, you'll see the AutoCAD windows. But ifAutoCAD is currently minimized on your desktop, the windows won't

automatically be restored and displayed. Instead, VLISP remains visibleand your mouse pointer changes to a VLISP symbol.This symbol indicates that the VLISP window is no longer active. If thisis the case, you must manually switch to the AutoCAD window. Clickthe AutoCAD icon on the Windows task bar to activate AutoCAD.4. Respond to the prompts by specifying points in the graphics window oron the Command line.After you respond to the prompts, control returns to VLISP and you willonce again see the VLISP window.When you enter commands in the VLISP Console window or run aprogram loaded from the text editor, you may be frequently switchingback and forth between the VLISP and AutoCAD windows. Aside fromusing the standard Windows methods of switching between windows,you can activate the AutoCAD window by choosing Window ActivateAutoCAD from the VLISP menu, or by clicking the Activate AutoCADbutton on the Run toolbar. If you are in AutoCAD and want to return tothe VLISP environment, you can enter vlisp at the Command prompt,or choose Tools AutoLISP Visual LISP Editor from the AutoCADmenu.Running Selected Lines of CodeUsing Extended AutoLISP FunctionsPlease send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Loading and Running AutoLISP Programs Running Selected Lines of CodeWith VLISP, you can select lines of code in the text editor window and run onlythe selected code, instead of the whole program.To run selected lines of AutoLISP code in a Visual LISP editor window1. Using the drawline.lsp program as an example, highlight the followinglines of code:(setq pt1(getpoint "\nEnter the start point for the line: ")pt2(getpoint pt1 "\nEnter the end point for the line: "))2. Choose the Load Selection button on the Run toolbar.VLISP immediately runs the code and switches control to AutoCAD toprompt you for input.Please send us your comment about this page

AutoLISP Developer's Guide Using the Visual LISP Environment GettingStarted Loading and Running AutoLISP Programs Using Extended AutoLISP FunctionsVLISP provides some extensions to the AutoLISP language that are not loadedautomatically when you start AutoCAD. These functions have names that beginwith vla-, vlax-, and vlr. The vla- functions implement ActiveX support inAutoLISP (described in Working with ActiveX). The vlax- functions provideActiveX utility and data conversion functions, dictionary handling functions, andcurve measurement functions. The vlr- functions provide support for AutoCADreactors. Before you can use any

AutoCAD publications may be required by users building applications with Visual LISP: AutoCAD ActiveX and VBA Reference contains information on accessing ActiveX methods, properties, and objects. If you develop AutoLISP applications that use ActiveX automation to reference AutoCAD objects,