Export (0) Print
Expand All

DomainUpDown Class

Represents a Windows up-down control that displays string values.

For a list of all members of this type, see DomainUpDown Members.

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Windows.Forms.Control
            System.Windows.Forms.ScrollableControl
               System.Windows.Forms.ContainerControl
                  System.Windows.Forms.UpDownBase
                     System.Windows.Forms.DomainUpDown

[Visual Basic]
Public Class DomainUpDown
   Inherits UpDownBase
[C#]
public class DomainUpDown : UpDownBase
[C++]
public __gc class DomainUpDown : public UpDownBase
[JScript]
public class DomainUpDown extends UpDownBase

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Remarks

A DomainUpDown control displays a single string value that is selected from an Object collection by clicking the up or down buttons of the control. The user can also enter text in the control, unless the ReadOnly property is set to true (the string typed in must match an item in the collection to be accepted). When an item is selected, the object is converted to a string value so it can be displayed in the up-down control.

To create a collection of objects to display in the DomainUpDown control, you can add or remove the items individually by using the Add and Remove methods. This can be called in an event handler, such as the Click of a button. The object collection can be sorted alphabetically by setting the Sorted property to true. When Wrap is set to true, if you scroll past the last or first object in the collection, the list will start over with the first or last object respectively and appear to roll in a continuous list.

When the UpButton or DownButton methods are called, either in code or by the click of the up or down buttons, UpdateEditText is called to update the control with the new string. If UserEdit is set to true, the string is matched to one of the values in the collection prior to updating the control's text display.

Example

[Visual Basic, C#, C++] The following example creates and initializes a DomainUpDown control. The example allows you to set some of its properties and create a collection of strings for display in the up-down control. The code assumes that a TextBox, CheckBox and a Button have been instantiated on a form. The example also assumes that you have a member variable at the class level declared as a 32-bit signed integer named myCounter. You can enter a string in the text box and add it to the Items collection when the button is clicked. By clicking the check box, you can toggle the Sorted property and observe the difference in the collection of items in the up-down control.

[Visual Basic] 
Protected domainUpDown1 As DomainUpDown


Private Sub MySub()
    ' Create and initialize the DomainUpDown control.
    domainUpDown1 = New System.Windows.Forms.DomainUpDown()
    
    ' Add the DomainUpDown control to the form.
    Controls.Add(domainUpDown1)
End Sub 'MySub


Private Sub button1_Click(sender As System.Object, e As System.EventArgs)
    ' Add the text box contents and initial location in the collection
    ' to the DomainUpDown control.
    domainUpDown1.Items.Add((textBox1.Text.Trim() & " - " & myCounter))
    
    ' Increment the counter variable.
    myCounter = myCounter + 1
    
    ' Clear the TextBox.
    textBox1.Text = ""
End Sub 'button1_Click


Private Sub checkBox1_Click(sender As System.Object, e As System.EventArgs)
    ' If Sorted is set to true, set it to false; 
    ' otherwise set it to true.
    If domainUpDown1.Sorted Then
        domainUpDown1.Sorted = False
    Else
        domainUpDown1.Sorted = True
    End If
End Sub 'checkBox1_Click


Private Sub domainUpDown1_SelectedItemChanged _
    (sender As System.Object, e As System.EventArgs)
    
    ' Display the SelectedIndex and SelectedItem property values in a MessageBox.
    MessageBox.Show(("SelectedIndex: " & domainUpDown1.SelectedIndex.ToString() & _
        ControlChars.Cr & "SelectedItem: " & domainUpDown1.SelectedItem.ToString()))
End Sub 'domainUpDown1_SelectedItemChanged

[C#] 
protected DomainUpDown domainUpDown1;

private void MySub()
 {
    // Create and initialize the DomainUpDown control.
    domainUpDown1 = new System.Windows.Forms.DomainUpDown();
    
    // Add the DomainUpDown control to the form.
    Controls.Add(domainUpDown1);
 }
 
 private void button1_Click(System.Object sender, 
                           System.EventArgs e)
 {   
    // Add the text box contents and initial location in the collection
    // to the DomainUpDown control.
    domainUpDown1.Items.Add((textBox1.Text.Trim()) + " - " + myCounter);
    
    // Increment the counter variable.
    myCounter = myCounter + 1;
 
    // Clear the TextBox.
    textBox1.Text = "";
 }
 
 private void checkBox1_Click(System.Object sender, 
                             System.EventArgs e)
 {
    // If Sorted is set to true, set it to false; 
    // otherwise set it to true.
    if (domainUpDown1.Sorted)
    {
       domainUpDown1.Sorted = false;
    }
    else
    {
       domainUpDown1.Sorted = true;
    }
 }
 
 private void domainUpDown1_SelectedItemChanged(System.Object sender, 
                                               System.EventArgs e)
 {
    // Display the SelectedIndex and SelectedItem property values in a MessageBox.
    MessageBox.Show("SelectedIndex: " + domainUpDown1.SelectedIndex.ToString() 
       + "\n" + "SelectedItem: " + domainUpDown1.SelectedItem.ToString());
 }


[C++] 
protected:
    DomainUpDown __gc *domainUpDown1;

private:
    void MySub() {
        // Create and initialize the DomainUpDown control.
        domainUpDown1 = new System::Windows::Forms::DomainUpDown();
    
        // Add the DomainUpDown control to the form.
        Controls->Add(domainUpDown1);
    };
 
    void button1_Click(Object *sender, EventArgs *e) {   
        // Add the text box contents and initial location in the collection
        // to the DomainUpDown control.
        domainUpDown1->Items->Add(String::Concat((textBox1->Text->Trim()), S" - ", __box(myCounter)->ToString()));
    
        // Increment the counter variable.
        myCounter = myCounter + 1;
 
        // Clear the TextBox.
        textBox1->Text = S"";
    };
 
    void checkBox1_Click(Object *sender, EventArgs *e) {
        // If Sorted is set to true, set it to false; 
        // otherwise set it to true.
        if (domainUpDown1->Sorted) {
            domainUpDown1->Sorted = false;
        } else {
            domainUpDown1->Sorted = true;
        }
    };
 
    void domainUpDown1_SelectedItemChanged(Object *sender, EventArgs *e) {
        // Display the SelectedIndex and SelectedItem property values in a MessageBox.
        MessageBox::Show(String::Concat(S"SelectedIndex: ", __box(domainUpDown1->SelectedIndex)->ToString(), 
        S"\n", S"SelectedItem: ", domainUpDown1->SelectedItem->ToString()));
    };

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Windows.Forms

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

See Also

DomainUpDown Members | System.Windows.Forms Namespace | UpDownBase | NumericUpDown

Show:
© 2014 Microsoft