WritableSettingsStore WritableSettingsStore WritableSettingsStore WritableSettingsStore WritableSettingsStore WritableSettingsStore Class

Definition

Abstract class for both reading and writing the selected scope's collections and properties. It is obtained from SettingsManager.GetWritableSettingsStore method.

public ref class WritableSettingsStore abstract : Microsoft::VisualStudio::Settings::SettingsStore
[Windows::Foundation::Metadata::WebHostHidden]
public ref class WritableSettingsStore abstract : Microsoft::VisualStudio::Settings::SettingsStore
[Windows::Foundation::Metadata::WebHostHidden]
class WritableSettingsStore abstract : Microsoft::VisualStudio::Settings::SettingsStore
public abstract class WritableSettingsStore : Microsoft.VisualStudio.Settings.SettingsStore
type WritableSettingsStore = class
    inherit SettingsStore
Public MustInherit Class WritableSettingsStore
Inherits SettingsStore
Inheritance
WritableSettingsStoreWritableSettingsStoreWritableSettingsStoreWritableSettingsStoreWritableSettingsStoreWritableSettingsStore

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.

Constructors

WritableSettingsStore() WritableSettingsStore() WritableSettingsStore() WritableSettingsStore() WritableSettingsStore() WritableSettingsStore()

Initializes a new instance of WritableSettingsStore.

Methods

CollectionExists(String) CollectionExists(String) CollectionExists(String) CollectionExists(String) CollectionExists(String) CollectionExists(String)

Checks the existence of the collection passed in to this method.

(Inherited from SettingsStore)
CreateCollection(String) CreateCollection(String) CreateCollection(String) CreateCollection(String) CreateCollection(String) CreateCollection(String)

Creates the given collection path by creating each nested collection while skipping the ones that already exist.

DeleteCollection(String) DeleteCollection(String) DeleteCollection(String) DeleteCollection(String) DeleteCollection(String) DeleteCollection(String)

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(String, String) DeleteProperty(String, String) DeleteProperty(String, String) DeleteProperty(String, String) DeleteProperty(String, String) DeleteProperty(String, String)

Deletes the given property from the collection. If the property or the collection does not exist then the method returns false.

GetBoolean(String, String) GetBoolean(String, String) GetBoolean(String, String) GetBoolean(String, String) GetBoolean(String, String) 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) GetBoolean(String, String, Boolean) GetBoolean(String, String, Boolean) GetBoolean(String, String, Boolean) GetBoolean(String, String, Boolean) GetBoolean(String, String, Boolean)

Returns the value of the requested property whose data type is SettingsType.Int32 as boolean.

(Inherited from SettingsStore)
GetInt32(String, String) GetInt32(String, String) GetInt32(String, String) GetInt32(String, String) GetInt32(String, String) GetInt32(String, String)

Returns the value of the requested property whose data type is SettingsType.Int32.

(Inherited from SettingsStore)
GetInt32(String, String, Int32) GetInt32(String, String, Int32) GetInt32(String, String, Int32) GetInt32(String, String, Int32) GetInt32(String, String, Int32) GetInt32(String, String, Int32)

Returns the value of the requested property whose data type is SettingsType.Int32.

(Inherited from SettingsStore)
GetInt64(String, String) GetInt64(String, String) GetInt64(String, String) GetInt64(String, String) GetInt64(String, String) GetInt64(String, String)

Returns the value of the requested property whose data type is SettingsType.Int64.

(Inherited from SettingsStore)
GetInt64(String, String, Int64) GetInt64(String, String, Int64) GetInt64(String, String, Int64) GetInt64(String, String, Int64) GetInt64(String, String, Int64) GetInt64(String, String, Int64)

Returns the value of the requested property whose data type is SettingsType.Int64.

(Inherited from SettingsStore)
GetLastWriteTime(String) GetLastWriteTime(String) GetLastWriteTime(String) GetLastWriteTime(String) GetLastWriteTime(String) GetLastWriteTime(String)

Provides the last write time of the properties and sub-collections immediate to the given collection.

(Inherited from SettingsStore)
GetMemoryStream(String, String) GetMemoryStream(String, String) GetMemoryStream(String, String) GetMemoryStream(String, String) GetMemoryStream(String, String) GetMemoryStream(String, String)

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(String) GetPropertyCount(String) GetPropertyCount(String) GetPropertyCount(String) GetPropertyCount(String) GetPropertyCount(String)

Returns the number of properties under the given collection.

(Inherited from SettingsStore)
GetPropertyNames(String) GetPropertyNames(String) GetPropertyNames(String) GetPropertyNames(String) GetPropertyNames(String) GetPropertyNames(String)

Returns the names of properties under the given collection.

(Inherited from SettingsStore)
GetPropertyType(String, String) GetPropertyType(String, String) GetPropertyType(String, String) GetPropertyType(String, String) GetPropertyType(String, String) GetPropertyType(String, String)

Returns the type of the requested property.

(Inherited from SettingsStore)
GetString(String, String) GetString(String, String) GetString(String, String) GetString(String, String) GetString(String, String) GetString(String, String)

Returns the value of the requested property whose data type is SettingsType.String.

(Inherited from SettingsStore)
GetString(String, String, String) GetString(String, String, String) GetString(String, String, String) GetString(String, String, String) GetString(String, String, String) GetString(String, String, String)

Returns the value of the requested property whose data type is SettingsType.String.

(Inherited from SettingsStore)
GetSubCollectionCount(String) GetSubCollectionCount(String) GetSubCollectionCount(String) GetSubCollectionCount(String) GetSubCollectionCount(String) GetSubCollectionCount(String)

Returns the number of sub-collections under the given collection.

(Inherited from SettingsStore)
GetSubCollectionNames(String) GetSubCollectionNames(String) GetSubCollectionNames(String) GetSubCollectionNames(String) GetSubCollectionNames(String) GetSubCollectionNames(String)

Returns the names of sub-collections under the given collection.

(Inherited from SettingsStore)
GetUInt32(String, String) GetUInt32(String, String) GetUInt32(String, String) GetUInt32(String, String) GetUInt32(String, String) GetUInt32(String, String)

Returns the value of the requested property whose data type is SettingsType.Int32.

(Inherited from SettingsStore)
GetUInt32(String, String, UInt32) GetUInt32(String, String, UInt32) GetUInt32(String, String, UInt32) GetUInt32(String, String, UInt32) GetUInt32(String, String, UInt32) GetUInt32(String, String, UInt32)

Returns the value of the requested property whose data type is SettingsType.Int32.

(Inherited from SettingsStore)
GetUInt64(String, String) GetUInt64(String, String) GetUInt64(String, String) GetUInt64(String, String) GetUInt64(String, String) GetUInt64(String, String)

Returns the value of the requested property whose data type is SettingsType.Int64.

(Inherited from SettingsStore)
GetUInt64(String, String, UInt64) GetUInt64(String, String, UInt64) GetUInt64(String, String, UInt64) GetUInt64(String, String, UInt64) GetUInt64(String, String, UInt64) GetUInt64(String, String, UInt64)

Returns the value of the requested property whose data type is SettingsType.Int64.

(Inherited from SettingsStore)
PropertyExists(String, String) PropertyExists(String, String) PropertyExists(String, String) PropertyExists(String, String) PropertyExists(String, String) PropertyExists(String, String)

Checks the existance of the property passed in to this method.

(Inherited from SettingsStore)
SetBoolean(String, String, Boolean) SetBoolean(String, String, Boolean) SetBoolean(String, String, Boolean) SetBoolean(String, String, Boolean) SetBoolean(String, String, Boolean) SetBoolean(String, String, Boolean)

Updates the value of the specified property to the given Boolean value while setting its data type to SettingsType.Int32.

SetInt32(String, String, Int32) SetInt32(String, String, Int32) SetInt32(String, String, Int32) SetInt32(String, String, Int32) SetInt32(String, String, Int32) SetInt32(String, String, Int32)

Updates the value of the specified property to the given integer value while setting its data type to SettingsType.Int32.

SetInt64(String, String, Int64) SetInt64(String, String, Int64) SetInt64(String, String, Int64) SetInt64(String, String, Int64) SetInt64(String, String, Int64) SetInt64(String, String, Int64)

Updates the value of the specified property to the given long value while setting its data type to SettingsType.Int64.

SetMemoryStream(String, String, MemoryStream) SetMemoryStream(String, String, MemoryStream) SetMemoryStream(String, String, MemoryStream) SetMemoryStream(String, String, MemoryStream) SetMemoryStream(String, String, MemoryStream) SetMemoryStream(String, String, MemoryStream)

Updates the value of the specified property to the bits of the MemoryStream while setting its data type to SettingsType.Binary.

SetString(String, String, String) SetString(String, String, String) SetString(String, String, String) SetString(String, String, String) SetString(String, String, String) SetString(String, String, String)

Updates the value of the specified property to the given string value while setting its data type to SettingsType.String.

SetUInt32(String, String, UInt32) SetUInt32(String, String, UInt32) SetUInt32(String, String, UInt32) SetUInt32(String, String, UInt32) SetUInt32(String, String, UInt32) SetUInt32(String, String, UInt32)

Updates the value of the specified property to the given unsigned integer value while setting its data type to SettingsType.Int32.

SetUInt64(String, String, UInt64) SetUInt64(String, String, UInt64) SetUInt64(String, String, UInt64) SetUInt64(String, String, UInt64) SetUInt64(String, String, UInt64) SetUInt64(String, String, UInt64)

Updates the value of the specified property to the given unsigned long value while setting its data type to SettingsType.Int64.

Extension Methods

FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)
IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

Applies to