File: ExtenderControl.cs

package info (click to toggle)
mono 6.8.0.105%2Bdfsg-3.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,284,512 kB
  • sloc: cs: 11,172,132; xml: 2,850,069; ansic: 671,653; cpp: 122,091; perl: 59,366; javascript: 30,841; asm: 22,168; makefile: 20,093; sh: 15,020; python: 4,827; pascal: 925; sql: 859; sed: 16; php: 1
file content (172 lines) | stat: -rw-r--r-- 6,619 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
//------------------------------------------------------------------------------
// <copyright file="ExtenderControl.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>
//------------------------------------------------------------------------------
 
namespace System.Web.UI {
    using System;
    using System.Collections.Generic;
    using System.ComponentModel;
    using System.Diagnostics.CodeAnalysis;
    using System.Globalization;
    using System.Web;
    using System.Web.UI;
    using System.Web.Resources;
    using System.Web.Util;

    [
    DefaultProperty("TargetControlID"),
    Designer("System.Web.UI.Design.ExtenderControlDesigner, " + AssemblyRef.SystemWebExtensionsDesign),
    NonVisualControl(),
    ParseChildren(true),
    PersistChildren(false),
    ToolboxItem("System.Web.UI.Design.ExtenderControlToolboxItem, " + AssemblyRef.SystemWebExtensionsDesign),
    ]
    public abstract class ExtenderControl : Control, IExtenderControl {
        private string _targetControlID;
        private IScriptManagerInternal _scriptManager;
        private new IPage _page;

        protected ExtenderControl() {
        }

        internal ExtenderControl(IScriptManagerInternal scriptManager, IPage page) {
            _scriptManager = scriptManager;
            _page = page;
        }

        private IPage IPage {
            get {
                if (_page != null) {
                    return _page;
                }
                else {
                    Page page = Page;
                    if (page == null) {
                        throw new InvalidOperationException(AtlasWeb.Common_PageCannotBeNull);
                    }
                    return new PageWrapper(page);
                }
            }
        }

        private IScriptManagerInternal ScriptManager {
            get {
                if (_scriptManager == null) {
                    Page page = Page;
                    if (page == null) {
                        throw new InvalidOperationException(AtlasWeb.Common_PageCannotBeNull);
                    }
                    _scriptManager = System.Web.UI.ScriptManager.GetCurrent(page);
                    if (_scriptManager == null) {
                        throw new InvalidOperationException(String.Format(CultureInfo.InvariantCulture,
                            AtlasWeb.Common_ScriptManagerRequired, ID));
                    }
                }
                return _scriptManager;
            }
        }

        [
        Category("Behavior"),
        DefaultValue(""),
        IDReferenceProperty,
        ResourceDescription("ExtenderControl_TargetControlID"),
        SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "ID"),
        ]
        public string TargetControlID {
            get {
                return (_targetControlID == null) ? String.Empty : _targetControlID;
            }
            set {
                _targetControlID = value;
            }
        }

        [
        Browsable(false),
        DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
        EditorBrowsable(EditorBrowsableState.Never)
        ]
        public override bool Visible {
            get {
                return base.Visible;
            }
            set {
                throw new NotImplementedException();
            }
        }

        /// <summary>
        /// Finds the closest UpdatePanel in the parent controls of the specified control.
        /// </summary>
        /// <param name="control">The control for which we want the closest UpdatePanel.</param>
        /// <returns>An UpdatePanel or null if none was found.</returns>
        private static UpdatePanel FindUpdatePanel(Control control) {
            Control parent = control.Parent;
            while (parent != null) {
                UpdatePanel parentPanel = parent as UpdatePanel;
                if (parentPanel != null) {
                    return parentPanel;
                }
                parent = parent.Parent;
            }
            return null;
        }

        [SuppressMessage("Microsoft.Security", "CA2109:ReviewVisibleEventHandlers")]
        protected internal override void OnPreRender(EventArgs e) {
            base.OnPreRender(e);
            RegisterWithScriptManager();
        }

        private void RegisterWithScriptManager() {
            if (String.IsNullOrEmpty(TargetControlID)) {
                throw new InvalidOperationException(String.Format(CultureInfo.InvariantCulture,
                    AtlasWeb.ExtenderControl_TargetControlIDEmpty, ID));
            }

            Control targetControl = FindControl(TargetControlID);
            if (targetControl == null) {
                throw new InvalidOperationException(String.Format(CultureInfo.InvariantCulture,
                    AtlasWeb.ExtenderControl_TargetControlIDInvalid, ID, TargetControlID));
            }

            // Check if the target control and its extender are in the same UpdatePanel if any:
            if (FindUpdatePanel(this) != FindUpdatePanel(targetControl)) {
                throw new InvalidOperationException(AtlasWeb.ExtenderControl_TargetControlDifferentUpdatePanel);
            }

            ScriptManager.RegisterExtenderControl(this, targetControl);
        }

        protected internal override void Render(HtmlTextWriter writer) {
            base.Render(writer);

            // DevDiv 97460: ScriptDescriptors only render if in server form, verify to avoid silently failing.
            IPage.VerifyRenderingInServerForm(this);

            // ScriptManager cannot be found in DesignMode, so do not attempt to register scripts.
            if (!DesignMode) {
                ScriptManager.RegisterScriptDescriptors(this);
            }
        }

        protected abstract IEnumerable<ScriptDescriptor> GetScriptDescriptors(Control targetControl);

        [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
            Justification = "Implementation will likely return a new collection, which is too slow for a property")]
        protected abstract IEnumerable<ScriptReference> GetScriptReferences();

        #region IExtenderControl Members
        IEnumerable<ScriptDescriptor> IExtenderControl.GetScriptDescriptors(Control targetControl) {
            return GetScriptDescriptors(targetControl);
        }

        IEnumerable<ScriptReference> IExtenderControl.GetScriptReferences() {
            return GetScriptReferences();
        }
        #endregion
    }
}