Dim memoryStream As MemoryStream =
PersistenceManager.Save(xamTileManager1)
This topic explains how to save the xamTileManager™’s layout and later restore it using the Infragistics® Control Persistence Framework. Saving the layout using the framework allows the user to not have to reconfigure the application layout for each session.
The following table lists the prerequisites required for this topic:
The xamTileManager allows users to fully configure the layout by enabling moving and resizing of tiles and the ability to change the state of tiles at run time. Users may expect you to save and load their custom layouts between sessions so they are not forced to reconfigure the xamTileManager every time the application restarts. Infragistics Control Persistence Framework allows you to save and load the tile layout for the xamTileManager.
In order to save a tile’s state information in a layout, you must name the tile or set xamTileManager’s attached property SerializationId to a unique string value. If you set both the Name and the SerializationId property, the SerializationId property takes precedence. The xamTileManager offers several different ways to set a tile’s serialization ID.
You can set the attached SerializationId property exposed by xamTileManager. You can use this approach when you manually add items derived from the DependencyObject class to xamTileManager’s Items collection.
You can set xamTileManager’s SerializationIdPath property to the name of a property exposed by your data items. You can use this approach when you bind xamTileManager to data to create your tiles.
You can handle the SavingItemMapping event and set the SavingItemMappingEventArgs object’s SerializationId property. If you handle the SavingItemMapping event, you must also handle the LoadingItemMapping event to map the serialization ID to a specific item.
If you name a tile or supply a serialization ID but you do not want to save the tile, you can set its SaveInLayout property to False.
The table below lists the methods you can use to save and load xamTileManager’s layout.
In order to save the xamTileManager state and tile’s layout, you must invoke the static Save method of the PersistenceManager class. There is an overload of the Save method, which accepts a PersistenceSettings argument, which is used to configure what properties to save or exclude. The persistence methods return a MemoryStream object which you can then save to a persistent location.
Note: Depending on your application architecture you may choose different approaches on how to persist the MemoryStream (like XML file or database). Refer to the “Saving and Loading Layouts” sample to see how the layout is persisted in a byte array.
The Save methods are accessed through the PersistenceManager class.
The Saving Layout example demonstrates how to persist all control’s properties.
The Including and Excluding Layout Properties During Save example demonstrates how to configure the persistence framework to ignore some properties when saving the state of a control.
In order to load the xamTileManager state and tile’s layout, you must invoke the static Load method of the PersistenceManager class. Additionally, there is an overload of the Load method that accepts an instance of the PersistenceSettings class as an argument. The PersistenceSettings instance is used to configure what properties to save or ignore in the layout. The data returned from the Save methods is supplied to the Load methods (as Stream objects) to restore the control’s state.
The Load methods are accessed through the PersistenceManager class.
The Loading Layout example demonstrates how to load all persisted control’s properties.
The following table lists the code examples provided below.
The code below demonstrates how to Save control’s state using the Save method with the following parameters:
The control, which state will be persisted
In Visual Basic:
Dim memoryStream As MemoryStream =
PersistenceManager.Save(xamTileManager1)
In C#:
MemoryStream memoryStream =
PersistenceManager.Save(xamTileManager1);
The code below demonstrates how to Save control’s state using the Save method with the following parameters:
The control, which state will be persisted
A Persistence Settings object specifying, which properties should be ignored
In Visual Basic:
' create the Persistence Settings object
Dim settings As New PersistenceSettings()
' save all properties except those ignored
settings.SavePersistenceOptions =
Persistence.Primitives.PersistenceOption.AllButIgnored
' add the "Left" property as ignored
Dim prop1 As New PropertyNamePersistenceInfo() With { _
.PropertyName = "Left" _
}
settings.IgnorePropertySettings.Add(prop1)
' add the "Top" property as ignored
Dim prop2 As New PropertyNamePersistenceInfo() With { _
.PropertyName = "Top" _
}
settings.IgnorePropertySettings.Add(prop2)
' save the control's properties in a memory stream
Dim memoryStream As MemoryStream =
PersistenceManager.Save(xamTileManager1, settings)
In C#:
// create the Persistence Settings object
PersistenceSettings settings = new PersistenceSettings();
// save all properties except those ignored
settings.SavePersistenceOptions =
Persistence.Primitives.PersistenceOption.AllButIgnored;
// add the "Left" property as ignored
PropertyNamePersistenceInfo prop1 = new PropertyNamePersistenceInfo
{
PropertyName = "Left"
};
settings.IgnorePropertySettings.Add(prop1);
// add the "Top" property as ignored
PropertyNamePersistenceInfo prop2 = new PropertyNamePersistenceInfo
{
PropertyName = "Top"
};
settings.IgnorePropertySettings.Add(prop2);
// save the control's properties in a memory stream
MemoryStream memoryStream =
PersistenceManager.Save(xamTileManager1, settings);
The code below demonstrates how to load control’s state using the Load method with the following parameters:
The control, which state will be restored
In Visual Basic:
PersistenceManager.Load(xamTileManager1, memoryStream)
In C#:
PersistenceManager.Load(xamTileManager1, memoryStream);
Following are some other topics you may find useful.