Как управлять таблицами стилей в ASP.NET Темы с помощью StylePlaceHolder и Style control

Обновление: Это превратилось в сообщение в блоге с обновленными ссылками и кодом в моем блоге: https://egilhansen.com/2008/12/01/how-to-take-control-of-style-sheets-in-asp-net-themes-with-the-styleplaceholder-and-style-control/


Проблема довольно проста. При использовании Темы ASP.NET у вас не так много говорят о том, как ваши таблицы стилей отображаются на странице.

Механизм рендеринга добавляет все таблицы стилей в папку тем в алфавитном порядке, используя обозначение < link href= "...".

Мы все знаем, что порядок таблиц стилей важен, к счастью, недостатки asp.nets можно обойти, префиксные таблицы стилей с 01, 02,..., 99 и, таким образом, форсирование заказа, который вы хотите (см. Rusty Swayne сообщение в блоге о технике для получения дополнительной информации).

Это особенно важно, если вы используете таблицу стилей reset, которую я очень рекомендую; это упрощает стиль сайта в согласованной форме в браузерах (посмотрите Reset Reloaded from Eric Meyer).

Вы также упускаете возможность указать тип носителя (например, экран, печать, проекция, шрифт Брайля, речь). И если вы предпочитаете включать таблицы стилей, используя метод @import, вы также остаетесь на холоде.

Другой недостающий параметр - это условный комментарий, который особенно полезен, если вы используете таблицу стилей "ie-fix.css".

Прежде чем я объясню, как решения StylePlaceholder и Style устраняют вышеупомянутые проблемы, кредит, при котором должен быть кредит, мое решение вдохновлено Запись в блоге Per Zimmermans по теме.

Элемент StylePlaceHolder помещается в раздел заголовка главной страницы или страницы. Он может размещать один или несколько элементов управления стилем и удалять стили, добавленные механизмом рендеринга, по умолчанию и добавлять его собственный (он будет удалять только стили, добавленные из текущей активной темы).

Элемент управления стилем может одновременно размещать встроенные стили между его открывающими и закрывающими тегами и ссылкой на внешний файл таблицы стилей через его свойство CssUrl. С другими свойствами вы определяете, как таблица стилей отображается на странице.

Позвольте мне показать пример. Рассмотрим простой проект веб-сайта с главной страницей и темой с тремя таблицами стилей - 01reset.css, 02style.css, 99iefix.cs. Примечание. Я назвал их с использованием техники префикса, описанной ранее, так как это позволяет улучшить время разработки. Кроме того, префиксом тега пользовательских элементов управления является "ass:".

В разделе заголовка основных страниц добавьте:

<ass:StylePlaceHolder ID="StylePlaceHolder1" runat="server" SkinID="ThemeStyles" />

В своем каталоге темы добавьте файл скина (например, Styles.skin) и добавьте следующий контент:

<ass:StylePlaceHolder1runat="server" SkinId="ThemeStyles">
    <ass:Style CssUrl="~/App_Themes/Default/01reset.css" />
    <ass:Style CssUrl="~/App_Themes/Default/02style.css" />
    <ass:Style CssUrl="~/App_Themes/Default/99iefix.css" ConditionCommentExpression="[if IE]" />
</ass:StylePlaceHolder1>

Это в основном это. В элементе управления Style есть больше свойств, которые можно использовать для управления рендерингом, но это базовая настройка. Благодаря этому вы можете легко добавить другую тему и заменить все стили, поскольку вам нужно включить другой файл скина.

Теперь к коду, из которого все это происходит. Должен признаться, что опыт разработки времени имеет некоторые особенности. Вероятно, это связано с тем, что я не очень разбираюсь в написании пользовательских элементов управления (на самом деле, эти два являются моими первыми попытками), поэтому мне очень хотелось бы получить информацию о следующем. В текущем проекте на основе WCAB/WCSF, который я разрабатываю, я вижу ошибки, подобные этому в представлении дизайна Visual Studios, и я понятия не имею, почему. Сайт компилируется и все работает в Интернете.

Пример ошибки времени разработки в Visual Studio http://www.egil.dk/wp-content/styleplaceholder-error.jpg

Ниже приведен код для элемента управления StylePlaceHolder:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.HtmlControls;

[assembly: TagPrefix("Assimilated.Extensions.Web.Controls", "ass")]
namespace Assimilated.WebControls.Stylesheet
{
    [AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
    [DefaultProperty("SkinID")]
    [ToolboxData("<{0}:StylePlaceHolder runat=\"server\" SkinID=\"ThemeStyles\"></{0}:StylePlaceHolder>")]
    [ParseChildren(true, "Styles")]
    [Themeable(true)]
    [PersistChildren(false)]
    public class StylePlaceHolder : Control
    {
        private List<Style> _styles;

        [Browsable(true)]
        [Category("Behavior")]
        [DefaultValue("ThemeStyles")]
        public override string SkinID { get; set; }

        [Browsable(false)]
        public List<Style> Styles
        {
            get
            {
                if (_styles == null)
                    _styles = new List<Style>();
                return _styles;
            }
        }

        protected override void CreateChildControls()
        {
            if (_styles == null)
                return;

            // add child controls
            Styles.ForEach(Controls.Add);
        }

        protected override void OnLoad(EventArgs e)
        {
            base.OnLoad(e);

            // get notified when page has finished its load stage
            Page.LoadComplete += Page_LoadComplete;
        }

        void Page_LoadComplete(object sender, EventArgs e)
        {
            // only remove if the page is actually using themes
            if (!string.IsNullOrEmpty(Page.StyleSheetTheme) || !string.IsNullOrEmpty(Page.Theme))
            {
                // Make sure only to remove style sheets from the added by
                // the runtime form the current theme.
                var themePath = string.Format("~/App_Themes/{0}",
                                              !string.IsNullOrEmpty(Page.StyleSheetTheme)
                                                  ? Page.StyleSheetTheme
                                                  : Page.Theme);

                // find all existing stylesheets in header
                var removeCandidate = Page.Header.Controls.OfType<HtmlLink>()
                    .Where(link => link.Href.StartsWith(themePath)).ToList();

                // remove the automatically added style sheets
                removeCandidate.ForEach(Page.Header.Controls.Remove);
            }
        }

        protected override void AddParsedSubObject(object obj)
        {
            // only add Style controls
            if (obj is Style)
                base.AddParsedSubObject(obj);
        }

    }
}

И код для элемента управления Style:

using System.ComponentModel;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;

[assembly: TagPrefix("Assimilated.Extensions.Web.Controls", "ass")]
namespace Assimilated.WebControls.Stylesheet
{
    [AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
    [DefaultProperty("CssUrl")]
    [ParseChildren(true, "InlineStyle")]
    [PersistChildren(false)]
    [ToolboxData("<{0}:Style runat=\"server\"></{0}:Style>")]
    [Themeable(true)]
    public class Style : Control
    {
        public Style()
        {
            // set default value... for some reason the DefaultValue attribute do
            // not set this as I would have expected.
            TargetMedia = "All";
        }

        #region Properties

        [Browsable(true)]
        [Category("Style sheet")]
        [DefaultValue("")]
        [Description("The url to the style sheet.")]
        [UrlProperty("*.css")]
        public string CssUrl
        {
            get; set;
        }

        [Browsable(true)]
        [Category("Style sheet")]
        [DefaultValue("All")]
        [Description("The target media(s) of the style sheet. See http://www.w3.org/TR/REC-CSS2/media.html for more information.")]
        public string TargetMedia
        {
            get; set;
        }

        [Browsable(true)]
        [Category("Style sheet")]
        [DefaultValue(EmbedType.Link)]
        [Description("Specify how to embed the style sheet on the page.")]
        public EmbedType Type
        {
            get; set;
        }

        [Browsable(false)]
        [PersistenceMode(PersistenceMode.InnerDefaultProperty)]
        public string InlineStyle
        {
            get; set;
        }

        [Browsable(true)]
        [Category("Conditional comment")]
        [DefaultValue("")]
        [Description("Specifies a conditional comment expression to wrap the style sheet in. See http://msdn.microsoft.com/en-us/library/ms537512.aspx")]
        public string ConditionalCommentExpression
        {
            get; set;
        }

        [Browsable(true)]
        [Category("Conditional comment")]
        [DefaultValue(CommentType.DownlevelHidden)]
        [Description("Whether to reveal the conditional comment expression to downlevel browsers. Default is to hide. See http://msdn.microsoft.com/en-us/library/ms537512.aspx")]
        public CommentType ConditionalCommentType
        {
            get; set;
        }

        [Browsable(true)]
        [Category("Behavior")]
        public override string SkinID { get; set; }

        #endregion

        protected override void Render(HtmlTextWriter writer)
        {            
            // add empty line to make output pretty
            writer.WriteLine();

            // prints out begin condition comment tag
            if (!string.IsNullOrEmpty(ConditionalCommentExpression))
                writer.WriteLine(ConditionalCommentType == CommentType.DownlevelRevealed ? "<!{0}>" : "<!--{0}>",
                                 ConditionalCommentExpression);

            if (!string.IsNullOrEmpty(CssUrl))
            {               
                // add shared attribute
                writer.AddAttribute(HtmlTextWriterAttribute.Type, "text/css");

                // render either import or link tag
                if (Type == EmbedType.Link)
                {
                    // <link href=\"{0}\" type=\"text/css\" rel=\"stylesheet\" media=\"{1}\" />
                    writer.AddAttribute(HtmlTextWriterAttribute.Href, ResolveUrl(CssUrl));
                    writer.AddAttribute(HtmlTextWriterAttribute.Rel, "stylesheet");
                    writer.AddAttribute("media", TargetMedia);
                    writer.RenderBeginTag(HtmlTextWriterTag.Link);
                    writer.RenderEndTag();
                }
                else
                {
                    // <style type="text/css">@import "modern.css" screen;</style>
                    writer.RenderBeginTag(HtmlTextWriterTag.Style);
                    writer.Write("@import \"{0}\" {1};", ResolveUrl(CssUrl), TargetMedia);
                    writer.RenderEndTag();
                }
            }

            if(!string.IsNullOrEmpty(InlineStyle))
            {
                // <style type="text/css">... inline style ... </style>
                writer.AddAttribute(HtmlTextWriterAttribute.Type, "text/css");
                writer.RenderBeginTag(HtmlTextWriterTag.Style);
                writer.Write(InlineStyle);
                writer.RenderEndTag();
            }

            // prints out end condition comment tag
            if (!string.IsNullOrEmpty(ConditionalCommentExpression))
            {
                // add empty line to make output pretty
                writer.WriteLine();
                writer.WriteLine(ConditionalCommentType == CommentType.DownlevelRevealed ? "<![endif]>" : "<![endif]-->");
            }
        }
    }

    public enum EmbedType
    {        
        Link = 0,
        Import = 1,
    }

    public enum CommentType
    {
        DownlevelHidden = 0,
        DownlevelRevealed = 1
    }
}

Так что вы, ребята, думаете? Является ли это хорошим решением проблемы проблемы с asp.net? А как насчет кода? Мне бы очень хотелось, чтобы на нем был вклад, особенно в отношении времени разработки.

Я загрузил zipped версию решения Visual Studio, которая содержит проект, в случае, если кто-то заинтересован.

С наилучшими пожеланиями, Эгил.

Ответ 1

Нашел ответ на мой собственный вопрос.

Причина ошибок рендеринга, которые я получаю в режиме разработки, является очевидной ошибкой в ​​Visual Studio SP1, которой Microsoft еще не исправила.

Таким образом, приведенный выше код работает так же, как ожидалось, также в режиме разработки, если вы просто включаете пользовательские элементы управления в предварительно скомпилированную сборку, а не через другой проект в том же решении.

См. приведенную выше ссылку для более подробного объяснения того, как и почему.

Ответ 2

Работает очень плавно.

Для таких, как я, которые никогда не помнят синтаксис тегов <% здесь, что вам нужно добавить в начало определения главной страницы и файл скина для регистрации пространства имен.

<%@ Register TagPrefix="ass" Namespace="Assimilated.WebControls.Stylesheet" %>

Я не уверен, что хочу получить эту "задницу" по всему моему коду, но в остальном мне это нравится.

О, и если это действительно ваш первый заказ, отличная работа. Я знаю, что он был вдохновлен чужим кодом, но он как минимум появляется, чтобы иметь все нужные атрибуты и интерфейсы.

Ответ 3

Re: используя специальный мультимедийный CSS файл, вы можете использовать инструкцию @media CSS, отлично работает.