WritableSettingsStore.SetBoolean(String, String, Boolean) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Settings

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Updates the value of the specified property to the given Boolean value while setting its data type to Int32. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one.

public:
 abstract void SetBoolean(System::String ^ collectionPath, System::String ^ propertyName, bool value);

public:
 abstract void SetBoolean(Platform::String ^ collectionPath, Platform::String ^ propertyName, bool value);

 abstract void SetBoolean(std::wstring const & collectionPath, std::wstring const & propertyName, bool value);

public abstract void SetBoolean (string collectionPath, string propertyName, bool value);

abstract member SetBoolean : string * string * bool -> unit

Public MustOverride Sub SetBoolean (collectionPath As String, propertyName As String, value As Boolean)

Parameters

collectionPath: String

Path of the collection of the property.

propertyName: String

Name of the property.

value: Boolean

New value of the property.

Exceptions

ArgumentException

If the collection does not exist, this exception is thrown.

Remarks

If the previous data type of the property is different, it overwrites it.

If the property does not exist, it creates one.

Applies to