SettingsStore Class

 

Abstract class for reading or enumerating the selected scope's collections and properties. It is obtained from M:SettingsManager.GetReadOnlySettingsStore method.

Namespace:   Microsoft.VisualStudio.Settings
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)


public abstract class SettingsStore

NameDescription
System_CAPS_protmethodSettingsStore()

Initializes a new instance of the SettingsStore.

NameDescription
System_CAPS_pubmethodCollectionExists(String)

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

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetBoolean(String, String)

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

System_CAPS_pubmethodGetBoolean(String, String, Boolean)

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

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetInt32(String, String)

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

System_CAPS_pubmethodGetInt32(String, String, Int32)

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

System_CAPS_pubmethodGetInt64(String, String)

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

System_CAPS_pubmethodGetInt64(String, String, Int64)

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

System_CAPS_pubmethodGetLastWriteTime(String)

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

System_CAPS_pubmethodGetMemoryStream(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.

System_CAPS_pubmethodGetPropertyCount(String)

Returns the number of properties under the given collection.

System_CAPS_pubmethodGetPropertyNames(String)

Returns the names of properties under the given collection.

System_CAPS_pubmethodGetPropertyType(String, String)

Returns the type of the requested property.

System_CAPS_pubmethodGetString(String, String)

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

System_CAPS_pubmethodGetString(String, String, String)

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

System_CAPS_pubmethodGetSubCollectionCount(String)

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

System_CAPS_pubmethodGetSubCollectionNames(String)

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

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGetUInt32(String, String)

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

System_CAPS_pubmethodGetUInt32(String, String, UInt32)

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

System_CAPS_pubmethodGetUInt64(String, String)

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

System_CAPS_pubmethodGetUInt64(String, String, UInt64)

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

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodPropertyExists(String, String)

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

In the methods of this class, if the collection path is provided as the empty string (""), then it denotes the top level collection. If the property name is empty string, then it denotes the default property of the collection.

Collections can contain properties and sub-collections. Sub-collections paths are described with the separators like directories in the file system. Likewise, the separator is '\' (back-slash) character.

Example of a sub-collection path would be: "Root Collection\Internal Collection\Leaf Collection".

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: