Partager via


Microsoft.VisualStudio.Settings Espace de noms

Classes

CrossProcessMutexFactory
ExternalSettingsManager

Une implémentation de la classe SettingsManager qui permet aux applications d'accéder aux paramètres à partir de Visual Studio ou d'un shell isolé, l'un ou l'autre étant sélectionné par son AppID.

IdleStateChangedEventArgs

Arguments pour une modification de l’état d’inactivité de l’application.

ListMerger

Gère les opérations de fusion pour la définition de collections.

NamedVersionedString

Valeur de paramètre sérialisée sous la forme d’une chaîne avec un nom, une version et un indicateur local de machine associés.

SerializedSetting
ServiceHubPubSubTopic
ServiceUploadParameters
ServiceUploadResult
SettingNameTooLongException

Cette exception est levée à partir de lors de la tentative de ISettingsManager création d’un paramètre dont le nom dépasse la limite de longueur imposée par le serveur de paramètres itinérants (actuellement 128 caractères).

SettingsEventArgs

Arguments d’événement pour un événement de paramètres.

SettingsListChangedEventArgs

EventArgs décrivant une modification apportée à un ISettingsList.

SettingsManager

Il s’agit de la classe de passerelle à atteindre pour les paramètres stockés dans Visual Studio. Il fournit deux fonctionnalités de base. Il permet de rechercher des propriétés et des collections à l’intérieur des étendues. Il remet les SettingsStore classes et WritableSettingsStore pour une manipulation ultérieure des collections et des propriétés dans les étendues.

SettingsManagerFactory

Classe de fabrique qui construit un ISettingsManager.

SettingsStore

Classe abstraite pour la lecture/l’énumération des collections et propriétés de l’étendue sélectionnée. Elle est obtenue à partir de la méthode GetReadOnlySettingsStore(SettingsScope).

Dans les méthodes de cette classe, si le chemin d’accès à la collection est fourni en tant que chaîne vide («  »), il désigne la collection de niveau supérieur. Si le nom de la propriété est une chaîne vide, il indique la propriété par défaut de la collection.

Les collections peuvent contenir des propriétés et des sous-collections. Les chemins de sous-collections sont décrits avec les séparateurs tels que les répertoires dans le système de fichiers. De même, le séparateur est un caractère « » (barre oblique inverse). Exemple de chemin d’accès de sous-collection : « Root Collection\Internal Collection\Leaf Collection ».

SettingTooLargeException

Cette exception est levée (à partir de ISettingsManager, ISettingsList, etc.) lorsqu’une valeur de paramètre est donnée dont la représentation sérialisée dépasse la limite de taille sur le serveur de paramètres d’itinérance (actuellement 1 Mo).

StoreLogPropertyDefinition

Méthode non générique pour faire référence à un StoreLogPropertyDefinition<T>, ainsi qu’à l’emplacement où les propriétés connues sont définies.

StoreLogPropertyDefinition<T>

Propriété de journal de magasin sans valeur affectée.

StoreLogPropertyInstance

Méthode non générique pour faire référence à un StoreLogPropertyInstance<T>.

StoreLogPropertyInstance<T>

Propriété de journal de magasin avec une valeur spécifique.

StringWithMachineLocalFlag

Valeur de paramètre sérialisée sous la forme d’une chaîne avec un indicateur indiquant si la valeur contient du contenu local de l’ordinateur.

VersionedString

Valeur de paramètre sérialisée sous forme de chaîne, ainsi qu’une version associée et un indicateur local de machine.

WritableSettingsStore

Classe abstraite pour la lecture et l'écriture des collections et propriétés de la portée sélectionnée. Elle est obtenue à partir de la méthode GetWritableSettingsStore(SettingsScope).

Cette classe est dérivée de SettingsStore et hérite donc de toutes les fonctionnalités de celui-ci. Il ajoute des capacités de manipulation de propriété et de collection.

Interfaces

IAsyncStringStorage

Stocke et récupère les chaînes. Utilisé comme abstraction sur le service de paramètres dans le hub et les simulations de test unitaire.

ICrossProcessLockFactory
IInteropLogger
IListMerger

Gère les opérations de fusion pour la définition de collections.

IRemoteDefaultsStore
ISettingNameTranslator

Traduit entre les noms privés et les noms partagés. Cela permet à une application d’isoler ses paramètres des autres applications en insérant un préfixe ou un suffixe.

ISettingsChangeSuppressor

Autorise le blocage temporaire des modifications apportées aux paramètres qui ont été modifiés depuis une certaine version.

ISettingsList

Collection de paramètres. La collection est triée, mais le serveur est indépendant de l’ordre. Les éléments peuvent être ajoutés uniquement à l’avant, mais supprimés de n’importe où. La collection est conservée par le serveur dans l’ordre dans lequel elle a été créée. Les clés sont traitées comme ne respectant pas la casse.

ISettingsManager

Stocke et récupère les paramètres, ainsi que la gestion de la synchronisation entre les applications et les machines.

ISettingsManager2
ISettingsManager4
ISettingsManagerHost

Fonctionnalité fournie par l’application qui crée un ISettingsManager via CreateInstance(ISettingsManagerHost).

ISettingsManagerHost2
ISettingsManagerHost3
ISettingsManagerHost4
ISettingsManagerHost5
ISettingsService

API publique présentée par le module de service. Les implémenteurs doivent s’attendre à ce qu’une instance distincte soit créée pour (au moins) chaque client ou (au maximum) chaque requête du client.

ISettingsSubset

Sous-ensemble de paramètres (un seul paramètre ou tous les paramètres correspondant à un modèle générique) pour lesquels vous pouvez vous abonner à des événements de modification.

IStoreUpdateLogger

Un enregistreur d’événements pour les paramètres stocke les enregistrements de mise à jour.

IStoreUpdateLoggerWithAmbientContext

Ajoute un contexte ambiant à un IStoreUpdateLogger. Le contexte ambiant est implémenté via la SetContext(StoreLogPropertyInstance[]) méthode , qui permet à l’appelant de fournir des propriétés qui seront définies sur tous les événements émis dans le contexte d’exécution actuel jusqu’à ce que le retourné IDisposable soit supprimé.

IStringStorage

Stocke et récupère les chaînes. Utilisé comme abstraction sur le Registre et les simulations de test unitaire.

IStringStorage2

Énumérations

ApplicationDataFolder

Cette énumération est utilisée pour spécifier le dossier que Visual Studio utilise pour stocker différents fichiers, tels que des fichiers cache, des fichiers de sauvegarde ou des fichiers modèles.

EnclosingScopes

Cette énumération est retournée à la suite d’un appel d’interrogation aux méthodes GetPropertyScope ou GetCollectionScope de la classe SettingsManager pour découvrir les étendues englobantes de la propriété ou de la collection fournie. Il s’agit d’une énumération d’indicateurs, ce qui signifie qu’il est possible que plusieurs indicateurs d’énumération soient définis pour les étendues correspondantes.

GetValueResult

Résultat d’une opération pour récupérer une valeur à partir du magasin de paramètres.

ServiceUploadResultKind
SettingsEvent

Événement de paramètres qui peut être déclenché par le service de paramètres.

SettingsListOperation

Opération effectuée sur un ISettingsList.

SettingsScope

Cette énumération est utilisée pour spécifier la portée des paramètres qui est extraite de la classe SettingsManager.

SettingsType

Types de données des propriétés qui sont stockées dans les collections.

Délégués

AsyncEventHandler

Gestionnaire pour les événements asynchrones qui retourne un Task

CharSpanProcessorDelegate

Traite une étendue de caractères.

CollectionChangedAsyncEventHandler

Gestionnaire des modifications apportées à un ISettingsList qui retourne un Task afin qu’il puisse être asynchrone.

LockedStorageCreatorDelegate<T>

Délégué qui crée un objet stoage, utilisé par le constructeur de la fabrique de stockage.

NonLockedStorageCreatorDelegate<T>

Délégué qui crée un objet de stockage, utilisé par le constructeur de la fabrique de stockage.

PropertyChangedAsyncEventHandler

Un gestionnaire d’événements similaire à PropertyChangedEventHandler celui-ci retourne un Task de sorte que le gestionnaire puisse être asynchrone.

StoreUpdatedEventHandler

Gestionnaire des événements déclenchés par StoreUpdated qui retourne un Task pour qu’il puisse être asynchrone.