Serialization in UWP Image Editor (SfImageEditor)

10 May 20215 minutes to read

ImageEditor provides support to serialize and deserialize the shapes(Circle, Arrow, Rectangle), free hand drawing, Text and Toolbar settings. Save the current state of the image editor and Load it back when its needed.


SaveEdits() method used to serialize the current edits of shapes. Serialized object will be return in the form of JSON stream.

SfImageEditor editor;
        public MainPage()
            Grid grid = new Grid();
            Button saveEdits = new Button();
            saveEdits.Content = "Serialization";
            saveEdits.Click += SaveEdits_Click;
            editor = new SfImageEditor();
            grid.RowDefinitions.Add(new RowDefinition() { Height =GridLength.Auto });
            grid.RowDefinitions.Add(new RowDefinition());
            Grid.SetRow(saveEdits, 0);
            Grid.SetRow(editor, 1);
            this.Content = grid;

        private void SaveEdits_Click(object sender, RoutedEventArgs e)
            Stream stream = editor.SaveEdits();

you can save stream into .txt format file.if you saved as .txt format file to deserialize the shapes then set as Embedded resource in project.

Please find sample text file shown below



LoadEdits() method used to deserialize the shapes.

SfImageEditor editor = new SfImageEditor();
            var assembly = typeof(App).GetTypeInfo().Assembly;
            Stream stream = new MemoryStream();
            var fileName = "namespace_name.Chart.txt";
            stream = assembly.GetManifestResourceStream(fileName);
            if (stream != null)
            this.Content = editor;

You can also Serialize and Deserialize the current edited image.

            <RowDefinition Height="0.1*"/>
            <RowDefinition Height="0.9*"/>
            <ColumnDefinition Width="*"/>
            <ColumnDefinition Width="*"/>
        <Button Content="Serialization" Grid.Row="0" Grid.Column="0" x:Name="serialize" Click="Serialize_Click" HorizontalAlignment="Center"/>
        <Button Content="Deserialization" Grid.Row="0" Grid.Column="1" x:Name="deserialize" Click="Deserialize_Click" HorizontalAlignment="Center"/>
        <syncfusion:SfImageEditor Grid.Row="1" Grid.ColumnSpan="2" x:Name="editor" ImageSource="Assets/Bulding.jpeg"/>
private Stream stream;

        private void Serialize_Click(object sender, RoutedEventArgs e)
            stream = editor.SaveEdits();

        private void Deserialize_Click(object sender, RoutedEventArgs e)

You can find the sample for serialize and deserialize the current edited image.