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 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
|
//------------------------------------------------------------------------------
// <copyright file="ScriptComponentDescriptor.cs" company="Microsoft">
// Copyright (c) Microsoft Corporation. All rights reserved.
// </copyright>
//------------------------------------------------------------------------------
namespace System.Web.UI {
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Text;
using System.Text.RegularExpressions;
using System.Web;
using System.Web.Resources;
using System.Web.Script.Serialization;
public class ScriptComponentDescriptor : ScriptDescriptor {
// PERF: In the ScriptControl/Properties/Scenario.aspx perf test, SortedList is 2% faster than
// SortedDictionary.
private string _elementIDInternal;
private SortedList<string, string> _events;
private string _id;
private SortedList<string, Expression> _properties;
private bool _registerDispose = true;
private JavaScriptSerializer _serializer;
private string _type;
public ScriptComponentDescriptor(string type) {
if (String.IsNullOrEmpty(type)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "type");
}
_type = type;
}
// Used by ScriptBehaviorDescriptor and ScriptControlDesriptor
internal ScriptComponentDescriptor(string type, string elementID)
: this(type) {
if (String.IsNullOrEmpty(elementID)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "elementID");
}
_elementIDInternal = elementID;
}
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "ID")]
public virtual string ClientID {
get {
return ID;
}
}
internal string ElementIDInternal {
get {
return _elementIDInternal;
}
}
private SortedList<string, string> Events {
get {
if (_events == null) {
_events = new SortedList<string, string>(StringComparer.Ordinal);
}
return _events;
}
}
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "ID")]
public virtual string ID {
get {
return _id ?? String.Empty;
}
set {
_id = value;
}
}
private SortedList<string, Expression> Properties {
get {
if (_properties == null) {
_properties = new SortedList<string, Expression>(StringComparer.Ordinal);
}
return _properties;
}
}
internal bool RegisterDispose {
get {
return _registerDispose;
}
set {
_registerDispose = value;
}
}
private JavaScriptSerializer Serializer {
get {
if (_serializer == null) {
_serializer = new JavaScriptSerializer();
}
return _serializer;
}
}
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods",
Justification = "Refers to a script element, not to Object.GetType()")]
public string Type {
get {
return _type;
}
set {
if (String.IsNullOrEmpty(value)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "value");
}
_type = value;
}
}
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "ID")]
public void AddComponentProperty(string name, string componentID) {
if (String.IsNullOrEmpty(componentID)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "componentID");
}
AddProperty(name, new ComponentReference(componentID));
}
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "ID")]
public void AddElementProperty(string name, string elementID) {
if (String.IsNullOrEmpty(elementID)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "elementID");
}
AddProperty(name, new ElementReference(elementID));
}
public void AddEvent(string name, string handler) {
if (String.IsNullOrEmpty(name)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "name");
}
if (String.IsNullOrEmpty(handler)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "handler");
}
Events[name] = handler;
}
public void AddProperty(string name, object value) {
AddProperty(name, new ObjectReference(value));
}
private void AddProperty(string name, Expression value) {
if (String.IsNullOrEmpty(name)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "name");
}
Debug.Assert(value != null);
Properties[name] = value;
}
public void AddScriptProperty(string name, string script) {
if (String.IsNullOrEmpty(script)) {
throw new ArgumentException(AtlasWeb.Common_NullOrEmpty, "script");
}
AddProperty(name, new ScriptExpression(script));
}
private void AppendEventsScript(StringBuilder builder) {
// PERF: Use field directly to avoid creating Dictionary if not already created
if (_events != null && _events.Count > 0) {
builder.Append('{');
bool first = true;
// Can't use JavaScriptSerializer directly on events dictionary, since the values are
// JavaScript functions and should not be quoted.
foreach (KeyValuePair<string, string> e in _events) {
if (first) {
first = false;
}
else {
builder.Append(',');
}
builder.Append('"');
builder.Append(HttpUtility.JavaScriptStringEncode(e.Key));
builder.Append('"');
builder.Append(':');
builder.Append(e.Value);
}
builder.Append("}");
}
else {
builder.Append("null");
}
}
private void AppendPropertiesScript(StringBuilder builder) {
bool first = true;
// PERF: Use field directly to avoid creating Dictionary if not already created
if (_properties != null && _properties.Count > 0) {
foreach (KeyValuePair<string, Expression> p in _properties) {
if (p.Value.Type == ExpressionType.Script) {
if (first) {
builder.Append("{");
first = false;
}
else {
builder.Append(",");
}
builder.Append('"');
builder.Append(HttpUtility.JavaScriptStringEncode(p.Key));
builder.Append('"');
builder.Append(':');
p.Value.AppendValue(Serializer, builder);
}
}
}
if (first) {
// If we didn't see any properties, append "null"
builder.Append("null");
}
else {
// Else, close the JSON object
builder.Append("}");
}
}
private void AppendReferencesScript(StringBuilder builder) {
bool first = true;
// PERF: Use field directly to avoid creating Dictionary if not already created
if (_properties != null && _properties.Count > 0) {
foreach (KeyValuePair<string, Expression> p in _properties) {
if (p.Value.Type == ExpressionType.ComponentReference) {
if (first) {
builder.Append("{");
first = false;
}
else {
builder.Append(",");
}
builder.Append('"');
builder.Append(HttpUtility.JavaScriptStringEncode(p.Key));
builder.Append('"');
builder.Append(':');
p.Value.AppendValue(Serializer, builder);
}
}
}
if (first) {
// If we didn't see any references, append "null"
builder.Append("null");
}
else {
// Else, close the JSON object
builder.Append("}");
}
}
protected internal override string GetScript() {
const string separator = ", ";
if (!String.IsNullOrEmpty(ID)) {
AddProperty("id", ID);
}
StringBuilder builder = new StringBuilder();
builder.Append("$create(");
builder.Append(Type);
builder.Append(separator);
AppendPropertiesScript(builder);
builder.Append(separator);
AppendEventsScript(builder);
builder.Append(separator);
AppendReferencesScript(builder);
if (ElementIDInternal != null) {
builder.Append(separator);
builder.Append("$get(\"");
builder.Append(HttpUtility.JavaScriptStringEncode(ElementIDInternal));
builder.Append("\")");
}
builder.Append(");");
return builder.ToString();
}
internal override void RegisterDisposeForDescriptor(ScriptManager scriptManager, Control owner) {
if (RegisterDispose && scriptManager.SupportsPartialRendering) {
// If partial rendering is supported, register a JavaScript statement
// that will dispose this component if the UpdatePanel it is inside is
// getting refreshed. Only components need this; controls are associated
// with DOM elements so they get disposed through their 'dispose' expando.
scriptManager.RegisterDispose(owner, "$find('" + ID + "').dispose();");
}
}
private abstract class Expression {
public abstract ExpressionType Type { get; }
public abstract void AppendValue(JavaScriptSerializer serializer, StringBuilder builder);
}
private enum ExpressionType {
Script,
ComponentReference
}
private sealed class ComponentReference : Expression {
private string _componentID;
public ComponentReference(string componentID) {
_componentID = componentID;
}
public override ExpressionType Type {
get {
return ExpressionType.ComponentReference;
}
}
public override void AppendValue(JavaScriptSerializer serializer, StringBuilder builder) {
builder.Append('"');
builder.Append(HttpUtility.JavaScriptStringEncode(_componentID));
builder.Append('"');
}
}
private sealed class ElementReference : Expression {
private string _elementID;
public ElementReference(string elementID) {
_elementID = elementID;
}
public override ExpressionType Type {
get {
return ExpressionType.Script;
}
}
public override void AppendValue(JavaScriptSerializer serializer, StringBuilder builder) {
builder.Append("$get(\"");
builder.Append(HttpUtility.JavaScriptStringEncode(_elementID));
builder.Append("\")");
}
}
private sealed class ObjectReference : Expression {
private object _value;
public ObjectReference(object value) {
_value = value;
}
public override ExpressionType Type {
get {
return ExpressionType.Script;
}
}
public override void AppendValue(JavaScriptSerializer serializer, StringBuilder builder) {
// DevDiv Bugs 96574: pass SerializationFormat.JavaScript to serialize to straight JavaScript,
// so date properties are rendered as dates
serializer.Serialize(_value, builder, JavaScriptSerializer.SerializationFormat.JavaScript);
}
}
private sealed class ScriptExpression : Expression {
private string _script;
public ScriptExpression(string script) {
_script = script;
}
public override ExpressionType Type {
get {
return ExpressionType.Script;
}
}
public override void AppendValue(JavaScriptSerializer serializer, StringBuilder builder) {
builder.Append(_script);
}
}
}
}
|