Поделиться через


AsyncModelingPackage Класс

Определение

Важно!

Этот API несовместим с CLS.

Биты, связанные с панелью элементов

public ref class AsyncModelingPackage abstract : Microsoft::VisualStudio::Shell::AsyncPackage, IServiceProvider, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactory, Microsoft::VisualStudio::Shell::Interop::IVsToolWindowFactory
public ref class AsyncModelingPackage abstract : Microsoft::VisualStudio::Shell::AsyncPackage, IServiceProvider, Microsoft::VisualStudio::Modeling::Shell::IToolWindowProvider, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactory, Microsoft::VisualStudio::Shell::Interop::IVsToolWindowFactory
[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class AsyncModelingPackage : Microsoft.VisualStudio.Shell.AsyncPackage, IServiceProvider, Microsoft.VisualStudio.Shell.Interop.IVsAsyncToolWindowFactory, Microsoft.VisualStudio.Shell.Interop.IVsToolWindowFactory
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class AsyncModelingPackage : Microsoft.VisualStudio.Shell.AsyncPackage, IServiceProvider, Microsoft.VisualStudio.Modeling.Shell.IToolWindowProvider, Microsoft.VisualStudio.Shell.Interop.IVsAsyncToolWindowFactory, Microsoft.VisualStudio.Shell.Interop.IVsToolWindowFactory
[<System.CLSCompliant(false)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type AsyncModelingPackage = class
    inherit AsyncPackage
    interface IVsToolWindowFactory
    interface IVsAsyncToolWindowFactory
    interface IServiceProvider
[<System.Runtime.InteropServices.ComVisible(true)>]
type AsyncModelingPackage = class
    inherit AsyncPackage
    interface IVsToolWindowFactory
    interface IVsAsyncToolWindowFactory
    interface IServiceProvider
    interface IToolWindowProvider
Public MustInherit Class AsyncModelingPackage
Inherits AsyncPackage
Implements IServiceProvider, IVsAsyncToolWindowFactory, IVsToolWindowFactory
Public MustInherit Class AsyncModelingPackage
Inherits AsyncPackage
Implements IServiceProvider, IToolWindowProvider, IVsAsyncToolWindowFactory, IVsToolWindowFactory
Наследование
AsyncModelingPackage
Атрибуты
Реализации

Конструкторы

AsyncModelingPackage()

Биты, связанные с панелью элементов

Свойства

ApplicationRegistryRoot

Возвращает корневой раздел реестра текущего куста реестра Visual Studio.

(Унаследовано от Package)
DisposalToken

Предоставляет объект , CancellationToken который можно использовать для проверка, если пакет был удален. Это может произойти для асинхронных задач, выполняемых в фоновом потоке, когда Visual Studio начала работу. Используйте ShutdownToken для более раннего указания на завершение работы VS.

(Унаследовано от AsyncPackage)
JoinableTaskCollection

Возвращает коллекцию асинхронных задач, запущенных этим пакетом.

(Унаследовано от AsyncPackage)
JoinableTaskFactory

Возвращает фабрику, используемую для асинхронных задач, запущенных этим пакетом.

(Унаследовано от AsyncPackage)
Locator

Вспомогательное средство для поиска ссылок на элементы модели.

SetupMode

Биты, связанные с панелью элементов

UserDataPath

Возвращает путь к хранилищу пользовательских данных для Visual Studio.

(Унаследовано от Package)
UserLocalDataPath

Возвращает путь к хранилищу данных локального пользователя для Visual Studio.

(Унаследовано от Package)
UserRegistryRoot

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

(Унаследовано от Package)
Zombied

Получает значение, указывающее, находится ли пакет в процессе завершения работы.

(Унаследовано от Package)

Методы

AddOptionKey(String)

Добавляет имя ключа параметров пользователя в список ключей параметров.

(Унаследовано от Package)
AddOrReplaceToolboxItem(IToolboxService, ModelingToolboxItemBase)
Устаревшие..

Добавить элемент панели инструментов, если он отсутствует. Заменяет существующий элемент панели элементов, если он уже существует

AddService(Type, AsyncServiceCreatorCallback)

Добавляет в этот пакет асинхронную службу. Эта служба не будет отображаться за пределами этого пакета.

(Унаследовано от AsyncPackage)
AddService(Type, AsyncServiceCreatorCallback, Boolean)

Добавляет в этот пакет асинхронную службу. Эта служба может отображаться или не отображаться за пределами этого пакета в зависимости от значения promote.

(Унаследовано от AsyncPackage)
AddService(Type, AsyncServiceCreatorWithProgressCallback)

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

(Унаследовано от AsyncPackage)
AddService(Type, AsyncServiceCreatorWithProgressCallback, Boolean)

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

(Унаследовано от AsyncPackage)
AddToolboxItemsAsync(IEnumerable<ModelingToolboxItemBase>, CancellationToken)

Добавить передаваемую коллекцию элементов ModelingToolboxItemBase в панель элементов Visual Studio.

AddToolWindow(Type)

Сейчас мы предоставим базовую поддержку окна инструментов, чтобы узнать, работают ли вещи. Это должно быть сделано на базовом уровне пакета, аналогично предоставляемым службам.

CreateInstance(Guid, Guid, Type)

Создает указанный COM-объект с помощью объекта CLSID локального реестра Visual Studio.

(Унаследовано от Package)
CreateLocator()

Фабричный метод для создания экземпляра ModelElementLocator для этого пакета.

CreateTool(Guid)

Позволяет производным классам предоставлять реализацию, если это необходимо.

(Унаследовано от Package)
CreateToolboxItems()

При переопределении в производном классе возвращает список динамических или пользовательских элементов панели элементов, предоставляемых этим пакетом.

CreateToolWindow(Guid, Int32)

Создает окно инструментов заданного типа с указанным идентификатором.

(Унаследовано от Package)
CreateToolWindow(Guid, UInt32)

Create указанное окно инструментов.

CreateToolWindow(Guid, UInt32, Object)

Биты, связанные с панелью элементов

CreateToolWindow(Type, Int32)

Создает окно инструментов заданного типа с указанным идентификатором.

(Унаследовано от Package)
CreateToolWindow(Type, Int32, Object)

Create окно инструментов указанного типа с указанным идентификатором.

(Унаследовано от Package)
CreateToolWindow(Type, Int32, UInt32)

Создает окно инструментов заданного типа с указанным идентификатором.

(Унаследовано от Package)
CreateToolWindow(Type, Int32, UInt32, Object, Guid)

Create окно инструментов указанного типа с указанным идентификатором. Это единственный метод, который должен вызывать IVsUiShell.CreateToolWindow()

(Унаследовано от Package)
Dispose(Boolean)

Удаляет объект и связанный маркер отмены.

(Унаследовано от AsyncPackage)
FindToolWindow(Type, Int32, Boolean)

Получает окно инструментов, соответствующее указанному типу и идентификатору.

(Унаследовано от Package)
FindToolWindowAsync(Type, Int32, Boolean, CancellationToken)

Асинхронно находит окно инструментов, соответствующее указанному типу и идентификатору. Если он не существует, он создает и возвращает , если create имеет значение true, или возвращает значение NULL, если create имеет значение false.

(Унаследовано от AsyncPackage)
FindWindowPane(Type, Int32, Boolean)

Получает панель окна, соответствующую указанному типу и идентификатору, и если панели окна этого типа не существует, создает ее, если поступает такая команда.

(Унаследовано от Package)
FindWindowPaneAsync(Type, Int32, Boolean, CancellationToken)

Асинхронно находит область окна, соответствующую указанному типу и идентификатору. Если он не существует, он создает и возвращает , если create имеет значение true, или возвращает значение NULL, если create имеет значение false.

(Унаследовано от AsyncPackage)
GetAsyncToolWindowFactory(Guid)

Возвращает интерфейс фабрики асинхронного окна инструментов для окна инструментов, определяемого параметром toolWindowType, если для окна инструментов поддерживается асинхронное создание. Если асинхронное создание не поддерживается, возвращается значение NULL.

(Унаследовано от AsyncPackage)
GetAutomationObject(String)

Получает объект автоматизации для VSPackage.

(Унаследовано от Package)
GetDialogPage(Type)

Получает запрашиваемую страницу диалогового окна.

(Унаследовано от Package)
GetOutputPane(Guid, String)

Получает зарегистрированное окно вывода.

(Унаследовано от Package)
GetProviderLocale()

Возвращает языковой стандарт, связанный с этим поставщиком служб.

(Унаследовано от Package)
GetService(Type)

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

(Унаследовано от AsyncPackage)
GetServiceAsync(Type)

Извлекает асинхронную службу.

(Унаследовано от AsyncPackage)
GetServiceAsync(Type, Boolean)

Извлекает асинхронные службы, но позволяет вызывающей объекту указывать, что исключения, возможно, не нужно проглотить. Это не гарантирует, что исключения будут создаваться, однако для случаев сбоя.

(Унаследовано от AsyncPackage)
GetToolboxItemData(String, DataFormats+Format)

Получает содержимое формата данных для указанного идентификатора элемента панели элементов и формата данных.

(Унаследовано от Package)
GetToolboxItemDataAsync(String, DataFormats+Format)

Биты, связанные с панелью элементов

(Унаследовано от Package)
GetToolWindow(Type)

Возвращает экземпляр окна инструментов, соответствующий заданному типу. Мы поддерживаем только окна инструментов с одним экземпляром, поэтому это всегда будет сопоставление 1–1.

GetToolWindow(Type, Boolean)

Возвращает экземпляр окна инструментов, соответствующий заданному типу. Мы поддерживаем только окна инструментов с одним экземпляром, поэтому это всегда будет сопоставление 1–1.

GetToolWindowTitle(Type, Int32)

Возвращает строку заголовка, используемую для окна инструментов. Если возвращается значение NULL, для заголовка используется имя типа окна инструментов.

(Унаследовано от AsyncPackage)
Initialize()

Запечатайте этот метод. Из-за почти неизбежного риска взаимоблокировки SetSite (который называется Initialize) по-прежнему возникает в потоке пользовательского интерфейса даже для асинхронного пакета. Поскольку большинство авторов асинхронных пакетов логически предполагают, что инициализация выполняется в потоке b/g, они могут выполнять ресурсоемкие (синхронные) действия внутри своего переопределения, не допуская некоторые преимущества асинхронных загрузок. Чтобы помочь отвести их от этого, мы запечатаем его, и, таким образом, все, что они могут переопределить, это асинхронная инициализация, которая вызывается в потоке b/g.

(Унаследовано от AsyncPackage)
InitializeAsync(CancellationToken, IProgress<ServiceProgressData>)

Производные классы должны переопределять этот метод для выполнения работы с конкретным пакетом, например для регистрации фабрик редактора

InitializeToolWindowAsync(Type, Int32, CancellationToken)

Выполняет инициализацию при подготовке к созданию окна инструментов, определяемого параметром toolWindowType.

(Унаследовано от AsyncPackage)
InstantiateToolWindow(Type)

Биты, связанные с панелью элементов

(Унаследовано от Package)
InstantiateToolWindow(Type, Object)

Создайте окно инструментов указанного типа.

(Унаследовано от Package)
IsLocalService(Type)

Определяет, можно ли получить указанный тип службы без необходимости перехода RPC в поток пользовательского интерфейса.

(Унаследовано от Package)
OnAfterPackageLoadedAsync(CancellationToken)

При переопределении производным типом может инициировать операции с побочными эффектами, которые не являются строго частью загрузки пакета, которая будет принадлежать InitializeAsync(CancellationToken, IProgress<ServiceProgressData>) , но должна произойти вскоре после загрузки пакета (например, обновление состояния команды).

(Унаследовано от AsyncPackage)
OnLoadOptions(String, Stream)

Вызывается классом пакетов при наличии параметров, доступных для считывания из файла решения.

(Унаследовано от Package)
OnSaveOptions(String, Stream)

Вызывается классом Package при наличии параметров, которые необходимо сохранить в файле решения.

(Унаследовано от Package)
OnToolboxInitialized(Object, EventArgs)

Обработчик событий для события ToolboxInitialized Динамические/настраиваемые элементы панели инструментов будут перезарегистрирован.

OnToolboxUpgraded(Object, EventArgs)

Обработчик событий для события ToolboxUpgraded Динамические/настраиваемые элементы панели инструментов будут перезарегистрирован.

ParseToolboxResource(TextReader, Guid)

Анализирует внедренный текстовый ресурс соответствующего формата для получения сведений о том, какие элементы следует добавить на панель элементов.

(Унаследовано от Package)
ParseToolboxResource(TextReader, ResourceManager)

Анализирует внедренный текстовый ресурс соответствующего формата для получения сведений о том, какие элементы следует добавить на панель элементов.

(Унаследовано от Package)
QueryClose(Boolean)

Вызывается, чтобы запросить пакет о возможности закрытия оболочки.

(Унаследовано от Package)
RegisterEditorFactory(IVsEditorFactory)

Регистрирует фабрику редактора в Visual Studio.

(Унаследовано от Package)
RegisterProjectFactory(IVsProjectFactory)

Регистрирует фабрику проекта с помощью Visual Studio.

(Унаследовано от Package)
RemoveService(Type)

Удаляет асинхронную службу, зарегистрированную в этом пакете.

(Унаследовано от AsyncPackage)
RemoveService(Type, Boolean)

Удаляет асинхронную службу, зарегистрированную в этом пакете.

(Унаследовано от AsyncPackage)
SetupDynamicToolboxAsync(CancellationToken)

Добавляет динамические или пользовательские элементы панели элементов.

ShowOptionPage(Type)

Отображает указанную страницу настроек инструментов.

(Унаследовано от Package)
ShowToolWindowAsync(Type, Int32, Boolean, CancellationToken)

Асинхронно отображает окно инструментов, соответствующее указанному типу и идентификатору. Если он не существует, он создает и возвращает , если create имеет значение true, или возвращает значение NULL, если create имеет значение false.

(Унаследовано от AsyncPackage)

События

ToolboxInitialized

Событие создается всякий раз, когда Visual Studio инициализирует панель элементов.

(Унаследовано от Package)
ToolboxUpgraded

Событие создается при каждом обновлении панели элементов Visual Studio.

(Унаследовано от Package)

Явные реализации интерфейса

IAsyncLoadablePackageInitialize.Initialize(IAsyncServiceProvider, IProfferAsyncService, IAsyncProgressCallback)

Асинхронная версия SetSite, вызываемая из потока b/g.

(Унаследовано от AsyncPackage)
IAsyncLoadablePackageInitialize.Initialize(IAsyncServiceProvider, IProfferAsyncService, IAsyncProgressCallback)

Асинхронная версия SetSite, вызываемая из потока b/g.

(Унаследовано от AsyncPackage)
IAsyncServiceProvider.QueryServiceAsync(Guid)

Получите асинхронную службу инициализации, предлагаемую этим пакетом.

(Унаследовано от AsyncPackage)
IAsyncServiceProvider.QueryServiceAsync(Guid)

Получите асинхронную службу инициализации, предлагаемую этим пакетом.

(Унаследовано от AsyncPackage)
IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)

Выполняет указанную команду или отображает справку для команды.

(Унаследовано от Package)
IOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr)

Запрашивает объект о состоянии одной или нескольких команд, созданных событиями пользовательского интерфейса.

(Унаследовано от Package)
IServiceContainer.AddService(Type, Object)

Добавляет заданную службу в контейнер служб VSPackage.

(Унаследовано от Package)
IServiceContainer.AddService(Type, Object, Boolean)

Добавляет заданную службу в контейнер служб VSPackage.

(Унаследовано от Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback)

Добавляет заданную службу в контейнер служб VSPackage.

(Унаследовано от Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean)

Добавляет заданную службу в контейнер служб с использованием указанного объекта ServiceCreatorCallback.

(Унаследовано от Package)
IServiceContainer.RemoveService(Type)

Удаляет указанный тип службы из контейнера служб.

(Унаследовано от Package)
IServiceContainer.RemoveService(Type, Boolean)

Удаляет данный тип службы из контейнера служб и дополнительно распространяет службу удаление службы в родительские контейнеры служб.

(Унаследовано от Package)
IServiceProvider.GetService(Type)

Получает службу указанного типа.

(Унаследовано от Package)
IServiceProvider.QueryService(Guid, Guid, IntPtr)

Внутренняя реализация IServiceProvider.

(Унаследовано от Package)
IVsAsyncToolWindowFactory.CreateToolWindow(Guid, UInt32, Object)

Создает окно инструментов заданного типа с указанным идентификатором.

(Унаследовано от AsyncPackage)
IVsAsyncToolWindowFactory.GetToolWindowTitle(Guid, UInt32)

Возвращает строку заголовка, используемую для окна инструментов. Если возвращается значение NULL, для заголовка используется имя типа окна инструментов.

(Унаследовано от AsyncPackage)
IVsAsyncToolWindowFactory.InitializeToolWindowAsync(Guid, UInt32)

Выполняет инициализацию при подготовке к созданию окна инструментов, определяемого параметром toolWindowType.

(Унаследовано от AsyncPackage)
IVsPackage.Close()

Закрывает и удаляет пакет.

(Унаследовано от Package)
IVsPackage.GetAutomationObject(String, Object)

Получает понятный для автоматизации объект для данного пакета.

(Унаследовано от Package)
IVsPackage.GetPropertyPage(Guid, VSPROPSHEETPAGE[])

Открывает доступ к меню Сервис Параметры и страницам свойств диалогового окна Настройка панели элементов.

(Унаследовано от Package)
IVsPackage.QueryClose(Int32)

Вызывается, чтобы спросить VSPackage, можно ли закрыть оболочку Visual Studio.

(Унаследовано от Package)
IVsPackage.ResetDefaults(UInt32)

Сбрасывает значения по умолчанию Панели элементов.

(Унаследовано от Package)
IVsPackage.SetSite(IServiceProvider)

Инициализирует VSPackage в среде Visual Studio.

(Унаследовано от Package)
IVsPersistSolutionOpts.LoadUserOptions(IVsSolutionPersistence, UInt32)

Загружает параметры пользователя для данного решения.

(Унаследовано от Package)
IVsPersistSolutionOpts.ReadUserOptions(IStream, String)

Считывает параметры пользователя для данного решения.

(Унаследовано от Package)
IVsPersistSolutionOpts.SaveUserOptions(IVsSolutionPersistence)

Сохраняет параметры пользователя для данного решения.

(Унаследовано от Package)
IVsPersistSolutionOpts.WriteUserOptions(IStream, String)

Записывает параметры пользователя для данного решения.

(Унаследовано от Package)
IVsToolboxItemProvider.GetItemContent(String, UInt16, IntPtr)

Получает элемент.

(Унаследовано от Package)
IVsToolboxItemProvider2.GetItemContentAsync(String, UInt16)

Биты, связанные с панелью элементов

(Унаследовано от Package)
IVsToolWindowFactory.CreateToolWindow(Guid, UInt32)

Создает окно инструментов заданного типа с указанным идентификатором.

(Унаследовано от Package)
IVsUserSettings.ExportSettings(String, IVsSettingsWriter)

Этот метод реализует интерфейс IVsUserSettings, используемый для управления профилями и импорта/экспорта параметров в XML-файлы.

(Унаследовано от Package)
IVsUserSettings.ImportSettings(String, IVsSettingsReader, UInt32, Int32)

Извлекает конфигурацию VSPackage с помощью механизма параметров Visual Studio, когда пользователь выбирает параметр импорта параметров импорта и экспорта в меню Сервис интегрированной среды разработки. Этот метод является частью реализации интерфейса IVsUserSettings, используемого для управления профилями и импорта/экспорта параметров в XML-файлы.

(Унаследовано от Package)
IVsUserSettingsMigration.MigrateSettings(IVsSettingsReader, IVsSettingsWriter, String)

Переносит параметры из предыдущей версии.

(Унаследовано от Package)
IVsUserSettingsQuery.NeedExport(String, Int32)

Определяет, изменились ли параметры и следует ли их повторно экспортировать.

(Унаследовано от Package)

Методы расширения

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>)

Преобразовывает службу, реализованную указанным типом, в контейнер асинхронной службы. При первом creator запросе службы вызывается функция . Профильная служба будет повышена до родительского контейнера асинхронной службы.

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>, Boolean)

Преобразовывает службу, реализованную указанным типом, в контейнер асинхронной службы. При первом creator запросе службы вызывается функция .

ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>)

Преобразовывает службу, реализованную указанным типом, в контейнер асинхронной службы. При первом creator запросе службы вызывается функция . Профильная служба будет повышена до родительского контейнера асинхронной службы.

ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>, Boolean)

Преобразовывает службу, реализованную указанным типом, в контейнер асинхронной службы. При первом creator запросе службы вызывается функция .

QueryService(IServiceProvider, Guid)

Возвращает службу, предоставленную поставщиком услуг на основе его GUID службы.

QueryService<TService>(IServiceProvider)

Возвращает службу, предоставленную поставщиком услуг на основе его типа службы.

GetServiceAsync<TService,TInterface>(IAsyncServiceProvider)

Асинхронно получает интерфейс службы от поставщика служб.

GetServiceAsync<TService,TInterface>(IAsyncServiceProvider, Boolean)

Асинхронно получает интерфейс службы от поставщика служб.

Применяется к