ProvideOptionPageAttribute Класс

Ссылка

Определение

Пространство имен:: Microsoft.VisualStudio.Shell

Сборка:: Microsoft.VisualStudio.Shell.14.0.dll

Сборка:: Microsoft.VisualStudio.Shell.15.0.dll

Пакет:: Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Важно!

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

Примените этот атрибут к независимым объектам, чтобы пользователи могли настраивать пакеты VSPackage с помощью настраиваемой страницы параметров инструментов.

public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideOptionPageAttribute : Microsoft.VisualStudio.Shell.ProvideOptionDialogPageAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideOptionPageAttribute = class
    inherit ProvideOptionDialogPageAttribute

Public NotInheritable Class ProvideOptionPageAttribute
Inherits ProvideOptionDialogPageAttribute

Наследование: Attribute

RegistrationAttribute

ProvideOptionDialogPageAttribute
ProvideOptionPageAttribute

Атрибуты: AttributeUsageAttribute

Примеры

В приведенном ниже примере экземпляр ProvideOptionPageAttribute применяется к реализации VSPackage для регистрации класса DesignerOptionsPage, который является производным от DialogPage, так как предоставляет VSPackage со страницей Параметры инструментов .

Классы, производные от DialogPage , предоставляются с реализацией по умолчанию функций параметров Visual Studio, которые можно переопределить. Интегрированная среда разработки использует эту поддержку параметров Visual Studio, если, как в примере, ProvideProfileAttribute применяется к реализации VSPackage. Дополнительные сведения о поддержке параметров Visual Studio см. в разделе Расширение параметров и параметров пользователя.

using Microsoft.VisualStudio.Shell;  
namespace Example  
{  
[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]   
[ProvideOptionPage(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1000, 1001, true)]   
[ProvideProfileAttribute(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1002, 1003, true)]  
[ProvideProfileAttribute(typeof(PersistCurrentDesign), "MyDesigner","CurrentDesign", 1004, 1005, false)]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
public class MyPackage : Package  
{  
//Implementation here  
}  

[Guid("YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY")]  
internal class DesignerOptionsPage: DialogPage {  
//Implementation here  
}  

[Guid("ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ")]  
internal class PersistCurrentDesign: IProfileManager {  
//Implementation here  
}

Примените к классам ProvideOptionPageAttribute , реализующим VSPackage. Этот атрибут позволяет зарегистрировать, что конкретный независимый объект предоставляет пользователям VSPackage доступ к конфигурации с помощью настраиваемой страницы параметров инструментов .

Контекст атрибута


Применяется к	Пакеты VSPackage позволяют выполнять настройку с помощью настраиваемых страниц параметров инструментов , реализованных с помощью платформы DialogPage управляемых пакетов или с помощью кода пакета SDK для Visual Studio.
Повторяемый	Да
Требуемые атрибуты	DefaultRegistryRootAttribute
Недопустимые атрибуты	None

Примечания для абонентов

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

Регистрирует ProvideOptionPageAttribute определенный класс, реализующий IProfileManager или DialogPage предоставляющий определенную поддержку VSPackage для сохранения части или всего состояния VSPackage с помощью механизма параметров Visual Studio. Сведения о состоянии, сохраняемые реализующим классом, называются категорией параметров Visual Studio, а ее определяющая запись в реестре называется пользовательской точкой параметров.

Примечание

При загрузке настраиваемой страницы параметров инструментов на основе Платформы управляемых пакетов интегрированная среда разработки создает экземпляр объекта, зарегистрированного как реализующий ProvideOptionPageAttribute его. Поддержка страницы "Параметры" средств управляемой платформы пакетов должна быть реализована в отдельном объекте, а не в самом пакете VSPackage.

Дополнительные сведения о создании и применении экземпляров см. в примерах ProvideOptionPageAttributeниже и ProvideOptionPageAttribute.

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

ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)	Создает экземпляр нового экземпляра ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)	Создает экземпляр нового экземпляра ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[])	Создает экземпляр нового экземпляра ProvideOptionPageAttribute.

Свойства

CategoryDescriptionResourceId	Идентификатор ресурса, содержащего локализованное описание родительской категории страницы. Это свойство используется только в том случае, если SupportsAutomation == true и SupportsProfiles == true. Локализованное описание отображается в мастере параметров импорта и экспорта.
CategoryName	Возвращает каноническое нелокализованное имя категории страницы Сервис Параметры.
CategoryPackageGuid	Идентификатор пакета, которому принадлежит категория, в которой зарегистрирована эта страница. Если этот параметр не задан, предполагается, что пакет является пакетом, к которому применяется этот атрибут. Это свойство используется только в том случае, если SupportsAutomation == true и SupportsProfiles == true. Создайте его на основе guid с guid.ToString("B").
CategoryResourceID	Возвращает идентификатор ресурса категории для страницы "Параметры инструментов".
DescriptionResourceId	Идентификатор ресурса, содержащего локализованное описание страницы. Это свойство используется только в том случае, если SupportsAutomation == true и SupportsProfiles == true. Локализованное описание отображается в мастере параметров импорта и экспорта.
IsInUnifiedSettings	Возвращает или задает значение, указывающее, были ли параметры на этой странице подключены к unified Settings путем создания новой регистрации. Если значение равно true, страница скрыта, если включена функция "Единые параметры", поэтому ее параметры не дублируются.
IsServerAware	Возвращает или задает значение, указывающее, отображаются ли в пользовательском интерфейсе этой страницы параметры, синхронизированные с сервером в сценарии подключенного клиента и сервера с помощью ISettingsManager3 или API с аналогичной функциональностью.
Keywords	Возвращает ключевые слова, доступные для поиска, для этой страницы параметров. Каждая ключевое слово может быть строкой литерала, именем или идентификатором ресурса (с префиксом "@"/"#"), указывающим на один ключевое слово, или именем или идентификатором ресурса (с префиксом "@"/"#"), указывающим на список ключевых слов, разделенный точкой с запятой.
NoShowAllView	Возвращает или задает значение, указывающее, отображаются ли страницы параметров агрегированных средств.
PageName	Возвращает каноническое нелокализованное имя страницы Параметры инструментов.
PageNameResourceId	Получает идентификатор ресурса имени страницы. (Унаследовано от ProvideOptionDialogPageAttribute)
PageType	Получает тип страницы. (Унаследовано от ProvideOptionDialogPageAttribute)
ProfileMigrationType	Задает тип миграции профиля.
ProvidesLocalizedCategoryName	Определяет, содержит ли пакет локализованные ресурсы для имени категории.
Sort	Порядок сортировки для страницы параметров. Страницы параметров сопоставляются в следующем порядке: `1. The General page 2. Pages with a Sort value, sorted from low to high. 3. Pages without a Sort value, sorted alphabetically.`
SupportsAutomation	Возвращает значение, указывающее, поддерживает ли реализация страницы Параметры средства автоматизацию.
SupportsProfiles	Возвращает или задает значение, указывающее, использует ли реализация страницы Сервис Параметры механизм параметров Visual Studio для сохранения своего состояния.
TypeId	Получает текущий экземпляр ProvideOptionPageAttribute.
UnifiedSettingsCategoryMoniker	Для страниц со значением IsInUnifiedSettings false возвращает или задает моникер родительской категории в иерархии Unified Settings. Это может быть моникер, который уже существует, или тот, который существует плюс один дополнительный "". сегмент с разделителями. В последнем случае в иерархии Unified Settings создается новая категория с именем CategoryResourceID by, в которую вставляется эта страница. В противном случае эта страница вставляется в существующую категорию.
VisibilityCmdUIContexts	Список guid UIContext с разделителями с запятой. Страница параметров отображается при активном интерфейсе UIContext в списке. Если этот параметр не указан, страница параметров всегда отображается.

Методы

GetPackageRegKeyPath(Guid)	Получает путь в реестре (относительно корня реестра приложения) VSPackage. (Унаследовано от RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Регистрирует страницу Параметры инструментов.
Unregister(RegistrationAttribute+RegistrationContext)	Удаляет раздел страницы Сервис Параметры из реестра.

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

Share via