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
|
//------------------------------------------------------------------------------
// <copyright file="HotSpot.cs" company="Microsoft">
// Copyright (c) Microsoft Corporation. All rights reserved.
// </copyright>
//------------------------------------------------------------------------------
namespace System.Web.UI.WebControls {
using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing.Design;
using System.Web.UI;
using System.Globalization;
/// <devdoc>
/// <para>Defines abstract class from which all HotSpot shapes must inherit.</para>
/// </devdoc>
[
TypeConverter(typeof(ExpandableObjectConverter))
]
public abstract class HotSpot : IStateManager {
private bool _isTrackingViewState;
private StateBag _viewState;
/// <devdoc>
/// <para>Gets or sets the keyboard shortcut key (AccessKey) for setting focus to the
/// HotSpot.</para>
/// </devdoc>
[
DefaultValue(""),
Localizable(true),
WebCategory("Accessibility"),
WebSysDescription(SR.HotSpot_AccessKey)
]
public virtual string AccessKey {
get {
string s = (string)ViewState["AccessKey"];
if (s != null) {
return s;
}
return String.Empty;
}
set {
// Valid values are null, String.Empty, and single character strings
if ((value != null) && (value.Length > 1)) {
throw new ArgumentOutOfRangeException("value");
}
ViewState["AccessKey"] = value;
}
}
/// <devdoc>
/// <para>Gets or sets the tool tip displayed over the
/// hotspot and the text for device-specific display.</para>
/// </devdoc>
[
Localizable(true),
Bindable(true),
WebCategory("Behavior"),
DefaultValue(""),
WebSysDescription(SR.HotSpot_AlternateText),
NotifyParentProperty(true)
]
public virtual String AlternateText {
get {
object text = ViewState["AlternateText"];
return (text == null)? String.Empty : (string)text;
}
set {
ViewState["AlternateText"] = value;
}
}
/// <devdoc>
/// <para>Gets or sets the HotSpotMode to either postback or navigation.</para>
/// </devdoc>
[
WebCategory("Behavior"),
DefaultValue(HotSpotMode.NotSet),
WebSysDescription(SR.HotSpot_HotSpotMode),
NotifyParentProperty(true)
]
public virtual HotSpotMode HotSpotMode {
get {
object obj = ViewState["HotSpotMode"];
return (obj == null) ? HotSpotMode.NotSet : (HotSpotMode)obj;
}
set {
if (value < HotSpotMode.NotSet || value > HotSpotMode.Inactive) {
throw new ArgumentOutOfRangeException("value");
}
ViewState["HotSpotMode"] = value;
}
}
/// <devdoc>
/// <para>Gets or sets the argument for postback event.</para>
/// </devdoc>
[
Bindable(true),
WebCategory("Behavior"),
DefaultValue(""),
WebSysDescription(SR.HotSpot_PostBackValue),
NotifyParentProperty(true)
]
public String PostBackValue {
get {
object value = ViewState["PostBackValue"];
return (value == null)? String.Empty : (string)value;
}
set {
ViewState["PostBackValue"] = value;
}
}
/// <devdoc>
/// <para>Gets the markup language string representation of the shape name.</para>
/// </devdoc>
protected internal abstract string MarkupName {
get;
}
/// <devdoc>
/// <para>Gets or sets the navigation url.</para>
/// </devdoc>
[
Bindable(true),
WebCategory("Behavior"),
DefaultValue(""),
WebSysDescription(SR.HotSpot_NavigateUrl),
NotifyParentProperty(true),
UrlProperty(),
Editor("System.Web.UI.Design.UrlEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor)),
]
public String NavigateUrl {
get {
object value = ViewState["NavigateUrl"];
return (value == null)? String.Empty : (string)value;
}
set {
ViewState["NavigateUrl"] = value;
}
}
/// <devdoc>
/// <para>
/// Gets or
/// sets the tab index of the HotSpot.</para>
/// </devdoc>
[
DefaultValue((short)0),
WebCategory("Accessibility"),
WebSysDescription(SR.HotSpot_TabIndex)
]
public virtual short TabIndex {
get {
object o = ViewState["TabIndex"];
if (o != null) {
return (short) o;
}
return (short)0;
}
set {
ViewState["TabIndex"] = value;
}
}
/// <devdoc>
/// <para>Gets or sets the name of the window for navigation.</para>
/// </devdoc>
[
WebCategory("Behavior"),
DefaultValue(""),
TypeConverter(typeof(TargetConverter)),
WebSysDescription(SR.HotSpot_Target),
NotifyParentProperty(true)
]
public virtual string Target {
get {
object value = ViewState["Target"];
return (value == null)? String.Empty : (string)value;
}
set {
ViewState["Target"] = value;
}
}
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)
]
protected StateBag ViewState {
get {
if (_viewState == null) {
_viewState = new StateBag(false);
if (_isTrackingViewState) ((IStateManager)_viewState).TrackViewState();
}
return _viewState;
}
}
/// <devdoc>
/// <para>Returns a representation of the coordinates according to HTML standards.</para>
/// </devdoc>
public abstract string GetCoordinates();
internal void SetDirty() {
if (_viewState != null) {
_viewState.SetDirty(true);
}
}
public override string ToString () {
return GetType().Name;
}
#region IStatemanager implementation
/// <devdoc>
/// <para>Gets a value indicating whether a server control is tracking its view state changes.</para>
/// </devdoc>
protected virtual bool IsTrackingViewState {
get {
return _isTrackingViewState;
}
}
/// <devdoc>
/// <para>Restores view-state information that was saved by SaveViewState.</para>
/// </devdoc>
protected virtual void LoadViewState(object savedState) {
if (savedState != null) {
ViewState.LoadViewState(savedState);
}
}
/// <devdoc>
/// <para>Saves any server control view-state changes that have
/// occurred since the time the page was posted back to the server.</para>
/// </devdoc>
protected virtual object SaveViewState() {
if (_viewState != null) {
return _viewState.SaveViewState();
}
return null;
}
/// <devdoc>
/// <para>Causes the tracking of view-state changes to the server control.</para>
/// </devdoc>
protected virtual void TrackViewState() {
_isTrackingViewState = true;
if (_viewState != null) {
_viewState.TrackViewState();
}
}
// private implementation of IStateManager
/// <internalonly/>
bool IStateManager.IsTrackingViewState {
get {
return IsTrackingViewState;
}
}
/// <internalonly/>
void IStateManager.LoadViewState(object savedState) {
LoadViewState(savedState);
}
/// <internalonly/>
object IStateManager.SaveViewState() {
return SaveViewState();
}
/// <internalonly/>
void IStateManager.TrackViewState() {
TrackViewState();
}
#endregion
}
}
|