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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
|
//------------------------------------------------------------------------------
// <copyright file="WebPartConnection.cs" company="Microsoft">
// Copyright (c) Microsoft Corporation. All rights reserved.
// </copyright>
//------------------------------------------------------------------------------
namespace System.Web.UI.WebControls.WebParts {
using System;
using System.Collections;
using System.ComponentModel;
using System.Diagnostics;
[
TypeConverter(typeof(ExpandableObjectConverter)),
ParseChildren(true, "Transformers")
]
public sealed class WebPartConnection {
private string _consumerConnectionPointID;
private string _consumerID;
private bool _deleted;
private string _id;
private bool _isActive;
private bool _isShared;
private bool _isStatic;
private string _providerConnectionPointID;
private string _providerID;
private WebPartTransformerCollection _transformers;
private WebPartManager _webPartManager;
public WebPartConnection() {
_isStatic = true;
_isShared = true;
}
// PERF: Consider caching
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
]
public WebPart Consumer {
get {
string consumerID = ConsumerID;
if (consumerID.Length == 0) {
throw new InvalidOperationException(SR.GetString(SR.WebPartConnection_ConsumerIDNotSet));
}
if (_webPartManager != null) {
return _webPartManager.WebParts[consumerID];
}
else {
return null;
}
}
}
// PERF: Consider caching
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
]
public ConsumerConnectionPoint ConsumerConnectionPoint {
get {
WebPart consumer = Consumer;
if (consumer != null && _webPartManager != null) {
return _webPartManager.GetConsumerConnectionPoint(consumer, ConsumerConnectionPointID);
}
else {
return null;
}
}
}
[
DefaultValue(ConnectionPoint.DefaultIDInternal)
]
public string ConsumerConnectionPointID {
get {
//
return (!String.IsNullOrEmpty(_consumerConnectionPointID)) ?
_consumerConnectionPointID : ConnectionPoint.DefaultID;
}
set {
_consumerConnectionPointID = value;
}
}
[
DefaultValue("")
]
public string ConsumerID {
get {
return (_consumerID != null) ? _consumerID : String.Empty;
}
set {
_consumerID = value;
}
}
// True if this connection has been disconnected, but can not actually be removed.
// Either a static or a shared connection.
internal bool Deleted {
get {
return _deleted;
}
set {
_deleted = value;
}
}
[
DefaultValue("")
]
public string ID {
get {
return (_id != null) ? _id : String.Empty;
}
set {
_id = value;
}
}
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
]
public bool IsActive {
get {
return _isActive;
}
}
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
]
public bool IsShared {
get {
return _isShared;
}
}
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
]
public bool IsStatic {
get {
return _isStatic;
}
}
// PERF: Consider caching
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
]
public WebPart Provider {
get {
string providerID = ProviderID;
if (providerID.Length == 0) {
throw new InvalidOperationException(SR.GetString(SR.WebPartConnection_ProviderIDNotSet));
}
if (_webPartManager != null) {
return _webPartManager.WebParts[providerID];
}
else {
return null;
}
}
}
// PERF: Consider caching
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
]
public ProviderConnectionPoint ProviderConnectionPoint {
get {
WebPart provider = Provider;
if (provider != null && _webPartManager != null) {
return _webPartManager.GetProviderConnectionPoint(provider, ProviderConnectionPointID);
}
else {
return null;
}
}
}
[
DefaultValue(ConnectionPoint.DefaultIDInternal)
]
public string ProviderConnectionPointID {
get {
//
return (!String.IsNullOrEmpty(_providerConnectionPointID)) ?
_providerConnectionPointID : ConnectionPoint.DefaultID;
}
set {
_providerConnectionPointID = value;
}
}
[
DefaultValue("")
]
public string ProviderID {
get {
return (_providerID != null) ? _providerID : String.Empty;
}
set {
_providerID = value;
}
}
[
Browsable(false),
DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
]
public WebPartTransformer Transformer {
get {
if (_transformers == null || _transformers.Count == 0) {
return null;
}
else {
return _transformers[0];
}
}
}
/// <internalonly/>
[
Browsable(false),
EditorBrowsable(EditorBrowsableState.Never),
PersistenceMode(PersistenceMode.InnerDefaultProperty),
]
public WebPartTransformerCollection Transformers {
get {
if (_transformers == null) {
_transformers = new WebPartTransformerCollection();
}
return _transformers;
}
}
internal void Activate() {
// This method should only be called on WebPartConnections in the WebPartManager, so
// _webPartManager should never be null.
Debug.Assert(_webPartManager != null);
Transformers.SetReadOnly();
WebPart providerWebPart = Provider;
// Cannot be null because Activate() is only called on valid Connections
Debug.Assert(providerWebPart != null);
WebPart consumerWebPart = Consumer;
// Cannot be null because Activate() is only called on valid Connections
Debug.Assert(consumerWebPart != null);
Control providerControl = providerWebPart.ToControl();
Control consumerControl = consumerWebPart.ToControl();
ProviderConnectionPoint providerConnectionPoint = ProviderConnectionPoint;
// Cannot be null because Activate() is only called on valid Connections
Debug.Assert(providerConnectionPoint != null);
if (!providerConnectionPoint.GetEnabled(providerControl)) {
consumerWebPart.SetConnectErrorMessage(SR.GetString(SR.WebPartConnection_DisabledConnectionPoint, providerConnectionPoint.DisplayName, providerWebPart.DisplayTitle));
return;
}
ConsumerConnectionPoint consumerConnectionPoint = ConsumerConnectionPoint;
// Cannot be null because Activate() is only called on valid Connections
Debug.Assert(consumerConnectionPoint != null);
if (!consumerConnectionPoint.GetEnabled(consumerControl)) {
consumerWebPart.SetConnectErrorMessage(SR.GetString(SR.WebPartConnection_DisabledConnectionPoint, consumerConnectionPoint.DisplayName, consumerWebPart.DisplayTitle));
return;
}
// Do not activate connections involving closed WebParts
if (!providerWebPart.IsClosed && !consumerWebPart.IsClosed) {
WebPartTransformer transformer = Transformer;
if (transformer == null) {
if (providerConnectionPoint.InterfaceType == consumerConnectionPoint.InterfaceType) {
ConnectionInterfaceCollection secondaryInterfaces = providerConnectionPoint.GetSecondaryInterfaces(providerControl);
if (consumerConnectionPoint.SupportsConnection(consumerControl, secondaryInterfaces)) {
object dataObject = providerConnectionPoint.GetObject(providerControl);
consumerConnectionPoint.SetObject(consumerControl, dataObject);
_isActive = true;
}
else {
consumerWebPart.SetConnectErrorMessage(SR.GetString(SR.WebPartConnection_IncompatibleSecondaryInterfaces, new string[] {
consumerConnectionPoint.DisplayName, consumerWebPart.DisplayTitle,
providerConnectionPoint.DisplayName, providerWebPart.DisplayTitle}));
}
}
else {
consumerWebPart.SetConnectErrorMessage(SR.GetString(SR.WebPartConnection_NoCommonInterface, new string[] {
providerConnectionPoint.DisplayName, providerWebPart.DisplayTitle,
consumerConnectionPoint.DisplayName, consumerWebPart.DisplayTitle}));
}
}
else {
Type transformerType = transformer.GetType();
if (!_webPartManager.AvailableTransformers.Contains(transformerType)) {
string errorMessage;
if (_webPartManager.Context != null && _webPartManager.Context.IsCustomErrorEnabled) {
errorMessage = SR.GetString(SR.WebPartConnection_TransformerNotAvailable);
}
else {
errorMessage = SR.GetString(SR.WebPartConnection_TransformerNotAvailableWithType, transformerType.FullName);
}
consumerWebPart.SetConnectErrorMessage(errorMessage);
//
}
// Check matching interfaces on connection points and transformer attribute
Type transformerConsumerType = WebPartTransformerAttribute.GetConsumerType(transformerType);
Type transformerProviderType = WebPartTransformerAttribute.GetProviderType(transformerType);
if (providerConnectionPoint.InterfaceType == transformerConsumerType &&
transformerProviderType == consumerConnectionPoint.InterfaceType) {
// A transformer never provides any secondary interfaces
if (consumerConnectionPoint.SupportsConnection(consumerControl, ConnectionInterfaceCollection.Empty)) {
object dataObject = providerConnectionPoint.GetObject(providerControl);
object transformedObject = transformer.Transform(dataObject);
consumerConnectionPoint.SetObject(consumerControl, transformedObject);
_isActive = true;
}
else {
consumerWebPart.SetConnectErrorMessage(SR.GetString(SR.WebPartConnection_ConsumerRequiresSecondaryInterfaces,
consumerConnectionPoint.DisplayName, consumerWebPart.DisplayTitle));
}
}
else if (providerConnectionPoint.InterfaceType != transformerConsumerType) {
string errorMessage;
if (_webPartManager.Context != null && _webPartManager.Context.IsCustomErrorEnabled) {
errorMessage = SR.GetString(SR.WebPartConnection_IncompatibleProviderTransformer,
providerConnectionPoint.DisplayName, providerWebPart.DisplayTitle);
}
else {
errorMessage = SR.GetString(SR.WebPartConnection_IncompatibleProviderTransformerWithType,
providerConnectionPoint.DisplayName, providerWebPart.DisplayTitle, transformerType.FullName);
}
consumerWebPart.SetConnectErrorMessage(errorMessage);
}
else {
string errorMessage;
if (_webPartManager.Context != null && _webPartManager.Context.IsCustomErrorEnabled) {
errorMessage = SR.GetString(SR.WebPartConnection_IncompatibleConsumerTransformer,
consumerConnectionPoint.DisplayName, consumerWebPart.DisplayTitle);
}
else {
errorMessage = SR.GetString(SR.WebPartConnection_IncompatibleConsumerTransformerWithType,
transformerType.FullName, consumerConnectionPoint.DisplayName, consumerWebPart.DisplayTitle);
}
consumerWebPart.SetConnectErrorMessage(errorMessage);
}
}
}
}
internal bool ConflictsWith(WebPartConnection otherConnection) {
return (ConflictsWithConsumer(otherConnection) || ConflictsWithProvider(otherConnection));
}
internal bool ConflictsWithConsumer(WebPartConnection otherConnection) {
return (!ConsumerConnectionPoint.AllowsMultipleConnections &&
Consumer == otherConnection.Consumer &&
ConsumerConnectionPoint == otherConnection.ConsumerConnectionPoint);
}
internal bool ConflictsWithProvider(WebPartConnection otherConnection) {
return (!ProviderConnectionPoint.AllowsMultipleConnections &&
Provider == otherConnection.Provider &&
ProviderConnectionPoint == otherConnection.ProviderConnectionPoint);
}
internal void SetIsShared(bool isShared) {
_isShared = isShared;
}
internal void SetIsStatic(bool isStatic) {
_isStatic = isStatic;
}
internal void SetTransformer(WebPartTransformer transformer) {
if (Transformers.Count == 0) {
Transformers.Add(transformer);
}
else {
Transformers[0] = transformer;
}
}
internal void SetWebPartManager(WebPartManager webPartManager) {
_webPartManager = webPartManager;
}
// Return the short typename, to improve the look of the collection editor in the designer
public override string ToString () {
return GetType().Name;
}
}
}
|