mcs/class/referencesource/System.Web.Entity.Design/System/Data/WebControls/Design/EntityDataSourceConfigureObjectContextPanel.cs

   1 //------------------------------------------------------------------------------
   2 // <copyright file="EntityDataSourceConfigureObjectContextPanel.cs" company="Microsoft">
   3 //     Copyright (c) Microsoft Corporation.  All rights reserved.
   4 // </copyright>
   5 //
   6 // @owner       Microsoft
   7 // @backupOwner Microsoft
   8 //------------------------------------------------------------------------------
   9
  10 using System.Collections.Generic;
  11 using System.Web.UI.Design.WebControls.Util;
  12 using System.Diagnostics;
  13 using System.Drawing;
  14 using System.Windows.Forms;
  15
  16 namespace System.Web.UI.Design.WebControls
  17 {
  18     internal partial class EntityDataSourceConfigureObjectContextPanel : WizardPanel
  19     {
  20         private EntityDataSourceConfigureObjectContext _configureObjectContext;
  21         private bool _ignoreEvents; // used when a control value is set by the wizard, tells the event handlers to do nothing
  22         private bool _connectionInEdit; // indicates that a change has been made to the connection and it has not yet been validated
  23
  24         #region Constructors
  25         internal EntityDataSourceConfigureObjectContextPanel()
  26         {
  27             InitializeComponent();
  28             InitializeUI();
  29             InitializeTabIndexes();
  30         }
  31         #endregion
  32
  33         #region General initialization
  34         internal void Register(EntityDataSourceConfigureObjectContext configureObjectContext)
  35         {
  36             _configureObjectContext = configureObjectContext;
  37         }
  38         #endregion
  39
  40         #region Control Initialization
  41         private void InitializeSizes()
  42         {
  43             int top = 25;
  44
  45             _databaseConnectionGroupLabel.Location = new Point(10, top);
  46             _databaseConnectionGroupLabel.Size = new Size(500, 13);
  47             top = _databaseConnectionGroupLabel.Bottom;
  48
  49             _databaseConnectionGroupBox.Location = new Point(13, top);
  50             _databaseConnectionGroupBox.Size = new Size(503, 124);
  51             top = 0; // rest of controls in this group are positioned relative to the group box, so top resets
  52
  53             _namedConnectionRadioButton.Location = new Point(9, top + 20);
  54             _namedConnectionRadioButton.Size = new Size(116, 17);
  55             top = _namedConnectionRadioButton.Bottom;
  56
  57             _namedConnectionComboBox.Location = new Point(25, top + 6);
  58             _namedConnectionComboBox.Size = new Size(454, 21);
  59             top = _namedConnectionComboBox.Bottom;
  60
  61             _connectionStringRadioButton.Location = new Point(9, top + 6);
  62             _connectionStringRadioButton.Size = new Size(109, 17);
  63             top = _connectionStringRadioButton.Bottom;
  64
  65             _connectionStringTextBox.Location = new Point(25, top + 6);
  66             _connectionStringTextBox.Size = new Size(454, 20);
  67             top = _databaseConnectionGroupBox.Bottom;
  68
  69             _containerNameLabel.Location = new Point(10, top + 30);
  70             _containerNameLabel.Size = new Size(117, 13);
  71             top = _containerNameLabel.Bottom;
  72
  73             _containerNameComboBox.Location = new Point(13, top + 3);
  74             _containerNameComboBox.Size = new Size(502, 21);
  75             // if any controls are added, top should be reset to _containerNameComboBox.Bottom before adding them here
  76         }
  77
  78         private void InitializeTabIndexes()
  79         {
  80             _databaseConnectionGroupLabel.TabStop = false;
  81             _databaseConnectionGroupBox.TabStop = false;
  82             _namedConnectionComboBox.TabStop = true;
  83             _connectionStringTextBox.TabStop = true;
  84             _containerNameLabel.TabStop = false;
  85             _containerNameComboBox.TabStop = true;
  86
  87             int tabIndex = 0;
  88             _databaseConnectionGroupLabel.TabIndex = tabIndex += 10;
  89             _databaseConnectionGroupBox.TabIndex = tabIndex += 10;
  90             _namedConnectionRadioButton.TabIndex = tabIndex += 10;
  91             _namedConnectionComboBox.TabIndex = tabIndex += 10;
  92             _connectionStringRadioButton.TabIndex = tabIndex += 10;
  93             _connectionStringTextBox.TabIndex = tabIndex += 10;
  94             _containerNameLabel.TabIndex = tabIndex += 10;
  95             _containerNameComboBox.TabIndex = tabIndex += 10;
  96         }
  97
  98         private void InitializeUI()
  99         {
 100             this._databaseConnectionGroupLabel.Text = Strings.Wizard_ObjectContextPanel_ConnectionStringGroupDescription;
 101             this._connectionStringRadioButton.Text = Strings.Wizard_ObjectContextPanel_ConnectionStringRadioButton;
 102             this._connectionStringRadioButton.AccessibleName = Strings.Wizard_ObjectContextPanel_ConnectionStringRadioButtonAccessibleName;
 103             this._connectionStringTextBox.AccessibleName = Strings.Wizard_ObjectContextPanel_ConnectionStringRadioButtonAccessibleName;
 104             this._namedConnectionRadioButton.Text = Strings.Wizard_ObjectContextPanel_NamedConnectionRadioButton;
 105             this._namedConnectionRadioButton.AccessibleName = Strings.Wizard_ObjectContextPanel_NamedConnectionRadioButtonAccessibleName;
 106             this._namedConnectionComboBox.AccessibleName = Strings.Wizard_ObjectContextPanel_NamedConnectionRadioButtonAccessibleName;
 107             this._containerNameLabel.Text = Strings.Wizard_ObjectContextPanel_DefaultContainerName;
 108             this._containerNameComboBox.AccessibleName = Strings.Wizard_ObjectContextPanel_DefaultContainerNameAccessibleName;
 109             this.Caption = Strings.Wizard_ObjectContextPanel_Caption;
 110             this.AccessibleName = Strings.Wizard_ObjectContextPanel_Caption;
 111         }
 112         #endregion
 113
 114         #region Control Event Handlers
 115         private void OnConnectionStringRadioButton_CheckedChanged(object sender, EventArgs e)
 116         {
 117             if (!_ignoreEvents)
 118             {
 119                 if (_connectionStringRadioButton.Checked)
 120                 {
 121                     // Update the state of the controls that are associated with the radio buttons
 122                     _namedConnectionComboBox.Enabled = false;
 123                     _connectionStringTextBox.Enabled = true;
 124
 125                     EnterConnectionEditMode();
 126
 127                     // Update the flag to track if we have text in the box
 128                     _configureObjectContext.SelectConnectionStringHasValue(!String.IsNullOrEmpty(_connectionStringTextBox.Text));
 129
 130                     // Move the focus to the associated TextBox
 131                     _connectionStringTextBox.Select();
 132                     _connectionStringTextBox.Select(0, _connectionStringTextBox.TextLength);
 133                 }
 134             }
 135             // else it's being unchecked, so that means another radio button is being checked and that handler will take care of updating the state
 136         }
 137
 138         private void OnConnectionStringTextBox_TextChanged(object sender, EventArgs e)
 139         {
 140             if (!_ignoreEvents)
 141             {
 142                 // If we aren't already in edit mode, move to it that we will know we need to reload metadata if it's needed later
 143                 if (!_connectionInEdit)
 144                 {
 145                     EnterConnectionEditMode();
 146                 }
 147
 148                 // Update the state of the flag that tracks if there is anything in this TextBox.
 149                 // This will cause the Next button to be disabled if all of the text is removed from the box, otherwise it is enabled
 150                 _configureObjectContext.SelectConnectionStringHasValue(!String.IsNullOrEmpty(_connectionStringTextBox.Text));
 151             }
 152         }
 153
 154         private void OnNamedConnectionRadioButton_CheckedChanged(object sender, EventArgs e)
 155         {
 156             if (!_ignoreEvents)
 157             {
 158                 if (_namedConnectionRadioButton.Checked)
 159                 {
 160                     // update the controls that are associated with the radio buttons
 161                     _namedConnectionComboBox.Enabled = true;
 162                     _connectionStringTextBox.Enabled = false;
 163
 164                     EnterConnectionEditMode();
 165
 166                     // Update flag to indicate if there is a value selected in this box
 167                     _configureObjectContext.SelectConnectionStringHasValue(_namedConnectionComboBox.SelectedIndex != -1);
 168
 169                     // Move the focus to the associated ComboBox
 170                     _namedConnectionComboBox.Select();
 171
 172                     // If there is a selected NamedConnection, validate the connection string right away
 173                     // so that we can potentially select the default container name if there is one
 174                     if (_namedConnectionComboBox.SelectedIndex != -1)
 175                     {
 176                         VerifyConnectionString();
 177                     }
 178                 }
 179                 // else it's being unchecked, so that means another radio button is being checked and that handler will take care of updating the state
 180             }
 181         }
 182
 183         private void OnNamedConnectionComboBox_SelectedIndexChanged(object sender, EventArgs e)
 184         {
 185             if (!_ignoreEvents)
 186             {
 187                 EnterConnectionEditMode();
 188
 189                 // Update flag to indicate if there is a value selected in this box
 190                 _configureObjectContext.SelectConnectionStringHasValue(_namedConnectionComboBox.SelectedIndex != -1);
 191
 192                 // If there is a selected NamedConnection, validate the connection string right away
 193                 // so that we can potentially select the default container name if there is one
 194                 if (_namedConnectionComboBox.SelectedIndex != -1)
 195                 {
 196                     VerifyConnectionString();
 197                 }
 198             }
 199         }
 200
 201         private void OnContainerNameComboBox_Enter(object sender, EventArgs e)
 202         {
 203             if (!_ignoreEvents)
 204             {
 205                 VerifyConnectionString();
 206             }
 207         }
 208
 209         private void OnContainerNameComboBox_SelectedIndexChanged(object sender, EventArgs e)
 210         {
 211             if (!_ignoreEvents)
 212             {
 213                 _configureObjectContext.SelectContainerName(_containerNameComboBox.SelectedItem as EntityDataSourceContainerNameItem);
 214             }
 215         }
 216
 217         // Move to edit mode so that we will know we need to reload metadata if it's needed later
 218         private void EnterConnectionEditMode()
 219         {
 220             _connectionInEdit = true;
 221             _containerNameComboBox.SelectedIndex = -1;
 222         }
 223
 224         private void LeaveConnectionEditMode()
 225         {
 226             _connectionInEdit = false;
 227         }
 228
 229         /// <summary>
 230         /// Verify the selected connection string and load the metadata for it if it is successfully verified
 231         /// </summary>
 232         /// <returns>True if the metadata was successfully loaded from the connection string</returns>
 233         private bool VerifyConnectionString()
 234         {
 235             try
 236             {
 237                 Cursor.Current = Cursors.WaitCursor;
 238                 if (_connectionInEdit)
 239                 {
 240                     bool isNamedConnection = _namedConnectionRadioButton.Checked;
 241                     Debug.Assert(!isNamedConnection ? _connectionStringRadioButton.Checked : true, "only expecting either named connection or connection string radio button options");
 242
 243                     EntityConnectionStringBuilderItem selectedConnection = null;
 244                     if (isNamedConnection)
 245                     {
 246                         if (_namedConnectionComboBox.SelectedIndex != -1)
 247                         {
 248                             selectedConnection = _namedConnectionComboBox.SelectedItem as EntityConnectionStringBuilderItem;
 249                         }
 250                     }
 251                     else
 252                     {
 253                         // Make a builder item out of the specified connection string. This will do some basic verification on the string.
 254                         selectedConnection = _configureObjectContext.GetEntityConnectionStringBuilderItem(_connectionStringTextBox.Text);
 255                     }
 256
 257                     if (selectedConnection != null)
 258                     {
 259                         bool metadataLoaded = _configureObjectContext.SelectConnectionStringBuilder(selectedConnection, true /*resetContainer*/);
 260
 261                         // If verification failed, try to move the focus back to the appropriate control.
 262                         if (!metadataLoaded)
 263                         {
 264                             if (_namedConnectionRadioButton.Checked)
 265                             {
 266                                 _namedConnectionComboBox.Select();
 267                             }
 268                             else
 269                             {
 270                                 _connectionStringTextBox.Select();
 271                                 _connectionStringTextBox.Select(0, _connectionStringTextBox.TextLength);
 272                             }
 273                         }
 274                     }
 275
 276                     // Leave connection edit mode regardless of whether the metadata was loaded or not, because there is no need to keep trying
 277                     // to validated it over and over again unless the user makes a change that puts it back into edit mode again
 278                     LeaveConnectionEditMode();
 279                 }
 280
 281                 return true;
 282             }
 283             finally
 284             {
 285                 Cursor.Current = Cursors.Default;
 286             }
 287         }
 288         #endregion
 289
 290         #region Wizard state management
 291         public override bool OnNext()
 292         {
 293             Debug.Assert(_configureObjectContext.CanEnableNext, "OnNext called when CanEnableNext is false");
 294
 295             return VerifyConnectionString();
 296         }
 297
 298         protected override void OnVisibleChanged(EventArgs e)
 299         {
 300             base.OnVisibleChanged(e);
 301
 302             if (Visible)
 303             {
 304                 _configureObjectContext.UpdateWizardState();
 305             }
 306         }
 307         #endregion
 308
 309         #region Methods for setting control values
 310         // Expects that the specified builder item is a named connection already in the list, is a full connection string, or is empty
 311         // If empty, the default is to select the named connection option and don't select anything in the list
 312         internal void SetConnectionString(EntityConnectionStringBuilderItem connStrBuilderItem)
 313         {
 314             Debug.Assert(connStrBuilderItem != null, "expected non-null connStrBuilderItem");
 315
 316             _ignoreEvents = true;
 317
 318             // set the state of the ConnectionString radio buttons and associated controls
 319             bool isNamedConnection = connStrBuilderItem.IsEmpty || connStrBuilderItem.IsNamedConnection;
 320
 321             _namedConnectionRadioButton.Checked = isNamedConnection;
 322             _namedConnectionComboBox.Enabled = isNamedConnection;
 323             _connectionStringRadioButton.Checked = !isNamedConnection;
 324             _connectionStringTextBox.Enabled = !isNamedConnection;
 325
 326             // set the value of the control that was just enabled
 327             if (connStrBuilderItem.IsEmpty)
 328             {
 329                 _namedConnectionComboBox.SelectedIndex = -1;
 330                 _configureObjectContext.SelectConnectionStringHasValue(false /*connectionStringHasValue*/);
 331             }
 332             else if (connStrBuilderItem.IsNamedConnection)
 333             {
 334                 _namedConnectionComboBox.SelectedItem = connStrBuilderItem;
 335                 _configureObjectContext.SelectConnectionStringHasValue(true /*connectionStringHasValue*/);
 336             }
 337             else
 338             {
 339                 _connectionStringTextBox.Text = connStrBuilderItem.ConnectionString;
 340                 _configureObjectContext.SelectConnectionStringHasValue(!connStrBuilderItem.IsEmpty);
 341             }
 342
 343             _ignoreEvents = false;
 344         }
 345
 346         internal void SetContainerNames(List<EntityDataSourceContainerNameItem> containerNames)
 347         {
 348             _ignoreEvents = true;
 349             _containerNameComboBox.Items.Clear();
 350             _containerNameComboBox.Items.AddRange(containerNames.ToArray());
 351             _ignoreEvents = false;
 352         }
 353
 354         internal void SetNamedConnections(List<EntityConnectionStringBuilderItem> namedConnections)
 355         {
 356             _ignoreEvents = true;
 357             _namedConnectionComboBox.Items.AddRange(namedConnections.ToArray());
 358             _ignoreEvents = false;
 359         }
 360
 361         /// <summary>
 362         /// Expects that selectedContainer is already in the ComboBox list, or should be null
 363         /// </summary>
 364         /// <param name="selectedContainer"></param>
 365         /// <param name="initialLoad">If this is the initial load, we want to suppress events so that the change does
 366         /// not cause additional work in panels that listen to the container name changed event</param>
 367         internal void SetSelectedContainerName(EntityDataSourceContainerNameItem selectedContainer, bool initialLoad)
 368         {
 369             if (initialLoad)
 370             {
 371                 _ignoreEvents = true;
 372             }
 373             if (selectedContainer == null)
 374             {
 375                 _containerNameComboBox.SelectedIndex = -1;
 376             }
 377             else
 378             {
 379                 _containerNameComboBox.SelectedItem = selectedContainer;
 380             }
 381             _ignoreEvents = false;
 382         }
 383         #endregion
 384     }
 385 }