Documented TemplatedControl.

Perspex.Controls/Primitives/TemplatedControl.cs

@@ -16,32 +16,62 @@ namespace Perspex.Controls.Primitives
     using Serilog;
     using Serilog.Core.Enrichers;
 
+    /// <summary>
+    /// A lookless control whose visual appearance is defined by its <see cref="Template"/>.
+    /// </summary>
     public class TemplatedControl : Control, ITemplatedControl
     {
+        /// <summary>
+        /// Defines the <see cref="Background"/> property.
+        /// </summary>
         public static readonly PerspexProperty<Brush> BackgroundProperty =
             Border.BackgroundProperty.AddOwner<TemplatedControl>();
 
+        /// <summary>
+        /// Defines the <see cref="BorderBrushProperty"/> property.
+        /// </summary>
         public static readonly PerspexProperty<Brush> BorderBrushProperty =
             Border.BorderBrushProperty.AddOwner<TemplatedControl>();
 
+        /// <summary>
+        /// Defines the <see cref="BorderThicknessProperty"/> property.
+        /// </summary>
         public static readonly PerspexProperty<double> BorderThicknessProperty =
             Border.BorderThicknessProperty.AddOwner<TemplatedControl>();
 
+        /// <summary>
+        /// Defines the <see cref="FontFamilyProperty"/> property.
+        /// </summary>
         public static readonly PerspexProperty<string> FontFamilyProperty =
             TextBlock.FontFamilyProperty.AddOwner<TemplatedControl>();
 
+        /// <summary>
+        /// Defines the <see cref="FontSizeProperty"/> property.
+        /// </summary>
         public static readonly PerspexProperty<double> FontSizeProperty =
             TextBlock.FontSizeProperty.AddOwner<TemplatedControl>();
 
+        /// <summary>
+        /// Defines the <see cref="FontStyleProperty"/> property.
+        /// </summary>
         public static readonly PerspexProperty<FontStyle> FontStyleProperty =
             TextBlock.FontStyleProperty.AddOwner<TemplatedControl>();
 
+        /// <summary>
+        /// Defines the <see cref="ForegroundProperty"/> property.
+        /// </summary>
         public static readonly PerspexProperty<Brush> ForegroundProperty =
             TextBlock.ForegroundProperty.AddOwner<TemplatedControl>();
 
+        /// <summary>
+        /// Defines the <see cref="PaddingProperty"/> property.
+        /// </summary>
         public static readonly PerspexProperty<Thickness> PaddingProperty =
             Decorator.PaddingProperty.AddOwner<TemplatedControl>();
 
+        /// <summary>
+        /// Defines the <see cref="TemplateProperty"/> property.
+        /// </summary>
         public static readonly PerspexProperty<ControlTemplate> TemplateProperty =
             PerspexProperty.Register<TemplatedControl, ControlTemplate>("Template");
 
@@ -49,6 +79,9 @@ namespace Perspex.Controls.Primitives
 
         private ILogger templateLog;
 
+        /// <summary>
+        /// Initializes static members of the <see cref="TemplatedControl"/> class.
+        /// </summary>
         static TemplatedControl()
         {
             TemplateProperty.Changed.Subscribe(e =>
@@ -59,6 +92,9 @@ namespace Perspex.Controls.Primitives
             });
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TemplatedControl"/> class.
+        /// </summary>
         public TemplatedControl()
         {
             this.templateLog = Log.ForContext(new[]
@@ -69,64 +105,88 @@ namespace Perspex.Controls.Primitives
             });
         }
 
+        /// <summary>
+        /// Gets or sets the brush used to draw the control's background.
+        /// </summary>
         public Brush Background
         {
             get { return this.GetValue(BackgroundProperty); }
             set { this.SetValue(BackgroundProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the brush used to draw the control's border.
+        /// </summary>
         public Brush BorderBrush
         {
             get { return this.GetValue(BorderBrushProperty); }
             set { this.SetValue(BorderBrushProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the thickness of the control's border.
+        /// </summary>
         public double BorderThickness
         {
             get { return this.GetValue(BorderThicknessProperty); }
             set { this.SetValue(BorderThicknessProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the font family used to draw the control's text.
+        /// </summary>
         public string FontFamily
         {
             get { return this.GetValue(FontFamilyProperty); }
             set { this.SetValue(FontFamilyProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the size of the control's text in points.
+        /// </summary>
         public double FontSize
         {
             get { return this.GetValue(FontSizeProperty); }
             set { this.SetValue(FontSizeProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the font style used to draw the control's text.
+        /// </summary>
         public FontStyle FontStyle
         {
             get { return this.GetValue(FontStyleProperty); }
             set { this.SetValue(FontStyleProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the brush used to draw the control's text and other foreground elements.
+        /// </summary>
         public Brush Foreground
         {
             get { return this.GetValue(ForegroundProperty); }
             set { this.SetValue(ForegroundProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the padding placed between the border of the control and its content.
+        /// </summary>
         public Thickness Padding
         {
             get { return this.GetValue(PaddingProperty); }
             set { this.SetValue(PaddingProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the template that defines the control's appearance.
+        /// </summary>
         public ControlTemplate Template
         {
             get { return this.GetValue(TemplateProperty); }
             set { this.SetValue(TemplateProperty, value); }
         }
 
-        public override void Render(IDrawingContext context)
-        {
-        }
-
+        /// <inheritdoc/>
         public sealed override void ApplyTemplate()
         {
             if (!this.templateApplied)
@@ -154,10 +214,18 @@ namespace Perspex.Controls.Primitives
             }
         }
 
+        /// <summary>
+        /// Called when the control's template is applied.
+        /// </summary>
         protected virtual void OnTemplateApplied()
         {
         }
 
+        /// <summary>
+        /// Sets the <see cref="TemplatedParent"/> property of the control and decendents until
+        /// an <see cref="IPresenter"/> is found.
+        /// </summary>
+        /// <param name="control">The control.</param>
         private void SetTemplatedParent(Control control)
         {
             control.TemplatedParent = this;