Calling a parameterized constructor from XAML

WpfXaml

Wpf Problem Overview


While using WPF I noticed that when I add a control to a XAML file, the default constructor is called.

Is there a way to call a parameterized constructor?

Wpf Solutions


Solution 1 - Wpf

.NET 4.0 brings a new feature that challenges the answer - but apparently only for UWP applications (not WPF).

x:Arguments Directive

<object ...>
    <x:Arguments>
        oneOrMoreObjectElements
    </x:Arguments>
</object>

Solution 2 - Wpf

One of the guiding principles of XAML-friendly objects is that they should be completely usable with a default constructor, i.e., there is no behavior that is only accessible when using a non-default constructor. To fit with the declarative nature of XAML, object parameters are specified via property setters. There is also a convention that says that the order in which properties are set in XAML should not be important.

You may, however, have some special considerations that are important to your implementation but at odds with convention:

  1. You may have one or more properties which must be set before the object can be used.
  2. Two or more properties may be mutually exclusive with each other, e.g., it makes no sense to set both the StreamSource and UriSource of an image.
  3. You may want to ensure that a property is only set during initialization.
  4. One property may depend on another, which can be tricky due to the aforementioned convention of order independence when setting properties.

To make it easier to handle these cases, the ISupportInitialize interface is provided. When an object is read and created from XAML (i.e., parsed), objects implementing ISupportInitialize will be handled specially:

  1. The default constructor will be called.
  2. BeginInit() will be called.
  3. Properties will be set in the order they appeared in the XAML declaration.
  4. EndInit() is called.

By tracking calls to BeginInit() and EndInit(), you can handle whatever rules you need to impose, including the requirement that certain properties be set. This is how you should handle creation parameters; not by requiring constructor arguments.

Note that ISupportInitializeNotification is also provided, which extends the above interface by adding an IsInitialized property and Initialized event. I recommend using the extended version.

Solution 3 - Wpf

No. Not from XAML [when using WPF].

Solution 4 - Wpf

Yes, you can do it by the ObjectDataProvider. It allows you to call non-default constructor, for example:

<Grid>
    <Grid.Resources>
        <ObjectDataProvider x:Key="myDataSource"
                            ObjectType="{x:Type local:Person}">
            <ObjectDataProvider.ConstructorParameters>
                <system:String>Joe</system:String>
            </ObjectDataProvider.ConstructorParameters>
        </ObjectDataProvider>
    </Grid.Resources>
    <Label Content="{Binding Source={StaticResource myDataSource}, Path=Name}"></Label>
</Grid>

assuming that Person is

public class Person
{
    public Person(string Name)
    {
        this.Name = Name;
    }
    public string Name { get; set; }
}

Unfortunately, you cannot bind the ConstructorParameters. See some workaround here.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionHaniView Question on Stackoverflow
Solution 1 - WpfRaskalView Answer on Stackoverflow
Solution 2 - WpfMike StrobelView Answer on Stackoverflow
Solution 3 - WpfAlun HarfordView Answer on Stackoverflow
Solution 4 - WpfchviLadislavView Answer on Stackoverflow