ContentDecorator.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using SiliconStudio.Core;

namespace SiliconStudio.Paradox.UI.Controls
{
    /// <summary>
    /// A <see cref="ContentControl"/> decorating its <see cref="ContentControl.Content"/> with a background image.
    /// </summary>
    public class ContentDecorator : ContentControl
    {
        /// <summary>
        /// The key to the NotPressedImage dependency property.
        /// </summary>
        public static readonly PropertyKey<UIImage> BackgroundImagePropertyKey = new PropertyKey<UIImage>("BackgroundImageKey", typeof(ContentDecorator), DefaultValueMetadata.Static<UIImage>(null));
        
        /// <summary>
        /// Gets or sets the image that the button displays when pressed
        /// </summary>
        public UIImage BackgroundImage
        {
            get { return DependencyProperties.Get(BackgroundImagePropertyKey); }
            set { DependencyProperties.Set(BackgroundImagePropertyKey, value); }
        }

        public ContentDecorator()
        {
            DrawLayerNumber += 1; // (decorator design image)
        }
    }
}