SelectedObjects memory leak

Hi,

I am using the property grid 2.0. ( 2.0.589.10342,runtimeversion=2.0.50727)

I my program is a listview and a line like this:

propertygrid.selectedobjects=listView.SelectedItems

 After "short" time (selecting many items) I can see a memory leak and an "performance leak".

You can reproduce the issue with your sample:

Please change quickstart/multipleselectedobjects page to

public partial class MultipleSelectedObjects : Page
    {
        private System.Windows.Threading.DispatcherTimer timer;
        private System.Windows.Threading.DispatcherTimer timer2;
        public MultipleSelectedObjects()
        {
            InitializeComponent();

            TestGrid.SelectedObjects = new object[] { Person.AliceFull, Person.Bob };
            ReferenceGrid1.SelectedObject = Person.AliceFull;
            ReferenceGrid2.SelectedObject = Person.Bob;


            timer = new System.Windows.Threading.DispatcherTimer();
            timer.Tick += new System.EventHandler(dispatcherTimer_Tick);
            timer.Interval = new System.TimeSpan(0, 0, 0, 0, 200);
            timer.Start();

            timer2 = new System.Windows.Threading.DispatcherTimer();
            timer2.Tick += new System.EventHandler(dispatcherTimer_Tick2);
            timer2.Interval = new System.TimeSpan(0, 0, 0,0,100);
            timer2.Start();

           
           
        }


        private void dispatcherTimer_Tick(object sender, System.EventArgs e)
        {
            TestGrid.SelectedObjects = new object[] { Person.AliceFull };

        }
        private void dispatcherTimer_Tick2(object sender, System.EventArgs e)
        {
            TestGrid.SelectedObjects = new object[] { Person.AliceFull, Person.Bob };

        }
    }

 After certain time you can see the memory leak in the task manager.

 Could you fix it please ?

Thank you and cheers

Mario

 Hi,

can you write some feedback about this please ? workarounds or an fix date and so on ?

Thank you!

Mario

Hello Mario,

Sorry about the delay in replying -- combination of a public holiday and some on-site work.  We will look at this as soon as possible and will aim to have a fix by the end of this week.

Good news -- we have a candidate fix for this and it will be in tonight's nightly build (builds dated 11 Feb 2009 and above, available from about 1430 GMT).  Please let us know if you still see the problem.

Hi ivan,

I cant see any improvments. The bug (memory/performance leak) is still present.

(Tested with builds 11,12,13 february)

Whots going wrong ?

Cheers,

Mario

Aaugh.  Looks like there was a minor difference in our test code.  Your timer2 handler was setting TestGrid.SelectedObjects = new object[] { Person.AliceFull }. Mine was setting TestGrid.SelectedObjects = new object[] { Person.Bob }.  So I think there must still be an issue with children / expandable properties.  Apologies for not catching this; I'm looking into it now.

Hello Mario,

I have committed an updated fix for this and it will be included in nightly builds dated 17 Feb 2009 and above, available from the store from about 1430 GMT.  I hope this finally addresses the problem for you.  Apologies again for the inconvenience and thanks for helping us to track the problem down.

Hi ivan,

yes, the bug is fixed for the sample application. But in my real application the bug is still there. Do you need more informations ?

CHeers,

Mario

Hi Mario,

Yes, if you can provide me with some more information or repro instructions for the remaining bug that would be very useful.  Thanks!

 public class MediaObject : INotifyPropertyChanged

[Category("Properties")]
        [DisplayName("Duration [ms]")]
        [DisplayPosition(1)]
        [TypeConverterAttribute(typeof(SMI_Experiment_Center.Converter.UnlimetedINTTypeConverter))]
        [Browsable(false)]
        [IgnorableForComparisonAttribute(true)]
        [DefaultValue(typeof(int), "-1")]
        virtual public int Duration
        {
          ...
        }

[Browsable(false)]                              //  so the PropertyGrid doesn't see it
        [XmlIgnoreAttribute()]                          //  can not be serialized 
        virtual public string DurationString
        {
            ...
        }

protected string m_groupName;
        [Browsable(true)]
        [Category("Properties")]
        [DisplayName("Randomization Group")]
        [DisplayPosition(99)]
        [IgnorableForComparisonAttribute(true)]
        [DefaultValue(typeof(string), "")]
       
        public string GroupName
        {
           ...
        }

[Browsable(false)]                              //  so the PropertyGrid doesn't see it
        [XmlIgnoreAttribute()]                          //  can not be serialized 
        virtual public string QuickInfo
        {
            get
            {
                return "";
            }
        }

[Browsable(false)]
        [XmlIgnoreAttribute()]                          //  can not be serialized 
        virtual public bool ShowMouseInPreview
        {
            get
            {
                return false;
            }
        }

 [Browsable(false)]                              //  so the PropertyGrid doesn't see it
        [Category("Properties")]
        virtual public string TypeName
        {
            get
            {
                return GetType().Name;
            }
        }

and so on...

public class CalibrationObject : MediaObject

- no own Duration property implementation

- no own DurationString property implementation

 - no own show ShowMouseInPreview impl

[Browsable(false)]                              //  so the PropertyGrid doesn't see it
        [Category("Properties")]
        virtual public string TypeName
        {
            get
            {
                return "Calibration";
            }
        }

[Category("Properties")]
        [DisplayName("Background Color")]
        [DisplayPosition(1)]
        [IgnorableForComparisonAttribute(false)]       
        [DefaultValue(typeof(System.Windows.Media.Color),"Silver")]
        public System.Windows.Media.Color BackgroundColor
        {
           ...
        }

[Browsable(true)]
        [TypeConverterAttribute(typeof(SMI_Experiment_Center.Converter.YesNoTypeConverter))]
        [DisplayName("Show Calibration Quality")]
        [DisplayPosition(5)]
        [DefaultValue(typeof(bool), "true")]
        [IgnorableForComparison(true)]
        [Category("Properties")]
        public bool ShowCalibQuality
        {
            ....
        }

and so on. 

Of course there are more properties.... (in both classes).

There are more derived classes.

There is also an public class StimulusList : ObservableCollection<MediaObject> class.

there is a databinding to a listview.

and an handler:

private void OnSelectionChangedSlideShowListViewMainFrame(object Sender, SelectionChangedEventArgs e)

{

propertyGrid.SelectedObjects = listview.selecteditems;

 }

btw: i have noted the handler is not necessary. it is enough to write in a loaded event propertyGrid.SelectedObjects = listview.selecteditems; Then there is an "automatic databinding"!!(if the listview selection changed the propgrid selected objects will change!)

the propgrid is defined by:

<my:PropertyGrid Name="propertyGrid" Height="Auto" Width="Auto" Focusable="False" AllowModifyCollections="False" Style="{StaticResource FancyStyle}" BorderThickness="0" IsToolBarVisible="False" Visibility="Visible" BorderBrush="Beige" views:HelpProvider.HelpID="10140">
                                    <!--<my:PropertyGrid.CommandBindings>
                                        <CommandBinding Command="my:ManyEditor.ResetCommand" Executed="CommandBinding_Executed" CanExecute="CommandBinding_CanExecute">                                           
                                        </CommandBinding>
                                    </my:PropertyGrid.CommandBindings>-->
                                    <my:PropertyGrid.Editors>
                                        <!--<views:ImageFileEditor EditorTemplate="{StaticResource ImageSelector}"/>-->
                                        <!--<views:ExeFileEditor EditorTemplate="{StaticResource ExecSelector}"/>-->
                                        <!--<editors:TextFileEditor EditorTemplate="{StaticResource TextSelector}"/>-->
                                        <my:PropertyEditor PropertyName="Application to Start" DeclaringType="my:Many"
                                                           EditorTemplate="{StaticResource ExecSelector}"/>
                                        <my:PropertyEditor PropertyName="VerificationPicture" DeclaringType="my:Many"
                                                           EditorTemplate="{StaticResource ImageSelector}"/>
                                        <my:PropertyEditor PropertyName="Content" DeclaringType="my:Many"
                                                           EditorTemplate="{StaticResource TextSelector}"/>


                                        <my:PropertyEditor PropertyName="Duration" DeclaringType="my:Many"
                                    EditorTemplate="{StaticResource {x:Static my:PropertyGrid.ListSelectEditorKey}}" Style="{StaticResource ListSelectEditor}" >
                                        </my:PropertyEditor>

                                    </my:PropertyGrid.Editors>



                                    <my:PropertyGrid.Resources>

                                        <DataTemplate x:Key="{x:Static my:PropertyGrid.ReadOnlyDisplayKey}">
                                            <Border                                       
                                        BorderThickness="0">
                                                <TextBlock Text="{Binding Value}" IsEnabled="False"
                                            Margin="0" Padding="5 10 10 10" VerticalAlignment="Center"
                                                Background="Gray" />
                                            </Border>
                                        </DataTemplate>
                                    </my:PropertyGrid.Resources>

                                    <my:PropertyGrid.BuiltInEditorStyles>
                                        <my:BuiltInEditorStyleCollection>
                                            <my:BuiltInEditorStyle EditorKey="{x:Static my:PropertyGrid.SimpleTextEditorKey}">
                                                <Style TargetType="{x:Type my:TextBox}">
                                                    <Setter Property="Foreground" Value="Black" />
                                                    <Setter Property="Height" Value="20" />
                                                    <Setter Property="Template" Value="{StaticResource propertyGridTextBoxStyle}"/>
                                                    <Setter Property="Text">
                                                        <Setter.Value>
                                                            <Binding Path="Value"/>
                                                        </Setter.Value>
                                                    </Setter>

                                                </Style>
                                            </my:BuiltInEditorStyle>

                                            <my:BuiltInEditorStyle EditorKey="{x:Static my:PropertyGrid.ReadOnlyDisplayKey }">
                                                <Style TargetType="{x:Type TextBlock}">
                                                    <Setter Property="Foreground" Value="Black" />
                                                    <Setter Property="Height" Value="20" />
                                                </Style>
                                            </my:BuiltInEditorStyle>

                                            <my:BuiltInEditorStyle EditorKey="{x:Static my:PropertyGrid.ListSelectNoTextEntryEditorKey}" Style="{StaticResource ListSelectNoTextEntryEditor}">
                                            </my:BuiltInEditorStyle>
                                            <my:BuiltInEditorStyle EditorKey="{x:Static my:PropertyGrid.ListSelectEditorKey}" Style="{StaticResource ListSelectEditor}">
                                            </my:BuiltInEditorStyle>
                                            <my:BuiltInEditorStyle EditorKey="{x:Static my:PropertyGrid.ColorEditorKey }" Style="{StaticResource SimpleColourPicker}">
                                            </my:BuiltInEditorStyle>
                                            <my:BuiltInEditorStyle EditorKey="{x:Static my:PropertyGrid.ManyEditorKey }" Style="{StaticResource ManyEditor}">
                                            </my:BuiltInEditorStyle>
                                        </my:BuiltInEditorStyleCollection>
                                    </my:PropertyGrid.BuiltInEditorStyles>
                                </my:PropertyGrid>

i dont know wthat is also interesting for you!

 CHeers and thanks!

Mario

btw: the bug also appears with an old "not mult selections" prop grid ( version circa aprril -may 08)

I have noted:  in "my" version (20081126) is no flicker after changing selectedobjects. in the new one there is a flicker. it looks like "first loading singe editor then loading many editor"

Feature request:

In ImageObject there is an Property

protected bool m_FitToScreen;
        [Category("Properties")]
        [DisplayName("Fit Image to Screen")]
        [DisplayPosition(2)]
        [TypeConverterAttribute(typeof(SMI_Experiment_Center.Converter.YesNoTypeConverter))]
        [DefaultValue(typeof(bool), "true")]
        public bool FitToScreen

in movieobject is also an fittoscreen property but this one is "displaynamed" "Fit movie to Screen".

An attribute like 

SharedDisplayName would be cool!

i.e. 

SharedDisplayName("Fit object to screen") 

and sometimes there is no sense to share an prop. (i.e. we use a property as "url" and in an other class as "file location"->

 An attribute like

[ShareProperty(false)] ->dont show this property with the other one..(in the prop grid) would be cool.

CHeers

MArio

Hello Mario,

Sorry for the slow reply on this.

I have managed to reproduce a small memory leak, and have largely fixed it.  (There remains a further small leak in your scenario, approximately 1K per change of selection in the ListView, but this will be a bit harder to fix so I want to understand (a) whether I am on the right track first, and (b) whether the remaining small leak is actually significant in your scenario -- are people actually making tens of thousands of selections over the course of the app.)  This fix will be included in nightly builds dated 26 Feb 2009 and above, available from about 1430 GMT.

However, because the leak I identified was relatively small, I am not sure whether I have actually caught your real problem.  I don't have the full objects and resources that you are using in your project, so it may be that my repro case is still missing something.  Therefore, if you are still seeing a significant leak with the new version, would it be possible for you to provide us with a full working sample project that demonstrates the larger leak please?  (You can attach a zip file via the Options tab, or if the content is sensitive, you can mail it via the contact form.  Please make sure you strip out any binaries first or our mail system is likely to bounce it!)  I know this is a bit tedious but it is the only way we can be sure that we are addressing the real problem!

Hi ivan,

yes there is still aleak. I will write an repro solution until wednesday.

 CHeers

Mario