This documentation is archived and is not being maintained.

FrameworkElement.ApplyTemplate Method

Builds the current template's visual tree if necessary, and returns a value that indicates whether the visual tree was rebuilt by this call.

Namespace:  System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)

public bool ApplyTemplate()
You cannot use methods in XAML.

Return Value

Type: System.Boolean
true if visuals were added to the tree; returns false otherwise.

Applications can call this method to guarantee that the visual tree of an element is complete. This guarantee step might be necessary if code will be checking the child elements in the tree. For typical element logic within applications, calling ApplyTemplate is not necessary, because templates will be applied to elements at an appropriate point in their lifetimes automatically.

ApplyTemplate is called on every Measure pass by the WPF framework-level layout system.

FrameworkElement derived classes can use the OnApplyTemplate class handler to be notified of cases where this method was called explicitly, or by the layout system. OnApplyTemplate is called after the template is completely generated and attached to the logical tree.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0