WritableSettingsStore Class
Abstract class for both reading and writing the selected scope's collections and properties. It is obtained from GetWritableSettingsStore method.
Inheritance Hierarchy
Object
Microsoft.VisualStudio.Settings.SettingsStore
Microsoft.VisualStudio.Settings.WritableSettingsStore
Namespace: Microsoft.VisualStudio.Settings
Assemblies: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Microsoft.VisualStudio.Settings (in Microsoft.VisualStudio.Settings.dll)
Syntax
'Declaration
Public MustInherit Class WritableSettingsStore _
Inherits SettingsStore
public abstract class WritableSettingsStore : SettingsStore
public ref class WritableSettingsStore abstract : public SettingsStore
[<AbstractClass>]
type WritableSettingsStore =
class
inherit SettingsStore
end
public abstract class WritableSettingsStore extends SettingsStore
The WritableSettingsStore type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
WritableSettingsStore | Initializes a new instance of WritableSettingsStore. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
CollectionExists | Checks the existence of the collection passed in to this method. (Inherited from SettingsStore.) |
|
CreateCollection | Creates the given collection path by creating each nested collection while skipping the ones that already exist. |
|
DeleteCollection | Deletes the given collection recursively deleting all of the sub-collections and properties in it. If the collection does not exist or an empty string ("") is passed then the method returns false. |
|
DeleteProperty | Deletes the given property from the collection. If the property or the collection does not exist then the method returns false. |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetBoolean(String, String) | Returns the value of the requested property whose data type is [!:SettingsType.Int32] as boolean. (Inherited from SettingsStore.) |
|
GetBoolean(String, String, Boolean) | Returns the value of the requested property whose data type is [!:SettingsType.Int32] as boolean. (Inherited from SettingsStore.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetInt32(String, String) | Returns the value of the requested property whose data type is [!:SettingsType.Int32]. (Inherited from SettingsStore.) |
|
GetInt32(String, String, Int32) | Returns the value of the requested property whose data type is [!:SettingsType.Int32]. (Inherited from SettingsStore.) |
|
GetInt64(String, String) | Returns the value of the requested property whose data type is [!:SettingsType.Int64]. (Inherited from SettingsStore.) |
|
GetInt64(String, String, Int64) | Returns the value of the requested property whose data type is [!:SettingsType.Int64]. (Inherited from SettingsStore.) |
|
GetLastWriteTime | Provides the last write time of the properties and sub-collections immediate to the given collection. (Inherited from SettingsStore.) |
|
GetMemoryStream | Returns the value of the requested property whose data type is [!:SettingsType.Binary]. In order to access the underlying byte array at once [!:MemoryStream.ToArray] method can be used. (Inherited from SettingsStore.) |
|
GetPropertyCount | Returns the number of properties under the given collection. (Inherited from SettingsStore.) |
|
GetPropertyNames | Returns the names of properties under the given collection. (Inherited from SettingsStore.) |
|
GetPropertyType | Returns the type of the requested property. (Inherited from SettingsStore.) |
|
GetString(String, String) | Returns the value of the requested property whose data type is [!:SettingsType.String]. (Inherited from SettingsStore.) |
|
GetString(String, String, String) | Returns the value of the requested property whose data type is [!:SettingsType.String]. (Inherited from SettingsStore.) |
|
GetSubCollectionCount | Returns the number of sub-collections under the given collection. (Inherited from SettingsStore.) |
|
GetSubCollectionNames | Returns the names of sub-collections under the given collection. (Inherited from SettingsStore.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetUInt32(String, String) | Returns the value of the requested property whose data type is [!:SettingsType.Int32]. (Inherited from SettingsStore.) |
|
GetUInt32(String, String, UInt32) | Returns the value of the requested property whose data type is [!:SettingsType.Int32]. (Inherited from SettingsStore.) |
|
GetUInt64(String, String) | Returns the value of the requested property whose data type is [!:SettingsType.Int64]. (Inherited from SettingsStore.) |
|
GetUInt64(String, String, UInt64) | Returns the value of the requested property whose data type is [!:SettingsType.Int64]. (Inherited from SettingsStore.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
PropertyExists | Checks the existance of the property passed in to this method. (Inherited from SettingsStore.) |
|
SetBoolean | Updates the value of the specified property to the given Boolean value while setting its data type to [!:SettingsType.Int32]. |
|
SetInt32 | Updates the value of the specified property to the given integer value while setting its data type to [!:SettingsType.Int32]. |
|
SetInt64 | Updates the value of the specified property to the given long value while setting its data type to [!:SettingsType.Int64]. |
|
SetMemoryStream | Updates the value of the specified property to the bits of the MemoryStream while setting its data type to [!:SettingsType.Binary]. |
|
SetString | Updates the value of the specified property to the given string value while setting its data type to [!:SettingsType.String]. |
|
SetUInt32 | Updates the value of the specified property to the given unsigned integer value while setting its data type to [!:SettingsType.Int32]. |
|
SetUInt64 | Updates the value of the specified property to the given unsigned long value while setting its data type to [!:SettingsType.Int64]. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
This class is derived from the SettingsStore hence it inherits all the functionalities from it. It adds property and collection manipulation abilities on top of it.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.