Visual studio excel vba

Время на прочтение
12 мин

Количество просмотров 7.9K

В статье рассматривается использование Visual Studio для решения узкой задачи – собственно вызов VBA-макросов, расположенных в надстройках или документах, с помощью кнопок, которые разработчик может разместить в необходимых дополнительных (отдельно созданных) группах элементов вкладки НАДСТРОЙКИ ленты Excel или отдельных вкладках, и, при желании, использовать все современные возможности для работы с этими элементами.

Для читателей, в целом знакомых с тем, как в Visual Studio (конкретно – механизмы Visual Studio Tools for Office (VSTO)) реализована работа с объектами офисных приложений (объектные модели, само собой, ничем не отличаются от доступных средствами VBA), целесообразно сократить время чтения – основную мысль статьи можно выразить одной строкой C#-кода:

Globals.ThisAddIn.Application.Run("Файл_с_макросами.xlsm!МакросОдин");

которая аналогична хорошо известному VBA-вызову Application.Run(“ИмяМакроса”) – в том числе и в варианте вызова как функции:

MyValue = Globals.ThisAddIn.Application.Run("Файл_с_макросами.xlsm!МакросОдин");

Ну и вариантах с передачей одного или нескольких параметров разных типов:

Globals.ThisAddIn.Application.Run("Файл_с_макросами.xlsm!МакросОдин", "Параметр1", 2);

VBA-разработчиков, для которых актуальна данная проблема, – приглашаю продолжить чтение. Пошаговое выполнение демо-примера займет примерно 10-20 минут (без учета затрат времени на загрузку, установку и стартовую настройку Visual Studio Community Edition).

Основная цель упражнения – посмотреть как можно получить современный настраиваемый ribbon-интерфейс и при этом вообще не вносить какие-либо изменения в файлы, содержащие VBA-макросы.

VBA-код
Пока, для простоты, модуль с VBA-кодом не должен содержать опцию Option Private Module – наши публичные процедуры и функция должны доступны не только из этого VBA-проекта. В модуле Module1 xlsm-файла DemoVBA

Option Explicit

Public Sub МакросОдин()
MsgBox "Вызван МакросОдин"
End Sub

Public Sub МакросДва(ByVal strParam1 As String)
MsgBox "Вызван МакросДва, передан параметр " & strParam1
End Sub

Public Function ФункцияТри(ByVal strParam1 As String, ByVal intParam2 As Integer) As String
ФункцияТри = "Вызвана ФункцияТри с параметром " & strParam1 & Str(intParam2)
End Function

Создание VSTO-надстройки в Visual Studio

Запускаем VS, выполняем Файл -> Создать проект

1) В предъявленном диалоге в правом списке выбираем «Надстройка VSTO для Excel», Далее.

2) Указываем имя надстройки, каталог для размещения папок и файлов проекта.

3) Необязательно — в предъявленном окне с кодом C#-класса ThisAddin.cs копируем в буфер обмена строку

using Excel = Microsoft.Office.Interop.Excel;

после этого щелком по крестику закрываем этот класс – для демо-примера не требуется вносить в него какие-либо изменения.

4) В Обозревателе решений правым щелчком по имени надстройки DemoAddin вызываем меню и выбираем «Создать элемент».

5) В диалоге добавления нового элемента выбираем «Лента (визуальный конструктор)» и указываем имя класса DemoRibbon.cs.

6) В визуальном конструкторе создаётся заготовка (group1) нашей будущей группы элементов ленты. В окне свойств сразу переименовываем её и задаём надпись — DemoGroup.

7) Из Панели элементов, из группы «Элементы управления ленты Office» в нашу вкладку перетаскиваем три Button’a и в окне свойств задаём имена и надписи DemoButton1..3.

Двойным щелчком по верхней кнопке открываем вкладку кода. Вкладка визуального конструктора остается открытой и двойными щелчками по второй и третьей кнопке для них так же создайте обработчики события Click.

9) Модифицируйте код этого класса следующим образом:
— в верхний список using’ов вставьте строки:

using Excel = Microsoft.Office.Interop.Excel;
using System.Windows.Forms;

— добавьте объявление и инициализацию объекта ExcelApp;
— заполните обработчики событий вызовами ExcelApp.Run(…..):

using Microsoft.Office.Tools.Ribbon;
using System;
using System.IO;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Excel = Microsoft.Office.Interop.Excel; 
//эта строка нужна для объявления нашего объекта ExcelApp; копия из ThisAddin.cs
using System.Windows.Forms;
//Обязательно подключаем пространство имен System.Windows.Forms - 
//чтобы стал доступен объект MessageBox

namespace DemoAddin
{
    public partial class DemoRibbon
    {

        Excel.Application ExcelApp; 
         // объявляем наш объект ExcelApp типа Excel.Application
        // данное объявление стало возможным благодаря указанию using Excel =
        // объект объявлен на уровне класса, чтобы он был виден в обработчиках Click

        private void DemoRibbon_Load(object sender, RibbonUIEventArgs e)
        {
            ExcelApp = Globals.ThisAddIn.Application; 
            //присваиваем нашему объекту ссылку на работающий экземпляр Excel -
            //тот, в котором открыта эта надстройка.
            //присвоение выполняется в событии Load вкладки ленты, т.к., 
            //упрощая, можно сказать что для "системных" классов вносить  
            //какие-либо изменения в конструкторы не требуются 
        }

        private void DemoButton1_Click(object sender, RibbonControlEventArgs e)
        {
            ExcelApp.Run("DemoVBA.xlsm!Module1.МакросОдин");
            //самый простой вызов
        }

        private void DemoButton2_Click(object sender, RibbonControlEventArgs e)
        {
            ExcelApp.Run("DemoVBA.xlsm!МакросДва" , 
            "Строка для показа в MsgBox в VBA");
           //вызов с одним параметром
        }

        private void DemoButton3_Click(object sender, RibbonControlEventArgs e)
        {
            String DemoStr;
           // переменная для присвоения значения, возвращаемого функцией VBA

            DemoStr = ExcelApp.Run("DemoVBA.xlsm!ФункцияТри",
            "Будет возвращена эта строка, и число, преобразованное в строку: ",
            2020);
            //вызов VBA-функции для получения из неё строкового значения; 
            //VBA никакие сообщения не выдаёт

            MessageBox.Show(DemoStr); //сообщение выдаем в VSTO-надстройке.
        }
    }
} 

(примечания:
— IntelliSense VS, как и VBA, упрощает ввод параметров – на рисунке момент после ввода запятой после первого параметра; типы параметров не указаны, потому что и в VBA все, кроме первого, параметры метода Application.Run являются Variant – три десятка необязательных;

— обращение ExcelApp можно заменить на Globals.ThisAddIn.Application и обойтись без объявления и инициализации объекта ExcelApp.)

Тестовый запуск

1) Закрываем запущенный Excel – если открыт.

2) В Visual Studio щелкаем кнопку Пуск. С небольшой задержкой будет запущен Excel, с открытием пустого файла по умолчанию.

3) Убеждаемся, что во вкладке НАДСТРОЙКИ появилась группа элементов DemoGroup с тремя кнопками. Если не появилась, то во вкладке РАЗРАБОТЧИК щелкаем «Надстройки COM» и в диалоге включаем галочку для нашей надстройки (анализ возможных причин такого поведения – за рамками этой статьи).

4) В запущенном Excel через меню Файл -> Открыть отрываем файл DemoVBA.xlsm. Почему так? Потому что при открытии щелчком по ярлыку или из списка последних файлов на панели задач в данной ситуации будет открыт еще один экземпляр Excel, а нам нужно работать в экземпляре, которым Visual Studio управляет в тестовом режиме – для отладки.

5) Щелкаем наши кнопки DemoButtonN и убеждаемся, что технология работает. При этом обращаем внимание, что в заголовках сообщений, появляющихся после щелчков кнопок 1 и 2 указано «Microsoft Excel» – это заголовок по умолчанию для MsgBox, вызванном в Excel-VBA без параметра Title. А в сообщении для кнопки 3 заголовка нет вообще – потому что это сообщение выведено методом MessageBox.Show(), при вызове которого мы тоже не указали параметр Title, и который про Excel ничего не знает.

Выводы по тестовому примеру

Очевидный плюс – теперь для создания и модернизации своих компонентов ленты (групп элементов, и, при необходимости, и целых вкладок) можно использовать современные средства – визуальный дизайнер, различное оформление, при необходимости – программное изменение своих элементов. Так же, в зависимости от количества элементов и удобства компоновки групп и вкладок, можно быстро полностью заменить элементы вызова макросов – например, вместо отдельных кнопок сделать кнопку-меню с раскрывающимися опциями или сделать раскрывающийся список имен макросов и отдельную кнопку запуска выбранного. При этом не придется разбираться с XML-редакторами, процедурами обратного вызова и прочими сопутствующими нюансами.

Можно развить идею вызова Application.Run как функции – если нужно что-то получать непосредственно из Excel или что-то вычисляемое средствами VBA, и нет времени на изучение C# и модели доступа к Excel, то можно подготовить некоторое количество VBA-функций, которые за пределы Excel-VBA будут возвращать то, что требуется. При правильном проектировании таких функций может быть немного, что требуется от конкретной функции – можно указывать параметрами. Для использования в C# возвращаемых значений простых типов (строки, числа) особо погружаться в изучение C# не придется, если же возвращать объектные типы (например, Range, ссылки на листы и книги) или массивы, то нужно будет изучить правила объявления переменных и т.п.

Использование XLAM-надстройки и формирование дистрибутива VSTO-надстройки
Теперь необходимо провести проверку для компонентов, которые будут устанавливаться на компьютерах пользователей.

1) XLSM-файл сохраняем как XLAM-надстройку.

2) В Visual Studio в вызовах Application.Run() заменяем DemoVBA.xlsm на DemoVBA.xlam, сохраняем проект (примечание – в демо-примере решения Visual Studio, доступном по ссылке ниже, в классе DemoRibbon.cs уже внесены изменения для удобного тестирования как при корректно Installed DemoVBA.xlam, так и просто при открытом DemoVBA.xlsm, – вызовом функции GetVbaFileName() в первый параметр Application.Run() подставляется либо DemoVBA.xlam! либо DemoVBA.xlsm!;. это не принципиально и на суть примера не влияет).

3) Выполняем Сборка -> Опубликовать DemoAddin, указываем расположение папки дистрибутива и способ установки на ПК пользователей – CD или DVD (имеется ввиду – из файлов дистрибутива, а не из внутреннего ресурса организации). В указанной папке будет создан файл setup.exe и прочие установочные файлы.

4) Копируем DemoVBA.xlam и папку дистрибутива на компьютер пользователя.

5) DemoVBA.xlam подключаем как обычно для xlam-надстроек – РАЗРАБОТЧИК -> Надстройки (не путать с Надстройки COM!). Закрываем Excel.

6) Устанавливаем VSTO-надстройку – это «трёх-щелчковое» действие, включая согласие с невозможностью проверить подпись издателя.

7) Запускаем Excel, проверяем. Если группа DemoGroup не появилась на вкладке НАДСТРОЙКИ, включаем DemoAddin в диалоге РАЗРАБОТЧИК -> Надстройки COM.

Файлы тестового примера доступны здесь yadi.sk/d/A5JuAxwg86XxVg
(примечание — если установка из дистрибутива будет выполняться на том же ПК, на котором производится тестирование из среды Visual Studio, то при тестовых запусках VS будет выдавать сообщение об ошибке — наличие некорректно установленной настройки. Для устранения этой ошибки недостаточно отключить и удалить VSTO-надстройку в диалоге РАЗРАБОТЧИК -> Надстройки COM. Её нужно удалить как обычное Windows-приложение — удаление в разделе «Программы и компоненты» панели управления).

Уточнения по видимости (доступности) VBA-процедур и функций (Public или Private)

Представленный в статье способ вызова VBA-макросов полностью поддерживает важную особенность метода Application.Run – так как вызов макроса производится «по полному имени макроса», то не важно, какая область видимости указана в объявлении процедуры или функции – Public или Private. Видимо, проектировщики VBA приняли решение о таком поведении, руководствуясь соображением «Если VBA-программист уверенно вызывает макрос по полному имени, представленному строкой, то не нужно проверять ограничения видимости, лишь бы имя было правильным; на этапе компиляции мы не сможем проверить корректность таких вызовов, потому что это строка-параметр метода, а не стандартный программный вызов».

Более того – на возможность такого вызова не повлияет и наличие директивы Option Private Module в заголовке VBA-модуля!

Попробуем максимально ограничить область видимости наших макросов – в Module1 в объявлениях процедуры и функции Public заменим на Private, и в заголовке модуля укажем Option Private Module. Сохраняем DemoVBA.xlsm, закрываем Excel и выполняем тестовый запуск из среды Visual Studio как описано выше. Всё работает.

Изящество такого архитектурного решения становится понятным, когда мы подумаем о VBA-функциях, возвращающих простые значения (строки, числа….) в качестве вычисляемых значений ячеек. Соответственно, при необходимости, такие функции должны быть доступны в качестве функций рабочего листа – в категории «Определенные пользователем» диалога вставки функций. Следовательно, для использования в Excel, они должны быть объявлены как Public, а все остальные VBA-функции – как Private – но это не означает, что их нельзя вызвать по полному имени, в качестве публичных!

Уточнение понятия «полное имя» макроса — в среде VBA поддерживается возможность при вызове указывать имя модуля перед именем макроса (разделяя точкой), что позволяет легко обойти проблему наличия в разных модулях одноименных макросов с одинаковой областью видимости.

Это правило работает и при использовании Application.Run – например, ExcelApp.Run(«DemoVBA.xlsm!Module1.МакросОдин»);.

Дополнительная информация по инструментам конструирования ленты

1) Описание использования Custom UI Editor for Microsoft Office приведено, в частности, в книге www.dialektika.com/books/978-5-9909446-3-3.html (стр. 649 бумажного издания книги) и здесь bettersolutions.com/vba/ribbon/custom-ui-editor.htm.

2) Еще один подход предлагает Ribbon Commander Framework For VBA / .NET / Delphi www.spreadsheet1.com/ribbon-commander.html – это уже другая история, т.к. предусматривает подключение в VBA-проекты внешней dll – см. documentation.ribboncommander.com/index.php?title=Referencing_the_Ribbon_Commander_library_in_VBA.

Beta Version Obs:

First Make a backup for test

Some times Excel hides the sheets. For fix that, just go to view menu and unhidden than.

Last Features

— Rebuild Treeview

— Click on the Macro List to Navigate in the Code

— Fix Goto definition on Hover

— Add Button for open Ms Office Applications

— Reduce extension size in 63%

— Add New Annotations for new features and make code more readable

— Now with: Immediate Window Simulate in VSCode Output Channel Xdebug

— Improve Load Macros from VSCode

— Add export files to Excel with Lines Numbers Tagged

— Add Change Formatter tab size

See CHANGELOG

Next Features

• Code Explorer
• Implement the TDD like PHPUnit
• Debug
• …

Support XVBA

If you find it useful, please consider supporting it for help me to create a FREE face-to-face SCHOOL
for programmers in the small town of Vargem Bonita Brazil and create more tools and improve the Youtube channel

For beginners it is difficult to learn programming through tutorials

• Become a Sponsor join the growing group of generous backers

The list below is some off new features vba language will have with XVBA

• 1 Edit VBA from Excel And Access files in VSCode www.xvba.dev
• 2 *Namespace (Organize files in folders)
• 3 Live Server (With error log)
• 4 Run Macros from VSCode TreeView (With error log)
• 5 Auto Complete (Language Serve, in progress)
• 6 Syntax Highlighting
• 7 Snippets (starts with x-)
• 8 Auto Indentation Rules
• 9 Create Your own package and share in www.xvba.dev
• 10 Stop the Live server and load VBA files to Excel Manually
• 11 XVBA-CLI Command Line Interface for XVBA VSCode extension (@localsmart/xvba-cli)
• 12 Code Formatter — Got to settings search for formatter and set to local-smart.excel-live-server
• 13 Create Custom Ribbons Menus with Custom Images — See example
• 14 Add Hover functionality
• 15 Add Go to Definition (Hold Ctr and Click on function/sub/param)
• 16 Add Build and Production functionality (Files on folder xvba_unit_test will export to Excel/Access just on Production Mode )
• 17 Immediate Window Simulate in VSCode Output Channel (Use Xdebug package) Xdebug
• 18 Add export files to Excel with Line Numbers Tagged
• 19 Create type definition files in «vb» for auto-complete and share in www.xvba.dev

System requirements:

• This extension was tested on Windows 10 and Office 2019
• This extension was not tested on Mac or Virtual Machines
• @localsmart/xvba-cli works on nodejs 12.18.4

Youtube

Youtube Chanel For Tutorials (Click Here)

• How to install — First Steps
• Namespace — Put File in Sub-folders
• Create Custom Ribbon Menu
• Use Production Mode or Build Mode
• How to Formatter Code With XVBA
• How to use Git With VBA
• Create Comment Block for VBA with XVBA
• Create Type Definition Files
• How to install node and use xvba-cli
• Use SQLite With VBA
• VBA Tutorials

In time, more Videos will came for Javascript/Typescript/React/Angular..

• Xvba Repository : www.xvba.dev
• Xvba-Cli : @localsmart/xvba-cli

Obs: The first comment block in the file is for modules/class namespace

'/*
'
'Comment block Example 
'
'*/
Public Sub main()
 
End Sub

• For use excel Objects auto-complete install the package excel-types with @localsmart/xvba-cli
  See excel-types package on github

Contributing

Please contributions are welcomed and appreciated.

• See excel-types
• In Time all code will be free

All feedback are welcome.

• Mail : alberto.aeraph@gmail.com
• WhatsApp: +55 31 9 9229 5626
• Also please write a review, star me on GitHub, and follow me on github
• Github account: Aeraphe

Installation

(Save your work and create a copy, before setting up the server)

• First, set your excel security to run macros on open

• Second, click in the Bootstrap icon on XVBA (TreeView)

• This command will create a user config file (config.json)
  In this file you set the name of your excel file (xlsm,xlsb or xlam) and
  the project root folder (Where your vba file will save)

{
  "app_name": "XVBA",
  "description": "",
  "author": "",
  "email": "",
  "create_ate": "",
  "excel_file": "index.xlsb",
  "vba_folder": "vba-files",
  "xvba_packages": [],
  "xvba_dev_packages": [],
}

Obs: vba_folder path are relative to workspace and can’t accept absolute path like : «c:xxxx»

• Now Import VBA files, click in the import icon on XVBA (TreeView) (if excel file has vba code)

XVBA Live Server

• Click on Button to run XVBA Live Server (For edit files in VSCode and auto update Excel file)
• If you don’t want to use Live Server just click on button «Load VBA on Excel» to save your code changes on Excel when you want.

Use Git to track changes on your code

• Go to vscode terminal and type de command: git init (Press enter)
• See on: https://git-scm.com/

Feature List

Import excel VBA code to files (With error log)

• XVBA will import and create files for edit in VSCode.
  Obs: XVBA only import modules/class’s/forms. Code inside sheets will not import
  Obs: modules name can not have accentuation

*Namespace

• Define the folder where your vba file (Class, Module,Form) will live
• For that, use the tag «namespace» no vba files like:

‘namespace=rootfolder/folder/subfolder

• You can use namespace snippet

• If you save VBA files changes in VSCode, it will automatically update your Excel file (like hot reload)

Obs: Import vba files button will stop Live Server

Code Navigate in TreeView and Open Office Application Button

• Right click on macros in treeview go to code

Run Macros from VSCode TreeView (With error log)

• Right click on macros on «LIST VBA MACROS» TreeView and select the option run
• The Macro will run on excel file
  Obs: Macros that receive params can not be run direct . Create a test file for that

• A Log file «excel_exec.log» wil create on workspace. Where you can see the
  success or error on run Macro

• To see Errors on VSCode, use On Error Resume Next on the first line of the VBA code
  Set the error source name Err.Source =»func»

  Function func()
  
     ' If an error occurs, pass error to VSCode
     On Error Resume Next    ' Defer error handling.
     'Set Error Source
     Err.Source="func"
  
  End Function
  

Auto Complete

• Use the auto-complete code by a Language Server (not snippets)

Syntax Highlighting

• This package provides syntax highlighting VBA.

Snippets

• All xvba snippets starts with x-

Example (Block Comment): x-blc

Dim declarations

Sub/function

Module/Class/Form Files

• if/else
• for/while
• case
• etc…

Auto Indentation Rules

• VBScript by Darfka (Auto Indentation Rules)

• Set *namespace for all your files to (sub-folder = your package name)

'namespace=xvba_modules/sub-folder

• Just commit your changes and push to git repository

git push

Stop the Live Server and load VBA files to Excel Manually

XVBA-CLI Command Line Interface for XVBA VSCode extension

• Add third packages to your project with command line interface
• Create Your own package and share xvba.dev
• Type on terminal and press enter for install the xvba-cli Last Version

 npm i @localsmart/xvba-cli@latest --save-dev

See

XVBA-CLI

Code formatter

• Code formatter Got to settings search for formatter and set to local-smart.excel-live-server
  For format code short keys (alt+shift + f)

• Immediate Window Simulate in VSCode Output Channel (Use Xdebug package) Xdebug

• On Error Handling :
  • To prevent error-handling code from running when no error has occurred, place an Exit Sub, Exit Function, or Exit Property
    statement immediately before the error-handling routine, as in the following fragment:

Add export files to Excel with Line Numbers Tagged

Code Annotations for new features and make code more readable:

• @ignore-comment (Ignore Comment to show on completion/hover functionality)
• @module-comment (Define the comment block for module «.bas» and «.frm» files)
• @class-comment (Define the comment block for module «.cls’ files)

Other Stuffs:)

Problems with file encoding

• If you are having problems with some especial characters you have to
  change the default encode utf8 in vscode to windows1252 in settings.
  VBA files a save in windows1252 encoding

• For that just pres (crtl + ,) and change the settings to:

  • «files.encoding»: «windows1252»
  • «files.autoGuessEncoding»:true

This package is built with this plugins:

• VBScript by Darfka (Auto Indentation Rules)
• luggage66/vscode-vbscript (Syntaxe Highlighting)

Versions Updates

• Move to CHANGELOG File

Bug Fix

• Move to CHANGELOG File

2 ответа