State Persistence in UWP Ribbon (SfRibbon(Touch Ribbon))

15 Jul 20262 minutes to read

State Persistence is the combined process of Serialization and Deserialization. Serialization is the process of converting the state of an object to a format where it can be persisted as a file in the memory. The serialized format contains the object’s state information. Deserialization is the complement process of Serialization that converts the stored state information back into the object. A user can save and load the following:

  • RibbonState (Normal, Adorner, Hide)
  • Selected Ribbon Tab
  • QuickAccessToolbar items
  • QuickAccessToolBar State (Above or Below Ribbon)

The Ribbon State Persistence feature helps users to load the state of the Ribbon control that existed when the application was closed. The State Persistence feature gives a more consistent workflow for an application that is executed for a long time. The Serialize() and DeSerialize() public methods are provided for state persistence. They can be called whenever required. State persistence is not done internally.

The following code snippet shows how to achieve the serialization and deserialization.

<StackPanel>

<StackPanel>

<TextBlock Margin="5" Text="Serialize" />

<Button Click="OnSerialize" Content="Save" />

</StackPanel>

<StackPanel>

<TextBlock Margin="5" Text="DeSerialize" />

<Button Click="OnDeserialize" Content="Load" />

</StackPanel>

</StackPanel>
private void OnSerialize(object sender, RoutedEventArgs args)

{

try

{

this.ribbon.Serialize();

}

catch (Exception ex)

{

// Log or handle the serialization failure
// Example: await new MessageDialog(ex.Message).ShowAsync();

}

}

private async void OnDeserialize(object sender, RoutedEventArgs args)

{

try

{

this.ribbon.DeSerialize();

}

catch (Exception ex)

{

// Log or handle the deserialization failure
// Example: await new MessageDialog(ex.Message).ShowAsync();

}

}
Private Sub OnSerialize(ByVal sender As Object, ByVal args As RoutedEventArgs)


Try


Me.ribbon.Serialize()


Catch ex As Exception

' Log or handle the serialization failure

End Try

End Sub

Private Sub OnDeserialize(ByVal sender As Object, ByVal args As RoutedEventArgs)


Try


Me.ribbon.DeSerialize()


Catch ex As Exception

' Log or handle the deserialization failure

End Try

End Sub