Установка самописных компонентов (part I)

[violet_tape]

После того, как вы сделали собственные визуальные компоненты, я думаю, вы захотите их использовать в различных проектах, а впоследствии и поделится с миром наработками. Как их установить на панель инструментов в студии, как добавить эту библиотеку в “Add reference…” диалог и как избежать подводных камней в этом деле - все это будет описано в этой статье.
Подготовка сборки (assembly)

Когда у вас есть проект с настроенными компонентами и вы чувствуете что они выглядят и работают точно так как вам хочется - вы, возможно, захотите автоматизировать процесс установки. Для этого потребуется:

1. Подписать сборку;


2. Установить сборку в GAC;


3. Добавить в “Add reference…” диалог;


4. Добавить в панель инструментов студии.

Далее я расскажу как автоматизировать почти все пункты из этого списка, в небольших примерах. Для дальнейшего повествования буду исходить их предположения, что библиотека с компонентами зовется myCustomControl.dll.

Вообще, подписать сборку более чем легко. Вызываете контекстное меню для проекта, выбираете пункт Properties. Далее выбираем закладку Signing. Ставим галочку напротив “Sign the assembly” и выпадающий список будет доступен для редактирования.




Выбираем пункт “”, заполняем поля в появившемся окне и жмем OK. Пересобираем приложение. Вот и все. Только что создали подпись (strong key) для сборки.

Следующим шагом будет…

Читать далее на Violet Tape без делений на части или здесь мелкими частями, потому что ЖЖ ниасилил столько кода для подсветки за раз
Добавление в GAC
Думаю, что более подходящим способом будет использование утилиты gacutil.exe. Ее можно вызвать из Visual Studio Command Prompt следующим образом:

gacutil /i “c:\my controls\myCustomControl.dll”

Незабываем, что путь надо писать в кавычках, если он содержит пробелы. Эта операция добавит сборку в GAC. В нашем случае, в программе я использую ключ /if (install force) для того, чтобы переписать сборку, если она уже есть. Код ниже, автоматизирует вызов утилиты:

Gacutil распространяется с .NET SDK. Для версии 3.5 путь C:\Program Files\Microsoft SDKs\Windows\v6.0A\Bin\gacutil.exe; 4.0 - C:\Program Files\Microsoft SDKs\Windows\v7.0A\Bin\gacutil.exe. Принимая во внимание только что сказанное:

copy to clipboardподсветка кода

1. public class InstallToGac {  
2.     public void Install(string fullAssemblyLocation) {  
3.         var net35 = @"C:\Program Files\Microsoft SDKs\Windows\v6.0A\Bin\gacutil.exe";  
4.         var net40 = @"C:\Program Files\Microsoft SDKs\Windows\v7.0A\Bin\gacutil.exe";  
5.         var value = File.Exists(net35)  
6.                               ? net35  
7.                               : File.Exists(net40)  
8.                                     ? net40  
9.                                     : "";  
10.         if (value == "") return;  
11.         var process = new Process();  
12.   
13.         process.StartInfo.FileName = value;  
14.         process.StartInfo.Arguments = string.Format("/if \"{0}\"", fullAssemblyLocation);  
15.         process.StartInfo.CreateNoWindow = true;  
16.         process.Start();  
17.         process.WaitForExit();  
18.     }  
19. }  

В процессе выполнения может мелькнуть окно консоли и все. Сборка в GAC. Для того, чтобы удалить вашу библиотеку из GAC, надо выполнить команду с ключом “/u” и добавить “f” если надо эту операцию сделать принудительно.
Добавление в диалог “Add reference…” в Visual Studio

Большинство моих коллег думают, что достаточно добавить библиотеку в GAC, как она тут же появится в вышеозначенном окне. К сожалению это не так, добавление в GAC это лишь один из шагов. Необходимо добавить еще ключ в реестре.

Цель:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders.

По этому пути надо создать ключ с точно таким же именем, как и библиотека, но без dll. После всех действий должно получится как на картинке:




Теперь, как это провернуть с помощью кода:

copy to clipboardподсветка кода

1. public class InstallToRefLibrary {    
2.      public void Install(string assemblyLocation, string dllName) {    
3.          var libRegPath = @"SOFTWARE\Microsoft\.NETFramework\AssemblyFolders";  
4.          libRegPath = string.Format("{0}\\{1}", libRegPath, dllName);  
5.   
6.          var registryKey = Registry.LocalMachine.OpenSubKey(libRegPath, true) ??  
7.                                Registry.LocalMachine.CreateSubKey(libRegPath);  
8.   
9.          registryKey.SetValue("", assemblyLocation);  
10.          registryKey.Close();  
11.      }  
12. }  

Для удаления - просто сотрите ключ из реестра.
Добавление в панель инструментов Visual Studio
Самые странные и уму непостижимые вещи начинаются здесь. Большинство из них из-за COM прошлого студии, некоторые появляются без вообще какого бы то ни было логического объяснения. Ну ладно, начнем с дурацких ограничений, которые могут всплыть.

• Если у вас стоит AnkhSVN, то это может привести к СОМ ошибкам. Я пробовал создавать закладки для панели инструментов на Win7 (7100) и получал ошибку, пока не снес этот плагин для студии. Под ХР все работает отлично даже с AnkhSVN. Описанную проблему можно найти на форуме Infragistics - у них та же проблема с AnkhSVN; и на собственном форуме этого плагина, но без описания почему это происходит и есть ли какое-нибудь лекарство. Так что помните об этом.


• Новая закладка с компонентами может быть установлена только тогда, когда WinForm проект существует в текущем открытом солюшене. Иначе только пустая закладка появится. К счастью, это легко обходится программным путем и я покажу как это сделать.

Перед началом написания кода необходимо добавить проектные ссылки на:

• EnvDTE;


• EnvDTE80;


• EnvDTE90.

От винта!
Установка при запущенной студии
В целом, при запущенной студии, достаточно легко работать. Для этого случая я буду предполагать, что солюшен с WinForm проектом все же существует и загружен. Ну или зачем тогда устанавливать визуальные компоненты? ;)

Первым делом надо определиться с тем, что мы будем устанавливать в новую панель, и новую панель тоже надо как-то идентифицировать. Для этой задачи создадим класс-помощник VSControl. Этот класс будет содержать информацию об имени новой панели, пути к сборке, типе компонента. Так же нам потребуется 2 конструктора: один для панели,

copy to clipboardподсветка кода

1. public VSControl(string tabGroupName) {  
2.     Control = null;  
3.     AssemblyPath = "";  
4.     TabName = tabGroupName;  
5.     IsToolBoxTab = true;  
6. }  

и второй для элементов на нем. Выглядит сложновато, но конечная цель - более легкий код в дальнейшем. Я думаю что тут можно избавиться от assemblyPath и использовать взамен assembly.Location.

copy to clipboardподсветка кода

1. public VSControl(Assembly assembly, string assemblyPath, string typeName, string tabName) {  
2.     var fullname = assembly.FullName.Split(new[] { ',' })[0];  
3.     Control = assembly.GetType(fullname + "." + typeName);  
4.     AssemblyPath = assemblyPath;  
5.     TabName = tabName;  
6.     IsToolBoxTab = false;  
7. }  

Следующие действия:

1. Получить ссылку на VS;


2. Получить ссылку на панель инструментов;


3. Создать новую панель;


4. Создать набор компонентов.

Все эти действия, на мой взгляд, лучше всего собрать под крышей одного класса DevEnvironment. Этот класс будет иметь только один публичный метод, к примеру, RegisterControls, который будет принимать в качестве параметров массив компонентов и номер версии студии.

copy to clipboardподсветка кода

1. public class DevEnvironment {  
2.     public static bool RegisterControls(string dteVersion, params VSControl[] controls) { … }  
3. }  

В деталях это все будет:

Читать полностью Violet Tape или часть II