Note: A parameterless constructor is required for all derived classes.
OnPropertyChanged will also be called.
The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.
Dim myAppearance As Infragistics.Win.Appearance
myAppearance.BackColor = System.Drawing.Color.Aquamarine
The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.
Dim myAppearance As Infragistics.Win.Appearance
myAppearance.BackColor = System.Drawing.Color.Aquamarine
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.
Dim myAppearance As Infragistics.Win.Appearance
myAppearance.BackColor = System.Drawing.Color.Aquamarine
The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.
Dim myAppearance As Infragistics.Win.Appearance
myAppearance.BackColor = System.Drawing.Color.Aquamarine
By default, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Note: Setting the AutoCloseUpOnEquals property to true does not cause the dropdown to close up when the "=" button is clicked.
Also note that the dropdown closes when the Enter/Return key is pressed, regardless of the value of the AutoCloseUpOnEquals property.
This can be prevented by handling the control's KeyDown event for the Enter/Return key and setting the 'Handled' property of the event arguments to true.
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
Occurs before action occurs, allowing user to cancel default calculation and or change the values
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
Fired on Failure of default calculation.
Note: The Clear method will only function correctly when the
Note: The ClearUndo method will only function correctly when the
Note: The Copy method will only function correctly when the
Note: The Cut method will only function correctly when the
Note: The Paste method will only function correctly when the
Note: The Select method will only function correctly when the
Note: The SelectAll method will only function correctly when the
Note: The Undo method will only function correctly when the
Note: The CanUndo method will only function correctly when the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether any properties of the
Returns True if the
Use this method to determine if an Appearance object has been created for the NullTextAppearance and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
The BeforeEnterEditMode event can be canceled to conditionally prevent users from modifying the contents of the control.
The BeforeExitEditMode event can be canceled to prevent users from leaving the control until certains conditions have been met.
When the control's value is null (Nothing in VB), the control displays an empty string by default. The NullText property enables the end developer to change the text that is displayed for null values (for example, '(NULL)' or '(none)').
When the AutoSize property is set to true, the editor's height cannot be modified
Note: When the control's
The
Note: When the control's DisplayStyle property is set to anything other than Standard, the
Note: The HideSelection property is only applicable when the
The Value property will return null (Nothing in VB) when the
By default, the
The Nullable property determines how an empty string is interpretted by the control for purposes of the Value property. When set to True the control.Value will return null (Nothing in Visual Basic) when the control contains no text. Otherwise, the Value will return String.Empty.
The Appearance property of an object is used to associate the object with an Appearance object that will determine its appearance. The Appearance object has properties that control settings such as color, borders, font, transparency, etc. For many of the objects in the UltraWinSchedule, you do not set formatting properties directly. Instead, you set the properties of an Appearance object, which controls the formatting of the object it is attached to.
There are two ways of working with the Appearance property and assigning the attributes of an SSAppearance object to other objects. One way is to create a new Appearance object, adding it directly to the Appearances collection. Then you assign the new Appearance object to the Appearance property of the object you want to format. This method uses a "named" Appearance object that you must explicitly create (and to which you must assign property settings) before it can be used. For instance, you could create an object in the control's Appearances collection and assign it some values as follows:
UltraTextEditor1.Appearances.Add "New1"
UltraTextEditor1.Appearances("New1").BorderColor = Color.Blue
UltraTextEditor1.Appearances("New1").ForeColor = Color.Red
Creating the object in this way does not apply formatting to any visible part of the control. The object simply exists in the collection with its property values, waiting to be used. To actually use the object, you must assign it to the control's (or another object's) Appearance property:
UltraTextEditor1.Appearance = UltraTextEditor1.Appearances("New1")
In this case, only one Appearance object exists. The control's appearance is governed by the settings of the "New1" object in the collection. Any changes you make to the object in the collection will immediately be reflected in the control.
The second way of working with the Appearance property is to use it to set property values directly, such as:
UltraTextEditor1.Appearance.ForeColor = Color.Blue
In this case, an Appearance object is automatically created by the control. This Appearance object is not a member of an Appearances collection and it does not have a name. It is specific to the object for which it was created; it is an "intrinsic" Appearance object. Changes to the properties of an intrinsic Appearance object are reflected only in the object to which it is attached.
Note that you can assign properties from a named Appearance object to an intrinsic Appearance object without creating a dependency relationship. For example, the following code...
UltraTextEditor1.Appearance.ForeColor = UltraTextEditor1.Appearances("New1").ForeColor
...does not establish a relationship between the foreground color of the intrinsic object and that of the named object. It is simply a one-time assignment of the named object's value to that of the intrinsic object. In this case, two Appearance objects exist - one in the collection and one attached to the control - and they operate independently of one another.
If you wish to assign all the properties of a named object to an intrinsic object at once without creating a dependency relationship, you can use the Clone method of the Appearance object to duplicate its settings and apply them. So if you wanted to apply all the property settings of the named Appearance object "New1" to the control's intrinsic Appearance object, but you did not want changes made to "New1" automatically reflected in the control, you would use the following code:
UltraTextEditor1.Appearance = UltraTextEditor1.Appearances("New1").Clone
Note that the properties of an Appearance object can also operate in a hierarchical fashion. Certain properties can be set to a "use default" value, which indicates to the control that the property should take its setting from the object's parent. This functionality is enabled by default, so that unless you specify otherwise, child objects resemble their parents, and formatting set at higher levels of the control hierarchy is inherited by objects lower in the hierarchy.
If the list portion is already visible, the DropDown method does nothing and returns true.
When the DropDown method is called, the
If the list portion is not visible, the CloseUp method does nothing and returns.
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The BeforeDropDown event can be canceled; when this happens, the dropdown list is not displayed, and the
The UltraComboEditor control provides the ability to control whether the dropdown button is displayed.
When set to Always (default), the dropdown button is always displayed, as is the case with an intrinsic ComboBox control.
When set to Never, the dropdown button is never displayed. Note that this does not affect whether the list portion of the control can be displayed.
When set to OnMouseEnter, the dropdown button is displayed when the cursor passes into the boundaries of the control, and hidden when it passes outside.
Note: The DropDownButtonDisplayStyle property does not affect whether the list portion of the control can be displayed; however, the list portion can be prevented from displaying by canceling the
The UltraComboEditor control provides the ability to situate the dropdown button on either the right (default) or left side of the control.
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
The CheckedValue property exists to facilitate data binding to fields that allow DBNull.Value. When bound to the control's
The CheckedValue property, on the other hand, is of type System.Object, and as such will accept DBNull.Value as valid assignment. In that case, the control's
Note: The CheckedValue property is specifically designed to handle binding to nullable fields of type System.Boolean. The property should not be bound to fields of type System.Windows.Forms.CheckState; doing so may result in unexpected behavior. When binding to fields of type System.Windows.Forms.CheckState, use the control's
If True, ampersands in the text will be converted to an underline and when the mnemonic is entered by the user the control will be activated and clicked.
If False, ampersands in the text are not converted and the control does not respond to mnemonics.
The ValidateCheckState event can be used to force the control's
Note: If you want to set the GlyphStyle for all Infragistics controls in your application, use the static
Note: If you want to set the GlyphInfo for all Infragistics controls in your application, use the static
When set to true (default), and the edit portion is cleared, the new value is assumed to be Color.Empty.
When set to false and the edit portion is cleared, the value of the
Note: In the case where the
The UIElement property returns a reference to the UIElement that represents the control itself. All the UI aspects of the control are implemented as UIElements which are children of the control's UIElement (available only at runtime).
The UltraComboEditor control provides functionality similar to the intrinsic ComboBox provided by the .NET framework, with additional features, such as:
This method has two distinct, yet related, uses. By default the databinding process will
occur on an as-needed basis. However, after setting the
The other way that this method can be used is as a way to synchronize with a
non-
Note: Calling this method on the UltraTimeZoneEditor or UltraFontNameEditor will result in a NotSupportedException since those controls do not support being bound.
If an external ValueList has already been assigned to the
Note: Calling this method on the UltraTimeZoneEditor or UltraFontNameEditor will result in a NotSupportedException since those controls do not support being bound.
If an external ValueList has already been assigned to the
With the 2008 Volume 2 release of NetAdvantage, the AutoComplete property has been deprecated, and replaced by the
With the 2008 Volume 2 release of NetAdvantage, the AutoComplete property has been deprecated, and replaced by the
Invoke this method to reset the
If the list portion is already visible, the DropDown method does nothing and returns true.
When the DropDown method is called, the
If the list portion is not visible, the CloseUp method does nothing and returns.
When the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The ItemNotInList event provides the ability to customize the way the control reacts when it loses focus
with a value that is not in the control's ValueList.
The
The BeforeDropDown event can be canceled; when this happens, the dropdown list is not displayed, and the
If an external ValueList has already been assigned to the
If an external ValueList has already been assigned to the
If an external ValueList has already been assigned to the
If an external ValueList has already been assigned to the
The Items collection is a collection of type
The items in the list portion of the control are objects of type
When a ValueListItem has no specific display text set, the string representation of its data value is displayed.
When items are selected from the dropdown list, the control's
An ItemNotInList event will fire before the Validating event of the control whenever the text value entered into the editor portion of the control is not a value in the control’s valuelist. If true The LimitToList property will cancel the validating event and return focus whenever the entered value is not in the list.
When the total number of items in the list exceeds the value specified by the MaxDropDownItems property, a scrollbar is displayed.
Note: The number of items that are displayed in the visible portion of the dropdown list includes items in the
Note:
Each item displayed in the list portion has its ownThe UltraComboEditor control provides the ability to control whether the dropdown button is displayed.
When set to Always (default), the dropdown button is always displayed, as is the case with an intrinsic ComboBox control.
When set to Never, the dropdown button is never displayed. Note that this does not affect whether the list portion of the control can be displayed.
When set to OnMouseEnter, the dropdown button is displayed when the cursor passes into the boundaries of the control, and hidden when it passes outside.
Note: The DropDownButtonDisplayStyle property does not affect whether the list portion of the control can be displayed; however, the list portion can be prevented from displaying by canceling the
The UltraComboEditor control provides the ability to situate the dropdown button on either the right (default) or left side of the control.
The UltraComboEditor control provides the ability to align the dropdown list with the left, right (default) or center of the edit portion of the control.
Setting the property to 0 results in the dropdown list autosizing its width to be equal to the control's width
Setting the property to -1 results in the dropdown list autosizing its width to accommodate the longest item's text
The
The DropDownStyle property controls the interface that is presented to the user. When set to DropDown, the text portion is editable, and the control's value can be set to any string value.
When set to DropDownList, the control's value must correspond to an item in the dropdown list.
Note: The value of the DropDownStyle property also influences certain aspects of the keyboard behavior. For example, when the DropDownStyle property is DropDownList, pressing an alpha-numeric key results in the first item whose text begins with that character becoming selected.
Note: The control also exposes an
MRU is an acronym for 'Most Recently Used'. The control's MRU list contains the text of the items that were most recently selected by the end user.
MRU is an acronym for 'Most Recently Used'. The control's MRU list contains the text of the items that were most recently selected by the end user.
When the
Note: While the MRUList can be set, items that do not match the text of an item in the control's
MRU is an acronym for 'Most Recently Used'. The control's MRU list contains the text of the items that were most recently selected by the end user.
When the
The UIElement property returns a reference to the UIElement that represents the control itself. All the UI aspects of the control are implemented as UIElements which are children of the control's UIElement (available only at runtime).
Note: If the control is bound through the
Note: The developer is responsible for disposing any external ValueList that is assigned to this property; the UltraComboEditor will only dispose ValueLists that are created internally. This means that if there are two UltraComboEditors, A and B, if B is assigned the ValueList that is created by A, if A is disposed, B will have a disposed ValueList. In this case, a new, blank ValueList will be created the next time that B needs to access the ValueList property. In order to work around this issue, it is recommended that a ValueList be created manually and assigned to each UltraComboEditor, ensuring that the list is disposed properly.
With the 2008 Volume 2 release of NetAdvantage, the AutoComplete property has been deprecated, and replaced by the
Note: This property replaces the
Prior to the addition of the AutoCompleteMode property, automatic value completion was supported in the form of the now obsolete AutoComplete property, which, when enabled, modified the control's text by appending characters to the string typed by the end user so as to match the text of the first item found in the list whose text begins with the typed characters. For example, given a list which contains an item whose text is "Apple", when the end user types the string "Ap", the edit portion would then be updated to include the remaining characters, "ple", so that the text of the first item that matches the typed string, "Apple", becomes selected. That same functionality is now enabled by setting AutoCompleteMode to 'Append'. The appended characters are selected so that continuing to type causes these characters to be removed.
The AutoCompleteMode property extends two additional modes for value completion, 'Suggest' and 'SuggestAppend'. When the property is set to 'Suggest', no characters are appended to the edit portion, but rather the dropdown is automatically displayed, showing only the items whose text begins with the string that was typed by the end user. For example, given a list containing the items, "Apple", "Application", and "Apprehend", upon typing the "A" character, the dropdown list will appear, displaying all of those items. The list is continually filtered as more characters are typed, eliminating the entries whose text no longer matches the typed string. For example, if the continues typing until the edit portion contains "Appl", the "Apprehend" item would be removed from the list, since the presence of the character "l" in the typed string now precludes that item.
The 'SuggestAppend' setting essentially combines the funtionality extended by the 'Append' and 'Suggest' settings. The dropdown list is automatically displayed and filtered as needed, and text is appended to the edit portion to complete the typed text to match the first item with matching text.
When using the 'Suggest' or 'SuggestAppend' modes, the
MRU (Most Recently Used) functionality is suspended when the control is in "suggest" mode, that is, when the property is set to 'Suggest' or 'SuggestAppend'. This is because in those modes, the dropdown must only contain the filtered items.
In the absence of an explicit setting, the AutoCompleteMode property resolves to 'None'.
The Text property visually represents the control's current value. When the
When the
The Value property corresponds to the DataValue property of the control's
When the control's
When the control's
When the control's
The SelectedItem property can be set to an item in the dropdown list; when that happens, the control's edit portion displays that item's text, and the
The
As such, the SelectedItem property is of type
Setting the SelectedIndex property results in the
Note: When the
The CheckedItems collection property mirrors the property of the same name that is exposed
by the
The CheckedItems collection is similar to the collection of the same name exposed by the .NET CheckedListBox control. In situations where an application requires that the end user be able to select multiple values from a dropdown, checkboxes can be used to accomplish this; rather than the value being determined by the one selected item, it can be determined instead by the members of the CheckedItems collection.
You can set the SyncWithCurrencyManager property to True to allow the combo to synchronize the active item with the associated currency manager's position.
The CheckedListSettings class provides a way to display a checkbox next to each item in the list. This extends functionality similar
to that of the .NET CheckedListBox
control to the
The
The CheckBoxStyle property mirrors the property of the same name that is exposed
by the
When the property is set to 'None', which it is by default, checkboxes are not displayed. When the property is set to 'CheckBox', "two-state" checkboxes are displayed by the control, i.e., checkboxes which do not support the Indeterminate state. When the property is set to 'TriState', three states can be represented by the checkbox - checked, unchecked, or indeterminate. The indeterminate state is useful for representing a value which can be true, false, or null.
The CheckBoxStyle property mirrors the property of the same name that is exposed
by the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to simulate an action the user can perform.
Many actions are only appropriate in certain situations; if an action is inappropriate, it will not be performed.
You can use the
See
Note: The Copy method is only available when the control is in edit mode.
Note: The Cut method is only available when the control is in edit mode.
Note: The Paste method is only available when the control is in edit mode.
If true the spin button will wrap the value incremented/decremented based on its Min/Max value.
By default, the
When set to Trrue, the AlwaysInEditMode property prevents the control from exiting edit mode when it loses the input focus.
The KeyActionMappings property provides access to the control's mechanism for handling keyboard input from users. All keystrokes for actions such as selection, navigation and editing are stored in a table-based system that you can examine and modify using this property. Through the KeyActionsMappings property, you can customize the keyboard layout of the control to match your own standards for application interactivity.
For example, if you wanted users to be able to navigate between cells by pressing the F8 key, you could add this behavior. You can specify the key code and any special modifier keys associated with an action, as well as determine whether a key mapping applies in a given context.
The following table lists the default key mappings for the
| KeyCode | ActionCode | StateRequired | StateDisallowed | SpecialKeysRequired | SpecialKeysDisallowed |
|---|---|---|---|---|---|
| Right | NextCharacter | Character | Ctrl | ||
| Right | NextSection | Character | LastSection | Ctrl | |
| Right | AfterLastCharacter | LastSection | Ctrl | ||
| Right | SetPivot | UnInitialized | Shift | ||
| Left | PrevCharacter | FirstCharacter | Ctrl | ||
| Left | PrevSection | FirstSection | Ctrl | ||
| Left | FirstCharacter | FirstSection | FirstCharacter | Ctrl | |
| Left | SetPivot | UnInitialized | Shift | ||
| Home | FirstCharacter | FirstCharacter | |||
| Home | SetPivot | UnInitialized | Shift | ||
| End | AfterLastCharacter | AfterLastCharacter | |||
| End | SetPivot | UnInitialized | Shift | ||
| Tab | NextSection | Character, TabBySections | LastSection | Shift | |
| Tab | SetPivot | Character, TabBySections | LastSection | Shift | |
| Tab | SelectSection | Character, TabBySections | LastSection | Shift | |
| Tab | PrevSection | TabBySections | FirstSection | Shift | |
| Tab | SetPivot | TabBySections | FirstSection | Shift | |
| Tab | SelectSection | TabBySections | FirstSection | Shift | |
| Delete | Delete | Selected | Shift | ||
| Delete | Delete | Character | Selected | Shift | |
| Delete | Backspace | Selected | Shift | Ctrl | |
| Delete | AfterLastCharacter | Character | Selected | Ctrl | Shift |
| Delete | Delete | Character | Selected | Ctrl | Shift |
| Back | Backspace | Selected | |||
| Back | Backspace | FirstCharacter, Selected | |||
| C | Copy | Selected | Ctrl | ||
| X | Cut | Selected | Ctrl | ||
| V | Paste | Ctrl | |||
| Insert | ToggleInsertionMode | ShiftCtrl | |||
| Up | UpKeyAction | UnInitialized | |||
| Down | DownKeyAction | UnInitialized | |||
| Insert | Copy | Selected | UnInitialized | Ctrl | Shift |
| Insert | Paste | UnInitialized | Shift | Ctrl | |
| Delete | Cut | Selected | UnInitialized | Shift | Ctrl |
Indicates whether the control can utilize an
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
The ValidationError event provides the ability to customize the way the control reacts when it loses focus with an invalid value.
The
The UIElement property returns a reference to the UIElement that represents the control itself. All the UI aspects of the control are implemented as UIElements which are children of the control's UIElement. This property is available only at runtime).
The
Note: When the control's DisplayStyle property is set to anything other than Standard, the
The default setting for this property is 'Button3D'. This property only applies to the control when spin buttons are visible.
When inputting data, placeholder characters are displayed, and the user can only replace a placeholder with a character that is of the same type as the one specified in the input mask. The control can distinguish between numeric and alphabetic characters for validation, but cannot validate for valid content, such as the correct month or time of day.
When data masking is enabled, the
Character | Description |
| {double:i.f:c} | {double:i.f:c} is a place holder for a mask that allows floating point input where i and f in i.f specify the number of digits in the integer and fraction portions respectively. The :c portion of the mask is optional and it specifies that the inputting of the value should be done continous across fraction and integer portions. For example, with :c in the mask, in order to enter 12.34 the user types in "1234". Notice that the decimal separator character is missing. This allevietes the user from having to type in the decimal separator. |
| {double:-i.f:c} | Same as {double:i.f:c} except this allows negative numbers. |
| {currency:i.f:c} | Same as {double:i.f:c} except the mask is constructed based on currency formatting information of the underlying format provider or the culture. It typically has the currency symbol and also displays the group characters. |
| {currency:-i.f:c} | Same as {currency:i.f:c} except this allows negative numbers. |
. | Decimal placeholder. The actual character used is the one specified as the decimal placeholder by the system's international settings. This character is treated as a literal for masking purposes. |
, | Thousands separator. The actual character used is the one specified as the thousands separator by the system's international settings. This character is treated as a literal for masking purposes. |
| - | Minus sign when followed by a number section defined by series of 'n's (like in "-nn,nnn.nn") indicates that negative numbers are allowed. When not followed by a series of 'n's, it's taken as a literal. Minus sign will only be shown when the number is actually negative. |
| + | Plus sign when followed by a number section defined by series of 'n's (like in "-nn,nnn.nn") indicates that negative numbers are allowed. However, it differs from '-' in the respect that it will always show a '+' or a '-' sign depending on whether the number is positive or negative. |
| n | Digit placeholder. A group of n's can be used to create a numeric section where numbers are entered from right to left. Character must be numeric (0-9) but entry is not required. |
| Literal | All other symbols are displayed as literals; that is, they appear as themselves. |
This property is used to determine how mask literals and prompt characters are applied to the value returned by the Value property of the control. Based on the setting of this property, the text returned by the Value property will contain no prompt characters or literals (just the raw data), the data and just the literals, the data and just the prompt characters, or all the text including both prompt characters and literals. The formatted spacing of partially masked values can be preserved by indicating to include literals with padding, which includes data and literal characters, but replaces prompt characters with spaces.
Generally, simply the raw data is returned by the Value property and data masking is used to format the data when it is displayed. In some cases, however, it may be appropriate in your application to include mask literals as well as data.
The
When data masking is enabled, the
This property is used to determine how mask literals and prompt characters are displayed when the control is not in edit mode. Based on the setting of this property, the text displayed in the control will contain no prompt characters or literals (just the raw data), the data and just the literals, the data and just the prompt characters, or all the text including both prompt characters and literals. The formatted spacing of partially masked values can be preserved by indicating to include literals with padding, which includes data and literal characters, but replaces prompt characters with spaces.
Generally, prompt characters disappear when the control is no longer in edit mode, as a visual cue to the user. In some cases, however, it may be appropriate in your application to display mask literals as well as data when the control is no longer in edit mode.
The
When data masking is enabled, the
This property is used to determine how mask literals and prompt characters are handled when the text of the control is copied to the Windows clipboard. Based on the setting of this property, the text in the clipboard will contain no prompt characters or literals (just the raw data), the data and just the literals, the data and just the prompt characters, or all the text including both prompt characters and literals. The formatted spacing of partially masked values can be preserved by indicating to include literals with padding, which includes data and literal characters, but replaces prompt characters with spaces.
The
When data masking is enabled, the
Note: Because the control requires a prompt character to indicate unpopulated mask positions, the PromptChar property cannot be set to the null character ('\x00'). If the property is set to the null character, the value will be changed to the space character ('\x32') instead.
The default setting for BorderStyle is 'Raised'.
The Appearance property of an object is used to associate the object with an Appearance object that will determine its appearance. The Appearance object has properties that control settings such as color, borders, font, transparency, etc. For many of the objects in the UltraWinSchedule, you do not set formatting properties directly. Instead, you set the properties of an Appearance object, which controls the formatting of the object it is attached to.
There are two ways of working with the Appearance property and assigning the attributes of an SSAppearance object to other objects. One way is to create a new Appearance object, adding it directly to the Appearances collection. Then you assign the new Appearance object to the Appearance property of the object you want to format. This method uses a "named" Appearance object that you must explicitly create (and to which you must assign property settings) before it can be used. For instance, you could create an object in the control's Appearances collection and assign it some values as follows:
UltraNumericEditor1.Appearances.Add "New1"
UltraNumericEditor1.Appearances("New1").BorderColor = Color.Blue
UltraNumericEditor1.Appearances("New1").ForeColor = Color.Red
Creating the object in this way does not apply formatting to any visible part of the control. The object simply exists in the collection with its property values, waiting to be used. To actually use the object, you must assign it to the control's (or another object's) Appearance property:
UltraNumericEditor1.Appearance = UltraNumericEditor1.Appearances("New1")
In this case, only one Appearance object exists. The control's appearance is governed by the settings of the "New1" object in the collection. Any changes you make to the object in the collection will immediately be reflected in the control.
The second way of working with the Appearance property is to use it to set property values directly, such as:
UltraNumericEditor1.Appearance.ForeColor = Color.Blue
In this case, an Appearance object is automatically created by the control. This Appearance object is not a member of an Appearances collection and it does not have a name. It is specific to the object for which it was created; it is an "intrinsic" Appearance object. Changes to the properties of an intrinsic Appearance object are reflected only in the object to which it is attached.
Note that you can assign properties from a named Appearance object to an intrinsic Appearance object without creating a dependency relationship. For example, the following code...
UltraNumericEditor1.Appearance.ForeColor = UltraNumericEditor1.Appearances("New1").ForeColor
...does not establish a relationship between the foreground color of the intrinsic object and that of the named object. It is simply a one-time assignment of the named object's value to that of the intrinsic object. In this case, two Appearance objects exist - one in the collection and one attached to the control - and they operate independently of one another.
If you wish to assign all the properties of a named object to an intrinsic object at once without creating a dependency relationship, you can use the Clone method of the Appearance object to duplicate its settings and apply them. So if you wanted to apply all the property settings of the named Appearance object "New1" to the control's intrinsic Appearance object, but you did not want changes made to "New1" automatically reflected in the control, you would use the following code:
UltraNumericEditor1.Appearance = UltraNumericEditor1.Appearances("New1").Clone
Note that the properties of an Appearance object can also operate in a hierarchical fashion. Certain properties can be set to a "use default" value, which indicates to the control that the property should take its setting from the object's parent. This functionality is enabled by default, so that unless you specify otherwise, child objects resemble their parents, and formatting set at higher levels of the control hierarchy is inherited by objects lower in the hierarchy.
You should use the Appearance's BackColor property to set the background color of the control. The
The setting of this property will be passed through to the BackColor property of control's Appearance object.
You should use the Appearance's BackgroundImage property to set the background color of the control. The
The setting of this property will be passed through to the BackgroundImage property of control's Appearance object.
You should use the Appearance's ForeColor property to set the foreground color of the control. The
The setting of this property will be passed through to the ForeColor property of control's Appearance object.
You should use the Appearance's Cursor property to set the mouse pointer used for the control. The
The setting of this property will be passed through to the BackColor property of control's Appearance object.
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The UltraCurrencyEditor control provides the ability to restrict the range of values that will be accepted by the control. This is accomplished by setting the
When the control loses focus with a value that is outside the range determined but the MinValue and MaxValue properties, the
The UltraCurrencyEditor control provides the ability to restrict the range of values that will be accepted by the control. This is accomplished by setting the MinValue and
When the control loses focus with a value that is outside the range determined but the MinValue and MaxValue properties, the
The UltraCurrencyEditor control provides the ability to restrict the range of values that will be accepted by the control. This is accomplished by setting the
When the control loses focus with a value that is outside the range determined but the MinValue and MaxValue properties, the
The ValueObject property is bindable; it is provided so that the control can be bound to data fields that are nullable.
Unless explicitly set to null (Nothing in VB), it returns the value of the control's
If set to a value that is not null (Nothing in VB) and cannot be converted to a decimal, an exception is thrown.
The UltraDateTimeEditor control provides functionality similar to the intrinsic DateTimePicker provided by the .NET framework, with additional features, such as:
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
The UltraDateTimeEditor control provides the ability to restrict the range of dates that will be accepted by the control. This is accomplished by setting the MinDate and
The UltraDateTimeEditor control provides the ability to restrict the range of dates that will be accepted by the control. This is accomplished by setting the
The UltraDateTimeEditor control provides the ability to control whether the dropdown button is displayed.
When set to Always (default), the dropdown button is always displayed, as is the case with an intrinsic ComboBox control.
When set to Never, the dropdown button is never displayed. Note that this does not affect whether the list portion of the control can be displayed.
When set to OnMouseEnter, the dropdown button is displayed when the cursor passes into the boundaries of the control, and hidden when it passes outside.
Note: The DropDownButtonDisplayStyle property does not affect whether the list portion of the control can be displayed; however, the list portion can be prevented from displaying by canceling the
The UltraDateTimeEditor control provides the ability to control whether (and how) the spin buttons are displayed.
When set to Always (default), the spin buttons are always displayed.
When set to Never, the spin buttons are never displayed.
When set to OnMouseEnter, the spin buttons are displayed when the cursor passes into the boundaries of the control, and hidden when it passes outside.
The UltraDateTimeEditor control provides the ability to situate the dropdown button on either the right (default) or left side of the control.
The UltraDateTimeEditor control provides the ability to situate the spin buttons on either the right (default) or left side of the control.
The UIElement property returns a reference to the UIElement that represents the control itself. All the UI aspects of the control are implemented as UIElements which are children of the control's UIElement (available only at runtime).
The
Note: When the control's DisplayStyle property is set to anything other than Standard, the
When inputting data, the user can only replace a placeholder with a character that is of the same type as the one specified in the input mask. If the user enters an invalid character, the control rejects the character. The control can distinguish between numeric and alphabetic characters for validation, but cannot validate for valid content, such as the correct month or time of day.
The input mask can consist of the following characters:
Character | Description |
| : | Time separator. The actual character used is the one specified as the time separator by the system's international settings. This character is treated as a literal for masking purposes |
| / | Date separator. The actual character used is the one specified as the date separator by the system's international settings. This character is treated as a literal for masking purposes. |
| mm, dd, yy | Combination of these three special tokens can be used to define a date mask. mm for month, dd for day, yy for two digit year and yyyy for four digit year. Examples: mm/dd/yyyy, yyyy/mm/dd, mm/yy. |
| hh, mm, ss, tt | Combination of these three special tokens can be used to define a time mask. hh for hour, mm for minute, ss for second, and tt for AP/PM. Examples: hh:mm, hh:mm tt, hh:mm:ss. |
| {date} | {date} token is a place holder for short date input. The date mask is derived using the underlying culture settings. |
| {time} | {time} token is a place holder for short time input. Short time typically does not include the seconds portion. The time mask is derived using the underlying culture settings. |
| {longtime} | {longtime} token is a place holder for long time input. Long time typically includes the seconds portion. The long time mask is derived using the underlying culture settings. |
| Literal | All other symbols are displayed as literals; that is, they appear as themselves. |
Note: Masking is always enabled for the
This property is used to determine how mask literals and prompt characters are handled when the control's are retrieved using the
In some cases, it may be appropriate in your application to store mask literals as well as data.
This property is used to determine how mask literals and prompt characters are displayed when the control is not in edit mode. Based on the setting of this property, the text of the control will contain no prompt characters or literals (just the raw data), the data and just the literals, the data and just the prompt characters, or all the text including both prompt characters and literals. The formatted spacing of partially masked values can be preserved by indicating to include literals with padding, which includes data and literal characters, but replaces prompt characters with pad characters (usually spaces).
Generally, prompt characters disappear when the control does not have the input focus, as a visual cue to the user. In some cases, however, it may be appropriate in your application to display mask literals as well as data when the control does not have the input focus.
Note: Since the MaskDisplayMode property could potentially conflict with the control's
This property is used to determine how mask literals and prompt characters are handled when the control's contents are copied to the clipboard. Based on the setting of this property, the text of the control will contain no prompt characters or literals (just the raw data), the data and just the literals, the data and just the prompt characters, or all the text including both prompt characters and literals. The formatted spacing of partially masked values can be preserved by indicating to include literals with padding, which includes data and literal characters, but replaces prompt characters with pad characters (usually spaces).
By default, the
Note: Since the FormatString could potentially conflict with the control's mask settings, the FormatString property is only applicable when the control is not in edit mode.
Conversely, the control's
The Value property returns an object containing either a
The Value property may be bound to a database.
When the control's value is null (Nothing in VB), the control displays an empty string by default. The NullText property enables the end developer to change the text that is displayed for null values (for example, '(NULL)' or '(none)').
Note: Because the control requires a prompt character to indicate unpopulated mask positions, the PromptChar property cannot be set to the null character ('\x00'). If the property is set to the null character, the value will be changed to the space character ('\x32') instead.
When the user enters text in the UltraDateTimeEditor, then the control will validate that text when in the Leave or Validating events. If the text cannot be converted to a valid date, the control must revert the value to a valid date. This property determines whether the control will use the last valid date that was entered as the user typed, or the the original value when the control was entered.
When set to 'PreserveWhileInEditMode', the user input is left intact until the control is allowed to exit edit mode, or passes validation. This is useful in scenarios where, for example, it is desirable to leave unpopulated mask placeholders intact, so that after an error message is displayed and focus returns to the control, the user can see why the input was rejected and continue editing with previously entered characters left as they were entered.
The 'PreserveWhileInEditMode' setting is only applicable in scenarios where the control's
The 'PreserveWhileInEditMode' setting does not prevent partially entered years from being automatically resolved; this is goverened by the system's two digit year rule. When two digits or three digits are entered for a four digit year section, the four year value is automatically resolved by the control.
An exception is thrown if the DateTime is set to a value that is outside the range determined by the
The IsDateValid property can be used to determine if the date to which the control's
The IsDateValid property is available only at runtime.
When the control's dropdown button is clicked, a calendar is displayed. Its selected date is preset to the date in the edit portion, or, if no valid date is set, the current date. When the control's dropdown calendar closes up, the edit portion is set to display the date that was selected in the calendar portion. The DropDownCalendarAlignment property determines which side of the control the dropdown calendar will be aligned with.
The Appearance property of an object is used to associate the object with an Appearance object that will determine its appearance. The Appearance object has properties that control settings such as color, borders, font, transparency, etc. For many of the objects in the UltraWinSchedule, you do not set formatting properties directly. Instead, you set the properties of an Appearance object, which controls the formatting of the object it is attached to.
There are two ways of working with the Appearance property and assigning the attributes of an SSAppearance object to other objects. One way is to create a new Appearance object, adding it directly to the Appearances collection. Then you assign the new Appearance object to the Appearance property of the object you want to format. This method uses a "named" Appearance object that you must explicitly create (and to which you must assign property settings) before it can be used. For instance, you could create an object in the control's Appearances collection and assign it some values as follows:
UltraDateTimeEditor1.Appearances.Add "New1"
UltraDateTimeEditor1.Appearances("New1").BorderColor = Color.Blue
UltraDateTimeEditor1.Appearances("New1").ForeColor = Color.Red
Creating the object in this way does not apply formatting to any visible part of the control. The object simply exists in the collection with its property values, waiting to be used. To actually use the object, you must assign it to the control's (or another object's) Appearance property:
UltraDateTimeEditor1.Appearance = UltraDateTimeEditor1.Appearances("New1")
In this case, only one Appearance object exists. The control's appearance is governed by the settings of the "New1" object in the collection. Any changes you make to the object in the collection will immediately be reflected in the control.
The second way of working with the Appearance property is to use it to set property values directly, such as:
UltraDateTimeEditor1.Appearance.ForeColor = Color.Blue
In this case, an Appearance object is automatically created by the control. This Appearance object is not a member of an Appearances collection and it does not have a name. It is specific to the object for which it was created; it is an "intrinsic" Appearance object. Changes to the properties of an intrinsic Appearance object are reflected only in the object to which it is attached.
Note that you can assign properties from a named Appearance object to an intrinsic Appearance object without creating a dependency relationship. For example, the following code...
UltraDateTimeEditor1.Appearance.ForeColor = UltraDateTimeEditor1.Appearances("New1").ForeColor
...does not establish a relationship between the foreground color of the intrinsic object and that of the named object. It is simply a one-time assignment of the named object's value to that of the intrinsic object. In this case, two Appearance objects exist - one in the collection and one attached to the control - and they operate independently of one another.
If you wish to assign all the properties of a named object to an intrinsic object at once without creating a dependency relationship, you can use the Clone method of the Appearance object to duplicate its settings and apply them. So if you wanted to apply all the property settings of the named Appearance object "New1" to the control's intrinsic Appearance object, but you did not want changes made to "New1" automatically reflected in the control, you would use the following code:
UltraDateTimeEditor1.Appearance = UltraDateTimeEditor1.Appearances("New1").Clone
Note that the properties of an Appearance object can also operate in a hierarchical fashion. Certain properties can be set to a "use default" value, which indicates to the control that the property should take its setting from the object's parent. This functionality is enabled by default, so that unless you specify otherwise, child objects resemble their parents, and formatting set at higher levels of the control hierarchy is inherited by objects lower in the hierarchy.
The UltraFontNameEditor control provides a ComboBox-like control whose list is pre-populated with the names of all the fonts on the system that are supported by the .NET runtime. Furthermore, the control provides these additional features:
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The Items collection is a collection of type
The items in the list portion of the control are objects of type
When a ValueListItem has no specific display text set, the string representation of its data value is displayed.
When items are selected from the dropdown list, the control's
Note: When the ShowFontTypeIndicator is true, the Image property of the control's
By default, each font name in the dropdown list is displayed in the font that it represents. The ShowFontNamesInFont property provides the ability to disable this feature.
Note: When the ShowFontNamesInFont is true, the font data of the control's
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The control will support either integer or double-precision decimal numeric entry.
When inputting data, placeholder characters are displayed, and the user can only replace a placeholder with a character that is of the same type as the one specified in the input mask. The control can distinguish between numeric and alphabetic characters for validation, but cannot validate for valid content, such as the correct month or time of day.
When data masking is enabled, the
Character | Description |
| {double:i.f:c} | {double:i.f:c} is a place holder for a mask that allows floating point input where i and f in i.f specify the number of digits in the integer and fraction portions respectively. The :c portion of the mask is optional and it specifies that the inputting of the value should be done continous across fraction and integer portions. For example, with :c in the mask, in order to enter 12.34 the user types in "1234". Notice that the decimal separator character is missing. This allevietes the user from having to type in the decimal separator. |
| {double:-i.f:c} | Same as {double:i.f:c} except this allows negative numbers. |
| {currency:i.f:c} | Same as {double:i.f:c} except the mask is constructed based on currency formatting information of the underlying format provider or the culture. It typically has the currency symbol and also displays the group characters. |
| {currency:-i.f:c} | Same as {currency:i.f:c} except this allows negative numbers. |
. | Decimal placeholder. The actual character used is the one specified as the decimal placeholder by the system's international settings. This character is treated as a literal for masking purposes. |
, | Thousands separator. The actual character used is the one specified as the thousands separator by the system's international settings. This character is treated as a literal for masking purposes. |
| - | Minus sign when followed by a number section defined by series of 'n's (like in "-nn,nnn.nn") indicates that negative numbers are allowed. When not followed by a series of 'n's, it's taken as a literal. Minus sign will only be shown when the number is actually negative. |
| + | Plus sign when followed by a number section defined by series of 'n's (like in "-nn,nnn.nn") indicates that negative numbers are allowed. However, it differs from '-' in the respect that it will always show a '+' or a '-' sign depending on whether the number is positive or negative. |
| n | Digit placeholder. A group of n's can be used to create a numeric section where numbers are entered from right to left. Character must be numeric (0-9) but entry is not required. |
| Literal | All other symbols are displayed as literals; that is, they appear as themselves. |
This property returns the number currently entered in the control.
If the user enters a value less than the value specified for this property, the
If the user enters a value greater than the value specified for this property, the
When the control's value is null (Nothing in VB), the control displays an empty string by default. The NullText property enables the end developer to change the text that is displayed for null values (for example, '(NULL)' or '(none)').
Note: The
Invoke this method to reset the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the BorderStyle property is set to its default value.
Returns True if the BorderStyle property is not set to its default value; otherwise, it returns False.
Invoke the UltraColorPicker.ResetBorderStyle method to reset this property to its default value.
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
This method has two distinct, yet related, uses. By default the databinding process will
occur on an as-needed basis. However, after setting the
The other way that this method can be used is as a way to synchronize with a
non-
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
If True, ampersands in each item's text will be converted to an underline and when the mnemonic is entered by the user the corresponding item will become the new
If False, ampersands in the text are not converted and the control does not respond to mnemonics.
Note: If you want to set the GlyphStyle for all Infragistics controls in your application, use the static
Note: If you want to set the GlyphInfo for all Infragistics controls in your application, use the static
The UltraPictureBox is designed to display a single image. The
By default, the Image is only scaled when the image size exceeds the size of the control. This can be
changed using the
The control includes the ability to draw a drop shadow below the image. To enable the shadow, set the
By default, the control is rendered without a border. A border may be assigned using the
Note While the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Note While the
Use this property to determine if an
Note There may be more space around the image depending upon the
The AnimationControl does not receive focus so changing this property will not affect the control.
Since the UltraPictureBox does not receive focus and does not use the key messages, the default ImeMode is disabled.
The UltraTextEditor provides a text editor similar to the intrinsic TextBox provided by the .NET framework, with additional features, such as:
Note: The ScrollToCaret method will only function correctly when the AlwaysInEditMode property is set to true.
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The UIElement property returns a reference to the UIElement that represents the control itself. All the UI aspects of the control are implemented as UIElements which are children of the control's UIElement (available only at runtime).
When the control's
When the
This property is ignored when the Multiline property is set to False.
This property is ignored when the Multiline property is set to False.
When the
Note:The control's scrollbars are only displayed when the control is in edit mode.
The UltraTimeZoneEditor control provides a ComboBox-like control whose list is pre-populated with the names of the time zones found in the registry.
Like the
The Items collection is a collection of type
The items in the list portion of the control are objects of type
When a ValueListItem has no specific display text set, the string representation of its data value is displayed.
When items are selected from the dropdown list, the control's
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
The KeyActionMappings property provides access to the control's mechanism for handling keyboard input from users. All keystrokes for actions such as selection, navigation and editing are stored in a table-based system that you can examine and modify using this property. Through the KeyActionsMappings property, you can customize the keyboard layout of the control to match your own standards for application interactivity.
For example, if you wanted users to be able to change the value by pressing the F8 key, you could add this behavior. You can specify the key code and any special modifier keys associated with an action, as well as determine whether a key mapping applies in a given context.
| KeyCode | ActionCode | StateRequired | StateDisallowed | SpecialKeysRequired | SpecialKeysDisallowed |
|---|---|---|---|---|---|
| Left | Last | Horizontal, NullValue | Alt | ||
| Up | Last | Horizontal, NullValue | Alt | ||
| Right | First | Horizontal, NullValue | Alt | ||
| Down | First | Horizontal, NullValue | Alt | ||
| Next | First | Horizontal, NullValue | Alt | ||
| PageUp | Last | Horizontal, NullValue | Alt | ||
| Home | First | Horizontal, NullValue | Alt | ||
| End | Last | Horizontal, NullValue | Alt | ||
| Left | First | Vertical, NullValue | Alt | ||
| Up | First | Vertical, NullValue | Alt | ||
| Right | Last | Vertical, NullValue | Alt | ||
| Down | Last | Vertical, NullValue | Alt | ||
| Next | Last | Vertical, NullValue | Alt | ||
| PageUp | First | Vertical, NullValue | Alt | ||
| Home | Last | Vertical, NullValue | Alt | ||
| End | First | Vertical, NullValue | Alt | ||
| Left | SmallDecrement | Horizontal | NullValue | Alt | |
| Up | SmallDecrement | Horizontal | NullValue | Alt | |
| Right | SmallIncrement | Horizontal | NullValue | Alt | |
| Down | SmallIncrement | Horizontal | NullValue | Alt | |
| Next | LargeIncrement | Horizontal | NullValue | Alt | |
| PageUp | LargeDecrement | Horizontal | NullValue | Alt | |
| Home | First | Horizontal | NullValue | Alt | |
| End | Last | Horizontal | NullValue | Alt | |
| Left | SmallIncrement | Vertical | NullValue | Alt | |
| Up | SmallIncrement | Vertical | NullValue | Alt | |
| Right | SmallDecrement | Vertical | NullValue | Alt | |
| Down | SmallDecrement | Vertical | NullValue | Alt | |
| Next | LargeDecrement | Vertical | NullValue | Alt | |
| PageUp | LargeIncrement | Vertical | NullValue | Alt | |
| Home | Last | Vertical | NullValue | Alt | |
| End | First | Vertical | NullValue | Alt |
Note: This property only affects thumb movement triggered by mouse clicks
when the
Note: This property only affects thumb movement triggered by mouse clicks
when the
Note: This property is useful when the thumb image being used should not be centered over the associated tickmark; an example would be a right triangle whose flat edge should be aligned along the tickmark.
Note: This property is not honored in the Office2007 or Vista ViewStyles.
Note: when the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
OnPropertyChanged will also be called.
The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.
Dim myAppearance As Infragistics.Win.Appearance
myAppearance.BackColor = System.Drawing.Color.Aquamarine
The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.
Dim myAppearance As Infragistics.Win.Appearance
myAppearance.BackColor = System.Drawing.Color.Aquamarine
The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.
Dim myAppearance As Infragistics.Win.Appearance
myAppearance.BackColor = System.Drawing.Color.Aquamarine
The Appearance object encapsulates the behaviors of the properties related to visual formatting. After you create an Appearance object, you can manipulate its properties and reuse the object as ofte as you wish within your project.
Dim myAppearance As Infragistics.Win.Appearance
myAppearance.BackColor = System.Drawing.Color.Aquamarine
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The UIElement property returns a reference to the UIElement that represents the control itself. All the UI aspects of the control are implemented as UIElements which are children of the control's UIElement (available only at runtime).
Note: Setting the AutoCloseUpOnEquals property to true does not cause the dropdown to close up when the "=" button is clicked.
Also note that the dropdown closes when the Enter/Return key is pressed, regardless of the value of the AutoCloseUpOnEquals property.
This can be prevented by handling the control's KeyDown event for the Enter/Return key and setting the 'Handled' property of the event arguments to true.