source: default/framework/trunk/WebLibrary/Sources/UI/WebControls/Button.cs @ 1686

// ----------------------------------------------------------------------------
// <copyright company="F.C. Soft., Inc.">
//   Copyright(c) F.C. Soft., Inc.  All rights reserved.
// </copyright>
// <license>
//   Licensed to F.C. Soft., Inc. (FCSoft) under one or more contributor
//   license agreements.  See the NOTICE file distributed with this work for
//   additional information regarding copyright ownership.  FCSoft licenses
//   this file to You under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.  You
//   may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
// </license>
// ----------------------------------------------------------------------------

namespace FCSoft.SilverFrost.Framework.Web.UI.WebControls
{
    using System;
    using System.ComponentModel;
    using System.Web.UI;
    using System.Web.UI.WebControls;


    /// <summary>
    /// Web ページにプッシュ ボタン コントロールを表示します。
    /// </summary>
    [WebDescription("Description_Button")]
    [ControlInitializerTarget]
    public class Button :
        System.Web.UI.WebControls.Button
    {
        /// <summary>
        /// <see cref="SuppressHtmlValidation"/> プロパティ用のキー。
        /// </summary>
        private const string SuppressHtmlValidationKey = "SuppressHtmlValidation";


        /// <summary>
        /// <see cref="RaiseEventWithIsNotValid"/> プロパティ用のキー。
        /// </summary>
        private const string RaiseEventWithIsNotValidKey = "RaiseEventWithIsNotValid";

        /// <summary>
        /// <see cref="ConfirmControl"/> プロパティ用のキー。
        /// </summary>
        private const string ConfirmControlKey = "ConfirmControl";

        /// <summary>
        /// <see cref="ConfirmArgument"/> プロパティ用のキー。
        /// </summary>
        private const string ConfirmArgumentKey = "ConfirmArgument";


        /// <summary>
        /// インスタンスを作成します。
        /// </summary>
        public Button()
        {
            ControlInitializer.ApplyProperties(this);
        }


        /// <summary>
        /// HTML のフォームバリデーションを抑制するかどうかを取得または設定します。
        /// </summary>
        /// <value>
        /// HTML のフォームバリデーションを抑制する場合は <see langword="true"/>、
        /// それ以外の場合は <see langword="false"/>。
        /// 既定値は <see langword="false"/> です。
        /// </value>
        [Themeable(false)]
        [DefaultValue(false)]
        [WebCategory("Behavior")]
        [WebDescription("Description_SuppressHtmlValidation")]
        public virtual bool SuppressHtmlValidation
        {
            get
            {
                return (bool)(ViewState[SuppressHtmlValidationKey] ?? false);
            }

            set
            {
                ViewState[SuppressHtmlValidationKey] = value;
            }
        }

        /// <summary>
        /// バリデーションにエラーがあった場合でも
        /// <see cref="System.Web.UI.WebControls.ListControl.SelectedIndexChanged"/>
        /// イベントを実行するかどうかを取得及び設定します。
        /// </summary>
        /// <value>
        /// バリデーションにエラーがあった場合でも
        /// <see cref="System.Web.UI.WebControls.ListControl.SelectedIndexChanged"/>
        /// イベントを実行する場合は <see langword="true"/>、
        /// それ以外の場合は <see langword="false"/>。
        /// 既定値は <see langword="true"/>。
        /// </value>
        [Themeable(false)]
        [DefaultValue(true)]
        [WebCategory("Behavior")]
        [WebDescription("Description_RaiseEventWithIsNotValid")]
        public virtual bool RaiseEventWithIsNotValid
        {
            get
            {
                return (bool)(ViewState[RaiseEventWithIsNotValidKey] ?? true);
            }

            set
            {
                ViewState[RaiseEventWithIsNotValidKey] = value;
            }
        }

        /// <summary>
        /// クリックされたときに、クライアントサイド確認を行う
        /// <see cref="Confirm"/> コントロールのIDを取得及び設定します。
        /// </summary>
        /// <value>
        /// <see cref="Confirm"/> コントロールのID。
        /// 既定値は空の文字列 ("")。
        /// </value>
        [IDReferenceProperty(typeof(Confirm))]
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Behavior")]
        [WebDescription("Description_ConfirmControl")]
        public virtual string ConfirmControl
        {
            get
            {
                return (string)(ViewState[ConfirmControlKey] ?? string.Empty);
            }

            set
            {
                ViewState[ConfirmControlKey] = value;
            }
        }

        /// <summary>
        /// クリックされたときに、クライアントサイド確認を行う
        /// <see cref="Confirm"/> コントロールに渡す引数を取得及び設定します。
        /// </summary>
        /// <value>
        /// <see cref="Confirm"/> コントロールに渡す引数。
        /// 既定値は空の文字列 ("")。
        /// </value>
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Behavior")]
        [WebDescription("Description_ConfirmArgument")]
        public virtual string ConfirmArgument
        {
            get
            {
                return (string)(ViewState[ConfirmArgumentKey] ?? string.Empty);
            }

            set
            {
                ViewState[ConfirmArgumentKey] = value;
            }
        }


        /// <summary>
        /// サーバーへのポストバック時に、<see cref="Button"/> コントロールのイベントを発生させます。
        /// </summary>
        /// <param name="eventArgument">
        /// イベントの引数。
        /// </param>
        protected override void RaisePostBackEvent(string eventArgument)
        {
            // バリデータの結果を気にしない場合は、親クラスの機能を使用する
            if (!CausesValidation || RaiseEventWithIsNotValid)
            {
                base.RaisePostBackEvent(eventArgument);
                return;
            }

            // バリデータのチェック
            Page.Validate(ValidationGroup);
            if (!Page.IsValid)
            {
                return;
            }

            // イベントを実行
            OnClick(EventArgs.Empty);
            OnCommand(new CommandEventArgs(CommandName, CommandArgument));
        }

        /// <summary>
        /// <see cref="HyperLink"/> コントロールの属性を表示用の出力ストリームに追加します。
        /// </summary>
        /// <param name="writer">
        /// クライアントで表示するための出力ストリーム。
        /// </param>
        protected override void AddAttributesToRender(HtmlTextWriter writer)
        {
            string confirmControlId = ConfirmControl;
            if (!string.IsNullOrEmpty(confirmControlId))
            {
                EnsureID();
            }

            // 親を呼び出す
            base.AddAttributesToRender(writer);

            if (SuppressHtmlValidation)
            {
                writer.AddAttribute(Utility.FormNoValidateAttributeName, Utility.FormNoValidateAttributeName);
            }

            // 確認ダイアログとの連携
            if (!DesignMode && IsEnabled)
            {
                if (!string.IsNullOrEmpty(confirmControlId))
                {
                    WebUtility.FindControl<Confirm>(this, confirmControlId).RegisterOnClientClick(this, ConfirmArgument);
                }
            }
        }
    }
}