ApplicationDataCompositeValue
ApplicationDataCompositeValue
ApplicationDataCompositeValue
ApplicationDataCompositeValue
ApplicationDataCompositeValue
Class
Definition
Represents related app settings that must be serialized and deserialized atomically.
public : sealed class ApplicationDataCompositeValue : IPropertySet
struct winrt::Windows::Storage::ApplicationDataCompositeValue : IPropertySet
public sealed class ApplicationDataCompositeValue : IPropertySet
Public NotInheritable Class ApplicationDataCompositeValue Implements IPropertySet
var applicationDataCompositeValue = new applicationDataCompositeValue();
- Attributes
Windows 10 requirements
Device family |
Windows 10 (introduced v10.0.10240.0)
|
API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Examples
This example creates and reads a composite setting named exampleCompositeSetting
.
Call the Remove method to delete the exampleCompositeSetting
setting when you have finished with it.
Windows.Storage.ApplicationDataContainer localSettings = Windows.Storage.ApplicationData.Current.LocalSettings;
// Create a composite setting
Windows.Storage.ApplicationDataCompositeValue composite = new Windows.Storage.ApplicationDataCompositeValue();
composite["intVal"] = 1;
composite["strVal"] = "string";
localSettings.Values["exampleCompositeSetting"] = composite;
// Read data from a composite setting
Windows.Storage.ApplicationDataCompositeValue composite =
(Windows.Storage.ApplicationDataCompositeValue)localSettings.Values["exampleCompositeSetting"];
if (composite == null)
{
// No data
}
else
{
// Access data in composite["intVal"] and composite["strVal"]
}
// Delete a composite setting
localSettings.Values.Remove("exampleCompositeSetting");
Windows::Storage::ApplicationDataContainer localSettings{
Windows::Storage::ApplicationData::Current().LocalSettings() };
auto values{ localSettings.Values() };
{
// Create a composite setting.
Windows::Storage::ApplicationDataCompositeValue composite;
composite.Insert(L"intVal", Windows::Foundation::PropertyValue::CreateInt32(1));
composite.Insert(L"strVal", Windows::Foundation::PropertyValue::CreateString(L"string"));
values.Insert(L"exampleCompositeSetting", composite);
}
{
// Read data from a composite setting.
Windows::Storage::ApplicationDataCompositeValue composite{ values.Lookup(L"exampleCompositeSetting").as<Windows::Storage::ApplicationDataCompositeValue>() };
if (composite == nullptr)
{
// No data
}
else
{
int32_t one{ winrt::unbox_value<int32_t>(composite.Lookup(L"intVal")) };
winrt::hstring hello{ winrt::unbox_value<winrt::hstring>(composite.Lookup(L"strVal")) };
}
}
// Delete a composite setting.
values.Remove(L"exampleCompositeSetting");
ApplicationDataContainer^ localSettings = ApplicationData::Current->LocalSettings;
// Create a composite setting
ApplicationDataCompositeValue^ composite = ref new ApplicationDataCompositeValue();
composite->Insert("intVal", dynamic_cast<PropertyValue^>(PropertyValue::CreateInt32(1)));
composite->Insert("strVal", dynamic_cast<PropertyValue^>(PropertyValue::CreateString("string")));
auto values = localSettings->Values;
values->Insert("exampleCompositeSetting", composite);
// Read data from a composite setting
composite = safe_cast<ApplicationDataCompositeValue^>(localSettings->Values->Lookup("exampleCompositeSetting"));
if (composite == nullptr)
{
// No data
}
else
{
int one = safe_cast<IPropertyValue^>(composite->Lookup("intVal"))->GetInt32();
String^ hello = safe_cast<String^>(composite->Lookup("strVal"));
}
// Delete a composite setting
values->Remove("exampleCompositeSetting");
var applicationData = Windows.Storage.ApplicationData.current;
var localSettings = applicationData.localSettings;
// Create a composite setting
var composite = new Windows.Storage.ApplicationDataCompositeValue();
composite["intVal"] = 1;
composite["strVal"] = "string";
localSettings.values["exampleCompositeSetting"] = composite;
// Read data from a composite setting
var composite = localSettings.values["exampleCompositeSetting"];
if (!composite)
{
// No data
}
else
{
// Access data in composite["intVal"] and composite["strVal"]
}
// Delete a composite setting
localSettings.values.remove("exampleCompositeSetting");
Dim localSettings As Windows.Storage.ApplicationDataContainer = Windows.Storage.ApplicationData.Current.LocalSettings
' Create a composite setting
Dim composite As New Windows.Storage.ApplicationDataCompositeValue
composite("intVal") = 1
composite("strVal") = "string";
localSettings.Values("exampleCompositeSetting") = composite
' Read data from a composite setting
Dim composite As Windows.Storage.ApplicationDataCompositeValue =
CType(localSettings.Values("exampleCompositeSetting"), Windows.Storage.ApplicationDataCompositeValue)
If composite Is Nothing Then
' No data
Else
' Access data in composite("intVal") and composite("strVal")
End If
' Delete a composite setting
localSettings.Values.Remove("exampleCompositeSetting")
Remarks
A composite setting is serialized by inserting it into a settings map and deserialized by looking it up from the map.
Collection member lists
For JavaScript, ApplicationDataCompositeValue supports using an index to access items.
Constructors
ApplicationDataCompositeValue() ApplicationDataCompositeValue() ApplicationDataCompositeValue() ApplicationDataCompositeValue() ApplicationDataCompositeValue() |
Creates and initializes a new, initially empty, instance of the object. |
Properties
Size Size Size Size Size |
Gets the number of related application settings. |
Methods
Clear() Clear() Clear() Clear() Clear() |
Removes all application settings previously inserted into the composite value object, returning the object to its empty state. |
First() First() First() First() First() |
Retrieves an iterator to enumerate the settings in the composite value. |
GetView() GetView() GetView() GetView() GetView() |
Returns a read-only snapshot of the contents of the composite value. |
HasKey(String) HasKey(String) HasKey(String) HasKey(String) HasKey(String) |
Determines whether there is an application setting with the specified key. |
Insert(String, Object) Insert(String, Object) Insert(String, Object) Insert(String, Object) Insert(String, Object) |
Creates or replaces an application setting. |
Lookup(String) Lookup(String) Lookup(String) Lookup(String) Lookup(String) |
Retrieves the specified application setting. |
Remove(String) Remove(String) Remove(String) Remove(String) Remove(String) |
Removes the value with the specified key. |
Events
MapChanged MapChanged MapChanged MapChanged MapChanged |
Occurs when the map changes. |
See also
- Quickstart: Local application data (JavaScript)
- Store and retrieve settings and other app data
- Quickstart: Roaming application data (JavaScript)
- Store and retrieve settings and other app data
- Store and retrieve settings and other app data
- ApplicationData
- ApplicationDataContainer
- ApplicationDataContainerSettings
- Application data sample
- Application data sample (Windows 10)
Feedback
Loading feedback...