Why didn't Microsoft include an IP address control in the stock toolbox for Visual Studio .NET? I needed something similar to the MFC
CIPAddressCtrl class in a C# application recently, and was forced to roll my own. I tried to mimic the behavior of
CIPAddressCtrl using C# here, and hopefully I've succeeded.
IPAddressControl is really a composite
UserControl that aggregates four specialized
TextBox controls of type
FieldCtrl and three specialized
Controls of type
DotCtrl. Here's a picture:
FieldCtrls do some validation and keyboard filtering, in addition to standard
TextBox behavior. The
DotCtrls do nothing but draw a dot.
Using the Code
Once the library containing
IPAddressControl (IPAddressControlLib.dll) is built, add the control to the Toolbox in Visual Studio. From the Toolbox, just drag the control onto a form and you're ready to go. The interface to
IPAddressControl is very simple.
Public Instance Properties
sets a value indicating whether the control is automatically sized vertically according to the current font and border. The default value is
gets a value indicating whether all of the fields in the control are empty.
sets the border style of the control. The default value is
sets a value indicating if the control is read-only.
Public Instance Methods
Clear: Clears the contents of the control.
GetAddressBytes: Returns an array of
bytes representing the contents of the fields, index 0 being the leftmost field.
sets the values of the fields using an array of
bytes, index 0 being the leftmost field.
sets the keyboard focus to the specified field in the control.
sets the lower and higher range of a specified field in the control.
The above properties and methods are in addition to the stock properties and methods of
UserControl. Stock properties such as
Font -- as well as stock methods such as
ToString() -- work as expected. The client code can register a handler for the public event,
FieldChangedEvent, to be notified when any text in the fields of the control changes.
ToString() may not return the same value. If there are any empty fields in the control,
Text will return a value that will reflect the empty fields.
ToString() will fill in any empty fields with that field's
RangeLower value. Also, if you are using the control to create an
IPAddress, you can easily do so using this control's
IPAddress ipAddress = new IPAddress( ipAddressControl.GetAddressBytes() );
- 27 Apr 2008
- Added propagation of
Keys.Return will now propagate a
- 23 Oct 2007
ReadOnly should now really be read-only. Thanks to t_suzuki for reporting this bug.
- 27 Sep 2007
- Added proper event propagation for focus, keypress, and some mouse events.
- Removed superfluous code.
- Removed a potential resource leak when calculating text size and added a
null check for
- Compliant with FxCop 1.35.
- 13 Jun 2007
- Text set in design mode is persisted.
- Removed override of
- [VS05] Modified size calculations to conserve horizontal space.
- 6 Mar 2007
- Now checks for
null when parsing incoming text.
- 21 Feb 2007
- Added handling of [Backspace] across fields. Thanks to Antony for reporting this bug.
- Added better handling of [Delete], and new handlers for [Home] and [End].
- [VS05] Modified the
MinimumSize property of
DotControl to tighten up the spacing.
- 5 May 2006
- [VS05] Added
Baseline to the
SnapLines collection for the
ControlDesigner class. Made the
Text property browsable in design mode. Fixed the control sizing bug when large fonts are used.
- 13 Oct 2005
- Compliant with FxCop 1.32.
- 17 Sep 2005
- Enhanced to support Windows XP visual styles. Thanks to Carlos for requesting this.
- 3 Aug 2005
- Bug fix for
Focused property. Thanks to Mario for reporting this.
- 22 Mar 2005
- Added a call to
OnTextChanged() for the control when the text of any field changes. Thanks to Bertrand for pointing that out.
- 6 Feb 2005
- Added missing key handlers. Thanks to Norm and Ed for the heads-up on missing key handlers.
- Added sizing.
- Non-standard color choices now render properly.
- Added an event to notify clients of text change.
- 20 Jan 2005 - Initial release.