vim

Fork of vim, an acceptable text editor
git clone git://git.laack.co/vim.git
Log | Files | Refs | README | LICENSE

if_ole.txt (7092B)


      1 *if_ole.txt*	For Vim version 9.2.  Last change: 2026 Feb 14
      2 
      3 
      4 		  VIM REFERENCE MANUAL	  by Paul Moore
      5 
      6 
      7 The OLE Interface to Vim				*ole-interface*
      8 
      9 1. Activation			|ole-activation|
     10 2. Methods			|ole-methods|
     11 3. The "normal" command		|ole-normal|
     12 4. Registration			|ole-registration|
     13 5. MS Visual Studio integration	|MSVisualStudio|
     14 
     15 {only available when compiled with the |+ole| feature.  See
     16 src/if_ole.INSTALL}
     17 An alternative is using the client-server communication |clientserver|.
     18 
     19 ==============================================================================
     20 1. Activation						*ole-activation*
     21 
     22 Vim acts as an OLE automation server, accessible from any automation client,
     23 for example, Visual Basic, Python, or Perl.  The Vim application "name" (its
     24 "ProgID", in OLE terminology) is "Vim.Application".
     25 
     26 Hence, in order to start a Vim instance (or connect to an already running
     27 instance), code similar to the following should be used:
     28 
     29 [Visual Basic] >
     30 	Dim Vim As Object
     31 	Set Vim = CreateObject("Vim.Application")
     32 
     33 [Python] >
     34 	from win32com.client.dynamic import Dispatch
     35 	vim = Dispatch('Vim.Application')
     36 
     37 [Perl] >
     38 	use Win32::OLE;
     39 	$vim = new Win32::OLE 'Vim.Application';
     40 
     41 [C#] >
     42 	// Add a reference to Vim in your project.
     43 	// Choose the COM tab.
     44 	// Select "Vim Ole Interface 1.1 Type Library"
     45 	Vim.Vim vimobj = new Vim.Vim();
     46 
     47 Vim does not support acting as a "hidden" OLE server, like some other OLE
     48 Automation servers.  When a client starts up an instance of Vim, that instance
     49 is immediately visible.  Simply closing the OLE connection to the Vim instance
     50 is not enough to shut down the Vim instance - it is necessary to explicitly
     51 execute a quit command (for example, :qa!, :wqa).
     52 
     53 ==============================================================================
     54 2. Methods						*ole-methods*
     55 
     56 Vim exposes four methods for use by clients.
     57 
     58 							*ole-sendkeys*
     59 SendKeys(keys)		Execute a series of keys.
     60 
     61 This method takes a single parameter, which is a string of keystrokes.  These
     62 keystrokes are executed exactly as if they had been typed in at the keyboard.
     63 Special keys can be given using their <..> names, as for the right hand side
     64 of a mapping.  Note: Execution of the Ex "normal" command is not supported -
     65 see below |ole-normal|.
     66 
     67 Examples (Visual Basic syntax) >
     68 	Vim.SendKeys "ihello<Esc>"
     69 	Vim.SendKeys "ma1GV4jy`a"
     70 
     71 These examples assume that Vim starts in Normal mode.  To force Normal mode,
     72 start the key sequence with CTRL-\ CTRL-N as in >
     73 
     74 	Vim.SendKeys "<C-\><C-N>ihello<Esc>"
     75 
     76 CTRL-\ CTRL-N returns Vim to Normal mode, when in Insert or Command-line mode.
     77 Note that this doesn't work halfway a Vim command
     78 
     79 							*ole-eval*
     80 Eval(expr)		Evaluate an expression.
     81 
     82 This method takes a single parameter, which is an expression in Vim's normal
     83 format (see |expression|).  It returns a string, which is the result of
     84 evaluating the expression.  A |List| is turned into a string by joining the
     85 items and inserting line breaks.
     86 
     87 Examples (Visual Basic syntax) >
     88 	Line20 = Vim.Eval("getline(20)")
     89 	Twelve = Vim.Eval("6 + 6")		' Note this is a STRING
     90 	Font = Vim.Eval("&guifont")
     91 <
     92 							*ole-setforeground*
     93 SetForeground()		Make the Vim window come to the foreground
     94 
     95 This method takes no arguments.  No value is returned.
     96 
     97 Example (Visual Basic syntax) >
     98 	Vim.SetForeground
     99 <
    100 
    101 							*ole-gethwnd*
    102 GetHwnd()		Return the handle of the Vim window.
    103 
    104 This method takes no arguments.  It returns the hwnd of the main Vimwindow.
    105 You can use this if you are writing something which needs to manipulate the
    106 Vim window, or to track it in the z-order, etc.
    107 
    108 Example (Visual Basic syntax) >
    109 	Vim_Hwnd = Vim.GetHwnd
    110 <
    111 
    112 ==============================================================================
    113 3. The "normal" command					*ole-normal*
    114 
    115 Due to the way Vim processes OLE Automation commands, combined with the method
    116 of implementation of the Ex command :normal, it is not possible to execute the
    117 :normal command via OLE automation.  Any attempt to do so will fail, probably
    118 harmlessly, although possibly in unpredictable ways.
    119 
    120 There is currently no practical way to trap this situation, and users must
    121 simply be aware of the limitation.
    122 ==============================================================================
    123 4. Registration					*ole-registration* *E243*
    124 
    125 Before Vim will act as an OLE server, it must be registered in the system
    126 registry.  In order to do this, Vim should be run with a single parameter of
    127 "-register".
    128 							*-register*  >
    129 	gvim -register
    130 
    131 If gvim with OLE support is run and notices that no Vim OLE server has been
    132 registered, it will present a dialog and offers you the choice to register by
    133 clicking "Yes".
    134 
    135 In some situations registering is not possible.  This happens when the
    136 registry is not writable.  If you run into this problem you need to run gvim
    137 as "Administrator".
    138 
    139 Once vim is registered, the application path is stored in the registry.
    140 Before moving, deleting, or upgrading Vim, the registry entries should be
    141 removed using the "-unregister" switch.
    142 							*-unregister*  >
    143 	gvim -unregister
    144 
    145 The OLE mechanism will use the first registered Vim it finds.  If a Vim is
    146 already running, this one will be used.  If you want to have (several) Vim
    147 sessions open that should not react to OLE commands, use the non-OLE version,
    148 and put it in a different directory.  The OLE version should then be put in a
    149 directory that is not in your normal path, so that typing "gvim" will start
    150 the non-OLE version.
    151 
    152 							*-silent*
    153 To avoid the message box that pops up to report the result, prepend "-silent":
    154 >
    155 	gvim -silent -register
    156 	gvim -silent -unregister
    157 
    158 ==============================================================================
    159 5. MS Visual Studio integration				*MSVisualStudio*
    160 
    161 The old "VisVim" integration was removed from Vim in patch 9.0.0698.
    162 
    163 
    164 Using Vim with Visual Studio .Net~
    165 
    166 .Net studio has support for external editors.  Follow these directions:
    167 
    168 In .Net Studio choose from the menu Tools->External Tools...
    169 Add
    170      Title     - Vim
    171      Command   - c:\vim\vim63\gvim.exe
    172      Arguments - --servername VS_NET --remote-silent "+call cursor($(CurLine), $(CurCol))" $(ItemPath)
    173      Init Dir  - Empty
    174 
    175 Now, when you open a file in .Net, you can choose from the .Net menu:
    176 Tools->Vim
    177 
    178 That will open the file in Vim.
    179 You can then add this external command as an icon and place it anywhere you
    180 like.  You might also be able to set this as your default editor.
    181 
    182 If you refine this further, please post back to the Vim maillist so we have a
    183 record of it.
    184 
    185 --servername VS_NET
    186 This will create a new instance of vim called VS_NET.  So if you open multiple
    187 files from VS, they will use the same instance of Vim.  This allows you to
    188 have multiple copies of Vim running, but you can control which one has VS
    189 files in it.
    190 
    191 --remote-silent "+call cursor(10, 27)"
    192 	      - Places the cursor on line 10 column 27
    193 In Vim >
    194    :h --remote-silent for more details
    195 
    196 [.Net remarks provided by Dave Fishburn and Brian Sturk]
    197 
    198 ==============================================================================
    199  vim:tw=78:ts=8:noet:ft=help:norl: