Note: A parameterless constructor is required for all derived classes.
The AutoSizeControlBase class is an abstract base class for a control that
will size based on its contents, which is usually the image and text. The
The ControlBase class is an abstract base control class for a basic ultracontrol that supports displaying image and text. The class exposes some common appearance properties as well as some properties that control the display of the text.
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
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
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 ImageList is used to obtain the images to be displayed by the control when the Image property of the Appearance objects is set to an numeric value.
Use this property to determine if an
Use this property to determine if an
When set to a color other than Color.Transparent (the default), all occurrences of the color in the image will be made transparent.
If an image is supplied by setting an Appearance.Image property to an Imagelist index, the ImageLists TransparentColor property is looked at first. If that property is set to Color.TransparentColor, then the component's ImageTransparentColor is used. If it is set to Color.TransparentColor, then no color masking is done.
If an image is supplied by setting the Appearance.Image property to an image, the component's ImageTransparentColor is used. If it is set to Color.TransparentColor, then no color masking is done.
When UseMnemonic is set to true, which is the default value, a character preceeded by a single ampersand will be displayed with an underline beneath it. That character is treated as an access key so that pressing ALT + the mnemonic character will cause the control to take an action. In the case, of a label, focus is forwarded to the next control.
The AutoSize property is used to determine if the control
should automatically size based on its contents. When set to true, the control will
be sized based on the
The UltraButton is a standard windows button control and may be clicked using the mouse or keyboard (using the SPACE or ENTER keys).
Set the AcceptButton or CancelButton property of a Form to the button to allow the click event to be invoked using the ENTER or ESC keys respectively even if the button does not have focus.
When the form containing the UltraButton is displayed using the form's ShowDialog method, the
The UltraButton has much of the same functionality as the inbox Button control with some additional features including the
ability to fire the click event repeatedly while the button is pressed (
Note If the control that has focus accepts and processes the ENTER or ESC key, the UltraButton will not process it.
Note If the operating system supports themes and
This class implements the basic functionality for an autosize button control.
Set the AcceptButton or CancelButton property of a Form to the button to allow the click event to be invoked using the ENTER or ESC keys respectively even if the button does not have focus.
When the form containing the button is displayed using the form's ShowDialog method, the
The class includes a number of properties to determine the appearance of the button. For example, the
The class also includes properties to affect the behavior of the control. For example, the
Note When a button or other control does not receive focus, regardless of the CausesValidation property, the control with focus will not have its Validating/Validated events fired. These events are controlled and invoked by the base .Net control classes and are not invoked until the control loses focus, the container's Validate method is invoked, etc.
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
This method can be called to generate a
The button class is notified by the .net framework via the
IButtonControl interface when it becomes the default button. This
allows the button to modify its appearance to indicate its changed state. When
the button is the default button, it will show an extra outline around the border of
the control. This appearance change can be prevented using the
Note When the operating system supports themes and the
This property returns the actual style of the button used. If the
The PressedAppearance is used during the resolution of the button's appearance when the button is pressed down. The appearance can be used to specify a different color or image for the button when it is pressed.
Use this property to determine if an
The AcceptsFocus property is used to determine whether the button can receive focus. By default, this property is set to true so that the control can accept focus and be clicked using the keyboard. When set to false, the control will not be able to be navigated to using the mouse or keyboard.
Note When a button or other control does not receive focus, regardless of the CausesValidation property, the control with focus will not have its Validating/Validated events fired. These events are controlled and invoked by the base .Net control classes and are not invoked until the control loses focus, the container's Validate method is invoked, etc.
It is sometimes useful to allow the control to receive focus but to make so that it does not render the focus rectangle (the dotted line within the borders of the button). The ShowFocusRect property may be set to false to prevent the control from rendering the focus rectangle when the control receives focus. When set to true, its default value, the focus rectangle will be rendered when the control has the input focus.
The button class is notified by the .net framework via the
IButtonControl interface when it becomes the default button. This
allows the button to modify its appearance to indicate its changed state. When
the button is the default button, it will show an extra outline around the border of
the control. This appearance change can be prevented using the
Since the UltraLabel control does not receive focus and does not use the key messages, the default ImeMode is disabled.
When a button becomes the default button, it will render an extra border around the edge of the control. To prevent this behavior, set the ShowOutline property to false.
Double-clicking a button is not a recognized action and, as such, the DoubleClick event should not be used.
When the form containing the button is displayed using the form's ShowDialog method, the DialogResult property of the button may be used to specify the return value of the ShowDialog method.
Initializes a new UltraButton control.
This method can be used to retrieve information about various appearance-related settings being used by
an
When AutoRepeat is set to true, the click event will be invoked when the
SPACE key is first pressed or when the button is first pushed down. It will then wait for the delay specified
by the
Note When set to false, which is the default value, the click event will only occur when the button is released (by either releasing the mouse button that pressed the button or releasing the SPACE or ENTER key).
For more information about how this property is used, refer to the remarks about the
For more information about how this property is used, refer to the remarks about the
The ShapeImage property is used to create a non-rectangular shaped button. The image specified for this property is used to create the region for the button control as well as being used to render the borders of the button. The color in the lower left hand pixel of the image is used to determine which color will be "masked" out - that is, which color will determine the areas of the image that are considered transparent. All pixels that do not match this color are considered to be opaque and will make up the displayed area of the button.
Note When a ShapeImage is specified and
When the
This property is only used at design-time.
The AnimationControl class is a wrapper for the Microsoft Common Controls Animation Control class. The control provides the ability to display AVIs without sound.
The
The
Note Since the class overrides members of the
The CommonControlBase class is an abstract base class for creating a control wrapper for a Microsoft Common Control.
Note Since the class overrides members of the
The AnimationControl does not receive focus so changing this property will not affect the control.
Since the AnimationControl does not receive focus and does not use the key messages, the default ImeMode is disabled.
The FileName property indicates the name of the avi file that should
be played when the
When set to true, the animation will automatically begin when the handle for the control is created.
When set to true, the animation will be centered within the control bounds as the control is resized. When set to false, the animation is sited in the upper left corner of the client area of the control.
When set to true, the animation control will use a timer instead of a separate thread to handle changing the frames of the animation.
The AnimationSource determines which animation will be displayed. When set
to AviFile, the animation is obtained from the file specified for the
The UltraDropDownButton is a button control that can display a dropdown window.
When the
The
When the dropdown window is about to be displayed, the
Set the AcceptButton or CancelButton property of a Form to the button to allow the click event to be invoked using the ENTER or ESC keys respectively even if the button does not have focus.
When the form containing the button is displayed using the form's ShowDialog method, the
Note Even when the
Initializes a new
The DropDown method is used to display the dropdown window. If the
button is already dropped down (see
The control may also be dropped down by clicking on the dropdown button or via the DOWN arrow key when the control has focus.
The CloseUp method is used to close the dropdown window. Once the
dropdown window has been closed, the
The Style property is used to determine the display style for the control.
When set to SplitButton, which is the default value, two buttons will be displayed. The main
button that will display the image and text and will invoke the
The PopupItem property specifies the object that will display
the dropdown window. This can be any object that implements the
This property is only available at runtime.
If this property is left to its default value then it is resolved based on whether the user's operating system is configured to display drop-down menus on the righthand side of the corresponding menu-bar item.
If this property is left to its default value then it is resolved based on whether the user's operating system is configured to display drop-down menus on the righthand side of the corresponding menu-bar item.
The DroppingDown event is raised when the dropdown window
(specified using the
The ClosedUp event is invoked after the dropdown window has been closed.
This property is only used at design-time.
Note: If associated
If the value assigned is less than
Note: If associated
If the value assigned is greater than
Note: If associated
Note: If associated
This control provides much of the same functionality as the .Net Panel control. In addition, it also allows for advanced appearance customization of the scroll bars and UltraPanel itself, including the ability to use application styling.
Controls cannot be added directly to the UltraPanel. Child controls must be added to the client area of the
UltraPanel, which can be accessed from 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
When this property is True, the
This property is only used at design-time.
Use this property to determine if an
When this value is False, the scroll bars can be manually managed by setting values on the
If the right or bottom edges of a child control extend outside this value's width or height, that display area will be increased in size to fit the entire child control.
If there are no scroll bars visible in the UltraPanel, this control will occupy the entire area of the control. Otherwise, it will occupy the area which is no occupied by the scroll bars.
Controls cannot be added directly to the UltraPanel. Child control must be added to the client area of the
UltraPanel, which can be accessed from the
When this value is True, it implies the
Both formatted and unformatted text can be used for the caption. The type of text will be automatically detected based on the value assign.
Invoke the
Resets the property values of the
This property is only used at design-time.
This applys to direct movement from the user and indirect movement for when the user drags another UltraTile over the current UltraTile.
This property will be ignored when a tile is placed in the Large state and all Normal state tiles
must be moved to the side. This will also not affect the ability for the tile to be moved programmatically
with the
Both formatted and unformatted text can be set on this property. The type of text will be automatically detected based on the value assign.
When all visible UltraTiles in an
If one or more visible UltraTiles are in the Large state, they will occupy the majority of the UltraTilePanel while the remaining Normal state tiles will occupy a smaller portion of the panel on one of the sides.
Invoke the
Resets the property values of the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
This property is only used at design-time.
The appearance will be displayed behind all the tiles in the panel.
This is a read-only property that returns a boolean indicating if the
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 UltraWinToolbars, 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.
This property is used to hold a collection of Appearance objects.
This is a read-only property that returns a boolean indicating if the
This is a read-only property that returns a boolean indicating if the
If putting a tile in the Large state causes the number of visible large tiles to exceed the MaximumVisibleLargeTiles
value, the first large tile in the
The set accessor for this value should only be used by the designer generateed code.
Note: Derived classes should call the base implementation so that the Disposed property gets set.
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
Invoke the
Resets the property values of the
This is a read-only property that returns a boolean indicating if the
This is a read-only property that returns a boolean indicating if the
This is a read-only property that returns a boolean indicating if the
This is a read-only property that returns a boolean indicating if the
If the header is shown on the top or bottom of the UltraTile, this value indicates the height of the header. If the header is shown on the left or right of the UltraTIle, this value indicates the width of the header. If the header is hidden, this value is ignored.
Clicking the close button will hide the UltraTile and its Visible property will return False. The UltraTile can only be shown again by programmatically setting Visible back to True.
The state change button will have different effects on the
If putting an UltraTile in the Large state will put the number of Large tiles in the
This is a read-only property that returns a boolean indicating if the
This is a read-only property that returns a boolean indicating if the
This is a read-only property that returns a boolean indicating if the
This is a read-only property that returns a boolean indicating if the
If the header is shown on the top or bottom of the UltraTile, this value indicates the height of the header. If the header is shown on the left or right of the UltraTIle, this value indicates the width of the header. If the header is hidden, this value is ignored.
An UltraNavigationBarActionButtonSettings instance is returned from the
The ActionButtonUIElement contains one of the following child elements:
The size at which the image is displayed is determined by the
The name of the AppStyling
The LocationListItemContainerUIElement contains one or more of the following child elements:
The LocationListItemContainerUIElement is a container for the
The name of the AppStyling
The LocationListItemUIElement contains one of each of the following child elements:
The name of the AppStyling
The name of the AppStyling
The NavigationBarEditModeClickAreaUIElement contains no child elements. When it is clicked by the end user, the control is placed into edit mode.
After the control has entered edit mode, the NavigationBarEditModeClickAreaUIElement no longer appears; an in-place editor appears in this area instead.
The
The ZoomMode enumeration is used by the
The PreviewMouseAction is used by the
The PageNumberDisplayStyle enumeration is used by the
The ViewBoxDisplayStyle enumeration is used with the
The ViewBoxDisplayStyle enumeration is used with the
Note: This method is currently only used by the
Use this method to retrieve the actual values that are being used to format the control. This method returns a value for all Appearance properties or only for specified ones, tracing up the Appearance hierarchy if necessary. You can combine the bit flags for this method to specify which properties should be resolved.
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
This event is fired when the value specified to the formatted link editor has parsing errors.
BackColor, ForeColor and BackGroundImage properties are
not supported. Use the
BackColor, ForeColor and BackGroundImage properties are
not supported. Use the
BackColor, ForeColor and BackGroundImage properties are
not supported. Use the
The Fontproperty is not supported. Use the
ActiveLinkAppearance is applied to the link when the user presses a mouse button on the link. This appearance is applied while the mouse button is pressed down. When the mouse button is depressed, this appearance ceases to be applied.
HotTrackLinkAppearance appearance is applied to a link when the user hovers mouse over it.
VisitedLinkAppearance appearance is applied to links that are previously visited.
The visited links are tracked using the
LinkAppearance is applied to the links that are displayed in the control.
If this property is set to True, the size of the control automatically adjusts to fit the contents. When False, the control's size remains the same until explicitly changed. The default is False.
You can use the
The event manager gives you a high degree of control over how the control invokes event procedures. You can use it to selectively enable and disable event procedures depending on the context of your application. You can also use the event manager to return information about the state of the control's events.
The event manager's methods are used to determine the enabled state of an event (
You can use the
Text property gets or sets the text being displayed, without any formatting information.
To get or set the text with formatting, use the
Use the Value property to set the value that will be displayed by the control.
Depending on the
By default the behavior is auto-detected from the MS Internet Explorer by reading settings from the registry. Use the UnderlineLinks property to explicitly set the behavior.
You can specify relative sources for hyperlinks and images in the formatted text. The default behavior
is to use the application's current path to resolve the url to access the associated resource.
You can use the BaseURL property to control how relative URL's are resolved. Also note that
the base URL can be set for all instances of this control in an application by setting the FormattedLinkEditor's
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
This property should not be used for the
Since the UltraFormattedLinkLabel control does not receive focus and does not use the key messages, the default ImeMode is disabled.
See
This event is fired when the edit state of the formatted link editor changes. This event is only fired when the editor is in edit mode. Examples of changes that will lead to firing of this event are change in the SelectionStart, SelectionLength, Value, change in the formatting state (toggling of bold, italics etc...), change in undo/redo history etc....
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.
Indicates whether the control can utilize an
ReadOnly specifies whether the user will be allowed to modify the contents of the control. However note that the user will be allowed to enter the edit mode and select and copy part of the contents.
This enum is used by the
This enum is used by the
This enum is used by the
This enum is used by the
This enum is used by the
This enum is used by the
This enum is used by the
The
This method is intended for internal use only.
This method is intended for internal use only.
This is the element responsible for rendering the background of the control's content area. It is a sibling of a
This is the element responsible for rendering the background of the control's content area. It is a sibling of a
This override will trim off the edges needed for a rounded border, if the control's border style is 'Rounded'.
This is the element responsible for rendering the border of the control's content area. It is a sibling of a
This is the element responsible for rendering the border of the control's content area. It is a sibling of a
The UltraExpandableGroupBox has all of the features of the
It can be configured so that the header (which includes the caption and optional image) appears on any of its four sides. By default the header is positioned on the border but it can also be outside of the border and inside of it as well.
Initializes a new UltraGroupBox.
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
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
OnPropertyChanged will also be called.
The settings on this
Use this property to determine if an
Do not use this property.
This property allows you to specify the border displayed around the area of the control which contains the
hosted controls. The default value of this property is 'Default' and is resolved based on the
If the control's
This property controls where the caption appears in the header. The behavioral invariant of this property is that setting it to 'Near' will cause the caption to be rendered such that the first character is close to an edge of the header. In other words, setting this property to 'Far' will cause the last character of the caption to be rendered close to an edge of the header (possibly leaving a large gap between the first character and a header edge).
If the header is horizontal then setting this property to 'Near' means that the caption will be rendered
on the left side of the header. If the header is vertical (i.e. on the left or right edge of the control)
then the
Use this property to determine if an
Note, in the
Returns the rectangle which defines the area within the content area's borders.
Not used for the
Not used for the
The settings on this
Use this property to determine if an
This property can be used to adjust the border around the control's header. It can be set to any of the
values available in the
If the
This property can be used to determine the location of the controls header. There are two aspects involved with the different header positions: which side of the control, and the location relative to the controls border. The header can be on the top or bottom of the control (i.e. horizontal) or on the left or right side (i.e. vertical). The header can also be "on" the border, "outside" the border, or "inside" the border. The meaning of these latter terms are relative to the side of the control that the header is on.
For example, if the header is on the top edge of the control then "outside" the border means above it, and "inside" the border means below it. When the header is said to be "inside" the border, it always indicates that the header is contained within the content area of the control.
If the control's
Not used by the
Not used by the
This property can be used to specify the text which appears in the header of the control.
This property provides access to the main
Providing a mnemonic key for the control can make it easier for the end-user to quickly navigate an
application's user interface. When the mnemonic key of an
Not used by the
This property dictates whether the text in the header is drawn starting at the top or bottom. The
The view style affects the colors and border style of the control.
Below is an overview of the different
Setting this property to true, in effect, enables the caption to be multi-line. Use the
This property is only used at design-time.
Invoke this method to reset the
Invoke this method to reset 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
This overrides the base class's implementation and resolves the border style differently if the
control's
When the value of this property is changed the
This property is used internally by the control and is not intended for use outside of the control.
The control's header can be located on any of the four sides of the content area. If the header is on the top or bottom side (i.e. it is horizontal) then setting this property to 'Far' causes the expansion indicator to appear on the righthand side of the control. If the header is vertical then 'Far' means that the expansion indicator is to be positioned toward the bottom of the control.
If this property is set to 'None' then the expansion indicator will not be displayed. In that situation the
The specified image will be scaled to fit within a square roughly 16 by 16 pixels.
The exact dimensions depend on the control's
The specified image will be scaled to fit within a square roughly 16 by 16 pixels.
The exact dimensions depend on the control's
This property can be set to one of the three
If the
The settings made on this
Use this property to determine if an
The settings made on this
Use this property to determine if an
The settings made on this
Use this property to determine if an
Gets the resolved header position.
The
It is sometimes useful to allow the control to receive focus but to prevent it from rendering the focus rectangle (the dotted line within the borders of the expansion indicator). The ShowFocus property may be set to false to prevent the control from rendering the focus rectangle when the control receives focus. When set to true, its default value, the focus rectangle will be rendered when the control has the input focus.
Set this property to false if the user should not be able to navigate to the
The view style primarily affects the colors and border style of the control. When the view style is set to 'Office2003' or 'VisualStudio2005' the expansion indicator will have a different size and appearance.
Below is an overview of the different
This property will only affect the
Note: The VisualStudio2005 style will not be affected by this property.
This property is only used at design-time.
Initializes a new
The
The UltraLabel control has functionality similar to that of the
intrinsic .Net Label control as well as some additional functionality. There is an
The
Resets the
This property can be used to adjust the style of the border which appears closer to the control's text, as opposed
to the border specified via
If the
This property can be used to adjust the style of the border which appears closer to the control's edge, as opposed
to the border specified via
If the
This property can be used in scenarios where the desired visual effect requires a gap between the
inner and outer borders of the control. The style of those borders can be specified via the
This property should not be used for the
Since the UltraLabel control does not receive focus and does not use the key messages, the default ImeMode is disabled.
This property is only used at design-time.
The ControlLayoutItem class is used by the
The ControlLayoutItem is used to manage layout constraints
and may be used with any
This method returns a boolean indicating if the
This method resets the
This method returns a boolean indicating if the
This method resets the
This is a read-only property that returns the
The MinimumSize is used by a
Note: Not all layout managers change the size of the controls whose layout it manages and therefore this property may not affect the layout.
The PreferredSize is used by a
Note: Not all layout managers change the size of the controls whose layout it manages and therefore this property may not affect the layout.
The IncludeInLayout is used to determine whether
the
Note: Not all layout managers use additional constraints but those
that do require that the constraints be of a certain type. For example, the
The
At design time, the component adds 3 extender properties to each control within the
associated ContainerControl. IncludeInLayout is used to indicate whether the control
should be arranged by the component. By default, all controls within the ContainerControl are
arranged by the component. MinimumSize is used to indicate to the associated layout manager
what is the minimum size that the control should be displayed at. PreferredSize is used to
indicate the size at which the control would prefer to be set. Since these are extender properties,
if you need to access the values at runtime, you must use the corresponding get/set methods on this
component (e.g. to access the IncludeInLayout property, you would use the
The component includes a set of methods that may be used to control when the
arrangement of the controls will occur.
This method returns a boolean indicating if any of the propertyies of the
This method resets the properties of the
The MinimumSize is used when determining how the layout should be arranged and
indicates the minimum size that the control can allow. If the property has not been set, the value
returned will be 0, 0 or if the control implements
Note: Not all layout managers change the size of the controls whose layout it manages and therefore this property may not affect the layout.
The MinimumSize is used when determining how the layout should be arranged and indicates the minimum size that the control can allow.
Note: Not all layout managers change the size of the controls whose layout it manages and therefore this property may not affect the layout.
This method returns a boolean indicating whether the MinimumSize has been
specified for the
This method resets the MinimumSize for the
The PreferredSize is used when determining how the layout should be arranged and indicates
the preferred size to which the control would like to be sized. If the property has not been set, the value returned
will be the current size of the
Note: Not all layout managers change the size of the controls whose layout it manages and therefore this property may not affect the layout.
The PreferredSize is used when determining how the layout should be arranged and indicates
the preferred size to which the control would like to be sized. If the property has not been set, the value returned
will be the current size of the
Note: Not all layout managers change the size of the controls whose layout it manages and therefore this property may not affect the layout.
This method returns a boolean indicating whether the PreferredSize has been
specified for the
This method resets the value of the PreferredSize for the specified control
to its default value, which is its current size or the size indicated by its
The IncludeInLayout is used to determine whether
the component should arrange the specified
The IncludeInLayout is used to determine whether
the component should arrange the specified
This method returns a boolean indicating whether the IncludeInLayout has been
specified for the
This method resets the value of the PreferredSize for the specified control
to its default value, which is the value indicated by its
The SuspendLayout method is used to prevent the component
from arranging the controls in its associated
The ResumeLayout method is used after invoking the
ResumeLayout must be called for each time that
The ResumeLayout method is used after invoking the
ResumeLayout must be called for each time that
The PerformLayout method is used to force the component
to synchronously arrange the controls within its associated
The PerformLayout method is used to force the component
to synchronously arrange the controls within its associated
The ContainerControl is used to determine whose controls
will be arranged by the component. The layout manager will arrange all the controls
within the specified control unless the
At designtime, all controls within the specific container control will
have 3 additional properties - IncludeInLayout, MinimumSize, and
PreferredSize. At runtime, you can access the values of these using the
corresponding get/set methods (e.g. to access the IncludeInLayout value, you can use
the
Note: This property must be set in order for the component to know which controls to arrange. In addition, the component only manages the direct children of the container control. It does not arrange any controls within those controls.
The Margins property returns an instance of a
This is a read-only property that returns a boolean indicating if the
This property returns a boolean indicating if the component will ignore layout requests.
This property defers to the
This property defers to the
This is a read-only property that returns the
The UltraFlowLayoutManager is component that is designed to
arrange controls in such a way that they flow within the associated
The component exposes four additional properties that control the layout
of the controls. The
Initializes a new
Initializes a new
The Orientation property determines how the items are arranged within the
associated
The HorizontalGap is the number of pixels of space added to the left and right
of each control. The
The
The Alignment property indicates how the row or column of
cotrols is arranged based on the
The WrapItems property determines whether the controls are arranged in a single
row/column (depending on the
The HorizontalAlignment controls the horizontal alignment of the row of
controls when the
The VerticalAlignment controls the vertical alignment of the column of
controls when the
The UltraGridBagLayoutManager is a component that is used to arrange
controls based on a set of constraints for each control. An additional property is added to
each control within the associated
The
The GridBagConstaint available for each control also provides additional
properties to control the size of the logical cells that the control will occupy. For example,
the
The GridBagConstaint also includes two properties that control how the
control is positioned within the logical cells it occupies. The
The
The GridBagConstaint available for each control also provides additional
properties to control the size of the logical cells that the control will occupy. For example,
the
The GridBagConstaint also includes two properties that control how the
control is positioned within the logical cells it occupies. The
The
The GridBagConstaint available for each control also provides additional
properties to control the size of the logical cells that the control will occupy. For example,
the
The GridBagConstaint also includes two properties that control how the
control is positioned within the logical cells it occupies. The
This method returns a boolean indicating whether the GridBagConstraint has been
specified for the
This method resets the
Note: This would only get applied if all the items had 0.0 weightX's.
Note: This would only get applied if all the items had 0.0 weightY's.
The
The GridBagConstaint available for each control also provides additional
properties to control the size of the logical cells that the control will occupy. For example,
the
The GridBagConstaint also includes two properties that control how the
control is positioned within the logical cells it occupies. The
The
The GridBagConstaint available for each control also provides additional
properties to control the size of the logical cells that the control will occupy. For example,
the
The GridBagConstaint also includes two properties that control how the
control is positioned within the logical cells it occupies. The
This method returns a boolean indicating whether the GridBagConstraint has been
specified for the
This method resets the
The IncludeInLayout is used to determine whether
the component should arrange the specified
The IncludeInLayout is used to determine whether
the component should arrange the specified
This method returns a boolean indicating whether the IncludeInLayout has been
specified for the
This method resets the value of the PreferredSize for the specified control
to its default value, which is the value indicated by its
The PreferredSize is used when determining how the layout should be arranged and indicates
the preferred size to which the control would like to be sized. If the property has not been set, the value returned
will be the current size of the
Note: Not all layout managers change the size of the controls whose layout it manages and therefore this property may not affect the layout.
The PreferredSize is used when determining how the layout should be arranged and indicates
the preferred size to which the control would like to be sized. If the property has not been set, the value returned
will be the current size of the
Note: Not all layout managers change the size of the controls whose layout it manages and therefore this property may not affect the layout.
This method returns a boolean indicating whether the PreferredSize has been
specified for the
This method resets the value of the PreferredSize for the specified control
to its default value, which is its current size or the size indicated by its
This property is only used at design-time.
Note: This would only get applied if all the items had 0.0 weightX's.
Note: This would only get applied if all the items had 0.0 weightY's.
The UltraPopupControlContainer is a component that can be used to display any
The
The
The class exposes several events to provide a notification when the popup window is opening (
Initializes a new
Initializes a new
Displays the popup window using the current position of the mouse cursor as the preferred location.
Displays the popup window using the specified Point as the preferred location.
Displays the popup window using the current position of the mouse cursor as the preferred location. The 'owner' argument is used to indicate which control is the owning control during the popup operation.
Displays the popup window using the specified Point as the preferred location. The 'owner' argument is used to indicate which control is the owning control during the popup operation.
The FromControl method will return the
Note The popup window must be displayed or the associated UltraPopupControlContainer will not be available from this method.
If the popup window is displayed (see
The Show method is used to display the popup window. The
The PopupControl is the control that will be displayed in the popup
window when the
Note Attempting to set the property while the popup window is displayed
(see
The Opening event is raised when the
The event may be cancelled by setting the
The Opening event is raised when the
The event may be cancelled by setting the
This property is only used at design-time.
The Closed event is raised when the popup window has been closed, whether it is
the result of clicking elsewhere on the screen or when closed via the
The IsDisplayed property will return true while the popup window is displayed.
Returns the Control that displayed the popup window. This property is only available at runtime.
This class maps keyboard keys with UltraPrintPreviewThumbnail actions.
This class maps keyboard keys with UltraPrintPreviewControl actions.
This method returns a boolean indicating whether the
This method resets the
This method returns a boolean indicating whether the
This method resets the
This method returns a boolean indicating whether the
This method resets the
This method returns a boolean indicating whether the properties of the
This method resets the properties of the
Returns a Boolean value that determines whether the
This is a read-only property that returns a boolean indicating if any properties of the
Resets the property values of the
Returns a Boolean value that determines whether the
This is a read-only property that returns a boolean indicating if any properties of the
Resets the property values of the
Returns a Boolean value that determines whether the
This is a read-only property that returns a boolean indicating if any properties of the
Resets the property values of the
Returns a Boolean value that determines whether the
This is a read-only property that returns a boolean indicating if any properties of the
Resets the property values of the
Returns a Boolean value that determines whether the
This is a read-only property that returns a boolean indicating if any properties of the
Resets the property values of the
This method returns a boolean indicating whether the
This method resets the
The ZoomMode determines how the pages are scaled and includes
values that either indicate that the
The Zoom property is used by the
The Columns property is used to determine the number of columns of
preview pages that will be displayed in the associated
Note: When the
When set to 0, which is the default value, the pages will be arranged in a continuous flow from left to right and top to bottom. When this property is set to 1 or higher, that will be used to indicate the maximum number of rows per "view". A view is considered a group of preview rows that can be viewed at the same time.
The PageNumberDisplayStyle determines where page numbers are
displayed relative to the preview pages. The default value for this property depends
upon the associated control. For an
The BorderStyle property determines the border that is rendered around the client area of the control. By default, a value of Inset is used if the property not set.
The ScrollBarLook contains properties that affect the appearance of the
horizontal and vertical scrollbar within the associated
Note: When the operating system supports themes and
The ShowHorizontalScrollBar is used to determine
whether the horizontal scrollbar in the associated
Note: When this property is set to Automatic, which is the
default value, the scrollbar will be displayed if the
The ShowVerticalScrollBar is used to determine
whether the vertical scrollbar in the associated
Note: When this property is set to Automatic, which is the
default value, the scrollbar will be displayed if the
The Appearance property is an
This is a read-only property that returns a boolean indicating if the
The PageNumberAppearance is an
This is a read-only property that returns a boolean indicating if the
The PageNumberAppearance is an
This is a read-only property that returns a boolean indicating if the
The CurrentPageNumberAppearance is an
This is a read-only property that returns a boolean indicating if the
The CurrentPageNumberAppearance is an
This is a read-only property that returns a boolean indicating if the
The AcceptsFocus property is used to determine whether the control can
receive focus. The default value for this property depends upon the associated
The ScrollMode property is used to determine whether vertical scrolling within
the associated
Note: The setting for this property affects the
The ScrollTipStyle property is used to determine whether a tooltip
containing the page number is displayed while the vertical scrollbar thumb is being dragged
in the associated
Note: The default setting for this property is affected by the
The MousePanning property is used to determine if/how the
control should be allowed to scroll while the middle mouse button is pressed over
the client area of the control. By default, both horizontal and vertical mouse
panning is allowed although the default value may be affected by the current
The UltraPrintPreviewControl is a specialized
The
The UltraPrintPreviewControl also includes the ability to
use the mouse to change the zoom, zoom in on a particular area, place a snapshot of a
portion of a page to the clipboard, or scroll based on the
The control also includes support for a view history. The view history are snapshots
of the scroll position and zoom settings at various points. These snapshots are automatically taken
as the end-user scrolls, changes the zoom, drags the viewbox of the associated
The UltraPrintPreviewControlBase is an abstract base class for controls that
display print preview pages. Currently, there are two controls that derive from this base class -
The
Returns a Boolean value that determines whether the
This method returns true if any properties on the
Resets the property values of the
Raising an event invokes the event handler through a delegate.
The OnCurrentZoomChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnCurrentZoomChanged in a derived class, be sure to call the base class's OnCurrentZoomChanged method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnCurrentPageChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnCurrentPageChanged in a derived class, be sure to call the base class's OnCurrentPageChanged method so that registered delegates receive the event.
This is a read-only property that indicates the
This is a read-only property that returns the resolved value indicating whether the
preview pages are displayed while the vertical scroll thumb is dragged (i.e. Immediate) or if the
pages displayed prior to the start of the drag operation remain visible until after the scroll thumb
has been released (i.e. Deferred). When the
This is a read-only property that returns the resolved value indicating whether a scroll tip will
be displayed when the vertical scroll thumb is dragged. By default, the ScrollTipStyleResolved is based on
the
This is a read-only property that returns the resolved value indicating
whether mouse panning is supported by the control. By default, both horizontal and vertical
panning is enabled unless the
The Settings property returns an instance of a
This is a read-only property that returns an integer value indicating the number of preview pages that will be displayed by the control.
This is a read-only property that returns a double value indicating the current zoom level at which the preview pages are being displayed.
This is a read-only property that return an integer indicating the
first page that contains the largest portion of its visible area in the control. The
value returned is 1-based. If there are no pages in the control (i.e.
This is a read-only property that returns a boolean indicating if there are
any pages before the
This is a read-only property that returns a boolean indicating if there are
any pages after the
This is a read-only property that returns a boolean indicating if
the
This is a read-only property that returns a boolean indicating if
the
The CurrentZoomChanged is invoked when the resolved zoom used to
display the currently visible pages has been changed. This can occur because the
The CurrentPageChanged is invoked when the
The GeneratePreview method is used to synchronously cause the generation of the
preview pages. By default, the pages will be generated when pages are requested although the automatic
generation of pages can be prevented by setting the
This method is used to explicitly dirty the cached preview information. When the preview information is subsequently requested, the preview pages will be generated.
PerformAction simulates user interaction with the control. Calling Peformaction will cause the control to behave as through the user performed the specified action. Any appropriate events will be called as if the user performed the action.
The Print method is used to invoke the
Raising an event invokes the event handler through a delegate.
The OnPreviewGenerated method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnPreviewGenerated in a derived class, be sure to call the base class's OnPreviewGenerated method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnViewHistoryChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnViewHistoryChanged in a derived class, be sure to call the base class's OnViewHistoryChanged method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnSnapshotCreated method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnSnapshotCreated in a derived class, be sure to call the base class's OnSnapshotCreated method so that registered delegates receive the event.
The Document property is the
Note: Changing this property will cause the entire preview to be regenerated.
This property is used to determine whether the print preview will be rendered using anti-aliasing. By default, anti-aliasing is not used.
Note: Changing this property will cause the entire preview to be regenerated.
By default, when a print operation is running a status dialog is displayed. This dialog indicates the page that is being printed and also includes a button that can be used to end the operation. If you do not want to display this dialog, you must set the DisplayPreviewStatus property to false.
The AutoGeneratePreview property is used to determine whether the control
should automatically create the print preview pages when they are needed. Normally, the preview
pages are automatically generated when the control is rendered. You can set this property to
false to prevent that behavior. You would then need to explicitly call the
The MaximumPreviewPages is used to restrict how many pages will be created when the print operation is performed and therefore how many pages may be displayed by the control.
Note: Changing this property after the print preview operation has completed will not affect how many pages are displayed but instead will affect the next print operation, if one occurs.
The MouseAction is used to determine how the control will react while it has the input focus. When used with a value of Hand, the left mouse button may be pressed on a page and dragged to scroll the visible area. A value of Snapshot is used to allow the end-user to click on or lasso an area of a page that should be copied to the clipboard. The area is copied using the current zoom value.
The MouseAction also includes several options for
controlling the current
This is a read-only property that returns the resolved
This is a read-only property that returns a flagged enumeration which indicates the current states of the control.
The following table lists the default key mappings for the
| KeyCode | ActionCode | StateRequired | StateDisallowed | SpecialKeysRequired | SpecialKeysDisallowed |
|---|---|---|---|---|---|
| Prior | ScrollPageUp | Pages | All | ||
| Prior | ScrollToTop | Pages | ShiftCtrl | ||
| Next | ScrollPageDown | Pages | All | ||
| Next | ScrollToBottom | Pages | ShiftCtrl | ||
| Home | ScrollToTop | Pages | |||
| End | ScrollToBottom | Pages | |||
| Up | ScrollUp | Pages | All | ||
| Up | ScrollToTop | Pages | ShiftCtrl | ||
| Down | ScrollDown | Pages | All | ||
| Down | ScrollToBottom | Pages | ShiftCtrl | ||
| Add | ZoomIn | Pages | Ctrl | ||
| Subtract | ZoomOut | Pages | Ctrl | ||
| Space | ScrollPageDown | Pages, MouseActionHand | All | ||
| Left | ScrollToPreviousPage | Pages | All | ||
| Right | ScrollToNextPage | Pages | All |
As the view of the UltraPrintPreviewControl changes, a history is maintained
of the areas of the pages that have been viewed. This is the view history. The HasPreviousView
and
Note: There is a limit on the history depth that will be maintained. Once that depth is reached, subsequent history entries will remove the earliest entries as needed.
As the view of the UltraPrintPreviewControl changes, a history is maintained
of the areas of the pages that have been viewed. This is the view history. The
Note: There is a limit on the history depth that will be maintained. Once that depth is reached, subsequent history entries will remove the earliest entries as needed.
The PreviewGenerated is used to notify listeners of when the preview pages have been generated. This event is useful since by default the preview pages are only generated when the page information has been requested (internally or externally).
The ViewHistoryChanged is used to notify listeners when
the view history has changed. The view history is an internally managed list of
changes in the view. This can include scrolling, changing the zoom, dragging the
viewbox of the
When the
Note: The ability to copy to the clipboard will depend upon the rights
available as well as any other restrictions placed on using the
This is a read-only property that returns an integer value indicating the number of preview pages that will be displayed by the control.
The UltraPrintPreviewThumbnail is a derived
The control includes the capability to display a "viewbox" within its preview pages. This viewbox
indicates which portions of the pages within the associated PreviewControl are currently in view. The
Returns a Boolean value that determines whether the
This is a read-only property that returns a boolean indicating if any properties of the
Resets the property values of the
Returns a Boolean value that determines whether the
This is a read-only property that returns a boolean indicating if any properties of the
Resets the property values of the
Returns a Boolean value that determines whether the
This is a read-only property that returns a boolean indicating if any properties of the
Resets the property values of the
PerformAction simulates user interaction with the control. Calling Peformaction will cause the control to behave as through the user performed the specified action. Any appropriate events will be called as if the user performed the action.
The PreviewControl is used to associate the
The viewbox is the area within the preview pages of the
Currently the
This is a read-only property that returns a boolean indicating if the
This is a read-only property that returns a flagged enumeration which indicates the current states of the control.
The following table lists the default key mappings for the
| KeyCode | ActionCode | StateRequired | StateDisallowed | SpecialKeysRequired | SpecialKeysDisallowed |
|---|---|---|---|---|---|
| Prior | ScrollPageUp | Pages | All | ||
| Prior | ScrollToTop | Pages | ShiftCtrl | ||
| Next | ScrollPageDown | Pages | All | ||
| Next | ScrollToBottom | Pages | ShiftCtrl | ||
| Home | ScrollToTop | Pages | |||
| End | ScrollToBottom | Pages | |||
| Up | ScrollUp | Pages | All | ||
| Up | ScrollToTop | Pages | ShiftCtrl | ||
| Down | ScrollDown | Pages | All | ||
| Down | ScrollToBottom | Pages | ShiftCtrl | ||
| Left | ScrollToPreviousPage | Pages | All | ||
| Right | ScrollToNextPage | Pages | All |
The CurrentPreviewPageNumberAppearance is an
This is a read-only property that returns a boolean indicating if the
The CurrentPreviewPageNumberAppearance is an
This is a read-only property that returns a boolean indicating if the
The ViewBoxDisplayStyle determines which preview pages, if any, will include
a viewbox element. The viewbox element indicates what portion of that page is currently displayed within
the associated
The ViewBoxDragMode is used to determine whether the view box may be
repositioned with the preview pages. The viewbox is an area with a preview page that indicates
the portion of the corresponding page in the
This is a read-only property which returns the resolved
This is a read-only property that returns an integer value indicating the number of preview pages that will be displayed by the control.
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
Property identifiers are passed to handlers of the
The AlertButtonAreaUIElement contains one or more of the following child elements:
The size at which the buttons are displayed is determined by the
The ButtonBoxAreaUIElement contains the following child elements (listed as they appear from left to right):
The size at which the buttons are displayed is determined by the
The CaptionAreaUIElement contains the following child elements:
The visual appearance of the CaptionAreaUIElement is controlled by the
The name of the
The FooterAreaUIElement contains the following child elements:
The name of the
| UIRole Name | |||
|---|---|---|---|
| Caption | DesktopAlertCaptionLink | ||
| Text | DesktopAlertTextLink | ||
| Footer | DesktopAlertFooterTextLink |
The MainImageAreaUIElement contains the following child elements:
A border can be drawn around the MainImageUIElement, the color of which is determined by the
The image displayed by the MainImageUIElement is determined by the
The TextAreaUIElement contains the following child elements:
The WindowClientAreaUIElement contains the following child elements:
Windows Live Messenger draws its background using a "split" gradient, where
the top half has a VerticalBump
gradient, and the bottom half has a solid background. To achieve this look,
two
The visual appearance of the WindowClientAreaUIElement is determined by the
The name of the
Windows Live Messenger draws its background using a "split" gradient, where the top half has a VerticalBump gradient, and the bottom half has a solid background. This element makes it possible to achieve this look without performing any customing drawing, and without exposing separate appearance properties for each area.
The element only appears when the following properties of the
Note: The Cancel property of the
The GripAreaUIElement contains the following child elements:
The visual appearance of the GripAreaUIElement is controlled by the background-related properties of the
Note: The GripAreaUIElement is only displayed when the
The name of the
The GripIndicatorUIElement contains no child elements. It derives from
The visual appearance for this element is controlled by the
The name of the
The visual appearance for this element is controlled by the
The name of the
The name of the
The PinButtonUIElement is only displayed when the
The Infragistics UltraDesktopAlert component provides the ability for the end developer
to display an
The displaying of a desktop alert window is accomplished by a simple two-step process; first, an
object of type
The following table cross references some of the features of the UltraDesktopAlert component with
the members of the public object model which control them:
| Feature | Public members |
|---|---|
| Customizing look and feel of desktop alerts | |
| Controlling animation | |
| Displaying hyperlinks/formatted text | |
| Customizing images | |
| Playing sounds | |
| Customizing colors and visual formatting |
|
| Customizing the appearance and behavior of buttons | |
| Programmatic management of desktop alert windows | |
| Getting/setting the size and location of desktop alert windows | |
| Controlling whether/how desktop alert windows can be dismissed/moved by the end user |
|
| Controlling whether multiple desktop alert windows can be displayed |
Note: The specified
Note: The key parameter must match that of an
The caption area is situated at the top of the desktop alert window, and looks similar to the titlebar of a standard
The Application Styling equivalent of the Appearance property is realized through the DesktopAlertControlArea
The grip area is situated at the top of the desktop alert window; when the
The Application Styling equivalent of the Appearance property is realized through the DesktopAlertControlArea
By default, no alert buttons are displayed in the desktop alert windows. Adding
Buttons can be hidden for a particular desktop alert window by using the
Note: Changing properties of the
The AllowMove property resolves to true for the 'Office2007' setting of the
Note: Changing properties of the
The MultipleWindowDisplayStyle property resolves to 'None' for the 'Office2007' setting of the
Note: Changing properties of the
The AnimationSpeed property determines the number of frames that will be used when animating the showing/closing of the desktop alert window. A value of 'Slow' results in more animation frames, which results in less of a change in window size or opactity from one frame to another.
Note: The actual amount of time it takes for the animation sequence to execute is ultimately dependent on the performance capabilities of the local machine, as well as the number of processes being serviced by the CPU at the time the sequence is executed.
Note: Changing properties of the
The default value for the AnimationScrollDirectionShow property is 'AutoSelect'. When set to this value, the "ideal" scroll direction, based on the initial screen location of the desktop alert window, is automatically selected.
The following table cross references the screen location of the desktop alert window with the
| Screen location | AnimationScrollDirection constant |
|---|---|
| Top edge of desktop alert window is aligned with top edge of screen | TopToBottom |
| Bottom edge of desktop alert window is aligned with bottom edge of screen | BottomToTop |
| Left edge of desktop alert window is aligned with left edge of screen | LeftToRight |
| Right edge of desktop alert window is aligned with right edge of screen | RightToLeft |
| No edge of desktop alert window is aligned with any edge of the screen | BottomToTop (based on the default initial |
These values are used in the interest of making the desktop alert window to appear to "slide" onto the screen. Precedence is given to the 'TopToBottom' and 'BottomToTop' constants in that if the desktop alert window is aligned with both the top and left edges (or both the bottom and right edges) of the screen, it is made to slide in the vertical direction.
Note: Changing properties of the
The default value for the AnimationScrollDirectionAutoClose property is 'AutoSelect'. When set to this value, the "ideal" scroll direction, based on the current screen location of the desktop alert window, is automatically selected.
The following table cross references the screen location of the desktop alert window with the
| Screen location | AnimationScrollDirection constant |
|---|---|
| Top edge of desktop alert window is aligned with top edge of screen | BottomToTop |
| Bottom edge of desktop alert window is aligned with bottom edge of screen | TopToBottom |
| Left edge of desktop alert window is aligned with left edge of screen | RightToLeft |
| Right edge of desktop alert window is aligned with right edge of screen | LeftToRight |
| No edge of desktop alert window is aligned with any edge of the screen | TopToBottom (based on the default initial |
These values are used in the interest of making the desktop alert window to appear to "slide" off the screen. Precedence is given to the 'TopToBottom' and 'BottomToTop' constants in that if the desktop alert window is aligned with both the top and left edges (or both the bottom and right edges) of the screen, it is made to slide in the vertical direction.
Note: Changing properties of the
Note: Changing properties of the
Note: Changing properties of the
By default, the AutoClose property resolves to true for all settings of the
Note: Changing properties of the
Note: Changing properties of the
Note: Setting the AutoCloseDelay property to zero implies that the factory setting is used, which resolves to seven seconds for the 'Office2007' style, and ten seconds for the 'WindowsLiveMessenger' style. The valid range of explicit values is between one millisecond and the number of milliseconds in one hour.
Since the buttons do not display text, the ButtonImageSize property effectively determines the size of the buttons. The
Note: Changing properties of the
Note: Some of the properties of the
Note: Changing properties of the
Clicking the close button causes the
Note: Changing properties of the
By default, the dropdown button is not displayed. Clicking the dropdown button causes the
Note: Changing properties of the
The FixedSize property provides a way for the end developer to specify an explicit size for the desktop alert window. The default value for the property is Size.Empty. A value of zero for the width component implies that the actual width should be automatically calculated. For the 'Office2007' style, a width of 329 pixels is used, which is the width used by the Outlook 2007 New Mail Desktop Alert. For the 'WindowsLiveMessenger' style, the width is determined by measuring the width required to display the caption, caption area image, and close/dropdown buttons. A setting of zero for the height component signifies that the width is determined (by either auto-calculation or an explicit setting), and that width is then used when measuring the caption, text and footer text links to determine the height required to fully display all elements of the desktop alert window.
The minimum allowable size for a desktop alert window is restricted to (32W x 16H).
The actual size of the desktop alert window is returned by the
Note: Changing properties of the
Note: The image can be hidden by setting the ImageSize property to Size.Empty.
The ImageSize property resolves to (32W x 32H) for all settings of the
Note: Changing properties of the
Note: The MainImageAreaBorderColor property can be set to Color.Transparent to prevent borders from appearing around the
The UltraDesktopAlert component supports two display styles, 'Office2007' and 'WindowsLiveMessenger'. When the Style property is set to 'Office2007', the desktop alert windows emulate the look and feel of the Outlook 2007 New Mail Desktop Alert. When the Style property is set to 'WindowsLiveMessenger', the desktop alert windows emulate the look and feel of the Windows Live Messenger notification window.
Note: Changing properties of the
When the cursor is positioned over the desktop alert window, it is always displayed at full opacity; the Opacity property determines how transparent the desktop alert window is when the cursor is not positioned over it.
Also, if the
Note: Changing properties of the
Note: The Opacity property accepts values within the range of zero and one, with zero indicating that the factory setting should be applied. The default value resolves to a value of 0.8 (i.e., an opacity of 80%) for the 'Office2007' style and 1.0 (i.e., an opacity of 100%) for the 'WindowsLiveMessenger' style. A non-zero setting represents the ratio of opacity as compared to 1.0.
Note: The Appearance property determines the visual appearance of all desktop alert window instances displayed by this
The Application Styling equivalent of the Appearance property is realized through the DesktopAlertControlArea
Note: Changing properties of the
The Application Styling equivalent of the ButtonAppearance property is realized through the DesktopAlertButton
Note: Changing properties of the
The Application Styling equivalent of the ButtonHotTrackAppearance property is realized through the DesktopAlertButton
Note: Changing properties of the
The Application Styling equivalent of the ButtonPressedAppearance property is realized through the DesktopAlertButton
Note: Changing properties of the
Note: The image displayed in the
The Application Styling equivalent of the CaptionAreaAppearance property is realized through the DesktopAlertCaptionArea
Note: Changing properties of the
Note: The image can be hidden by setting the CaptionImageSize property to Size.Empty.
Note: Changing properties of the
The Application Styling equivalent of the GripAreaAppearance property is realized through the DesktopAlertGripArea
Note: Changing properties of the
The Application Styling equivalent of the CaptionAppearance property is realized through the DesktopAlertCaptionLink
Note: Changing properties of the
Note: When the SizeInPoints property of the CaptionHotTrackAppearance is set to a different value than that of the
The Application Styling equivalent of the CaptionHotTrackAppearance property is realized through the DesktopAlertCaptionLink
Note: Changing properties of the
The Application Styling equivalent of the TextAppearance property is realized through the DesktopAlertTextLink
Note: Changing properties of the
Note: When the SizeInPoints property of the TextHotTrackAppearance is set to a different value than that of the
The Application Styling equivalent of the TextHotTrackAppearance property is realized through the DesktopAlertTextLink
Note: Changing properties of the
The Application Styling equivalent of the FooterTextAppearance property is realized through the DesktopAlertFooterTextLink
Note: Changing properties of the
Note: When the SizeInPoints property of the FooterTextHotTrackAppearance is set to a different value than that of the
The Application Styling equivalent of the FooterTextHotTrackAppearance property is realized through the DesktopAlertFooterTextLink
Note: Changing properties of the
The caption portion of the desktop alert window is realized through the
Note: The TreatCaptionAsLink property resolves to true for the 'Office2007' setting of the
Note: While setting the TreatCaptionAsLink property to true will cause text that is not enclosed in an anchor tag to look and behave as a hyperlink, the converse is not true; setting the property to false does not prevent hyperlink behavior or appearance when the value of the
The footer text portion of the desktop alert window is realized through the
Note: The TreatFooterTextAsLink property resolves to true for all settings of the
Note: While setting the TreatFooterTextAsLink property to true will cause text that is not enclosed in an anchor tag to look and behave as a hyperlink, the converse is not true; setting the property to false does not prevent hyperlink behavior or appearance when the value of the
The text portion of the desktop alert window is realized through the
Note: The TreatTextAsLink property resolves to true for the 'Office2007' setting of the
Note: While setting the TreatTextAsLink property to true will cause text that is not enclosed in an anchor tag to look and behave as a hyperlink, the converse is not true; setting the property to false does not prevent hyperlink behavior or appearance when the value of the
Note: The DesktopAlertLinkClicked event will not fire when the
The
The Caption, Text, and FooterText properties of the
This property is only used at design-time.
The UltraDesktopAlertShowWindowInfo class exposes properties which represent the attributes
of a desktop alert window which are unique to that particular desktop alert. For example,
the
The desktop alert window extends the ability to display hyperlinks which, when clicked by the
end user, generate the
The following table cross references the key properties of the UltraDesktopAlertShowWindowInfo class, along with a brief description of the functionality they provide:
| Property | Description | See also |
|---|---|---|
|
Under the 'Office2007' Note: The value of the Caption property is realized in the user interface by the WinFormattedLinkLabel, and as such supports hyperlinks and formatted text. Also note, however, that editing of the link or formatted text is not supported. |
Formatted Text and Hyperlinks | |
|
Under the 'Office2007' Note: The value of the Text property is realized in the user interface by the WinFormattedLinkLabel, and as such supports hyperlinks and formatted text. Also note, however, that editing of the link or formatted text is not supported. |
Formatted Text and Hyperlinks | |
| The image appears in the client area of the desktop alert window, to the left of the |
|
|
| Support exists for playing a sound asynchronously as a desktop alert window is being shown. This relies on the native CLR2.0 support for processing WAV (Waveform Audio Format) data. UltraDesktopAlert can play WAV data via a file path or URL, |
|
|
|
|
By default, the desktop alert is displayed at the bottom right corner of the primary monitor. The UltraDesktopAlertShowWindowInfo class expose properties to enable the end developer to change this. |
|
|
The footer text appears in the bottom right corner of the client area of the desktop alert window; this is the case regardless of the value of the Note: The value of the FooterText property is realized in the user interface by the WinFormattedLinkLabel, and as such supports hyperlinks and formatted text. Also note, however, that editing of the link or formatted text is not supported. |
Formatted Text and Hyperlinks | |
| As a convenience to the end developer, support exists for passing an object to the desktop alert window which can be referenced at any point during the desktop alert's lifetime. This object is not used by the desktop alert window, but is exposed by the |
|
|
|
|
A desktop alert can be "pinned", i.e., the auto-close mechanism can be circumvented for a particular desktop alert. A button can also be displayed which enables the end user to pin the desktop alert, so that it does not close unless the end user clicks the close button. When this button is clicked by the end user, the value of the |
|
| Unless otherwise specified, all |
|
While usually not necessary for most applications, the
The value of the
The value of the
The DesktopAlert property will return null (Nothing in VB) under normal circumstances (i.e., this instance has not yet been passed to the
The Caption property is typically displayed in bold, to appear as a title for the desktop alert window.
The Caption property accepts formatted text as recognized by the
The Data property enables the end developer to pass an opaque piece of data to the
For example, the Data property might be used to store a reference to a WinSchedule Appointment object in a scenario where the UltraCalendarInfo's BeforeDisplayReminderDialog event is used to display a desktop alert window instead of the standard reminder dialog.
When the DesktopAlertLinkClicked event fires as the result of the end user clicking a link, the UltraCalendarInfo's DisplayAppointmentDialog method could then be given the proper context with which to edit the Appointment.
The FooterText property is displayed in the bottom right corner of the desktop alert window, and can be used to provide additional links.
The FooterText property accepts formatted text as recognized by the
The Image property provides a way for the end developer to specify a different image for each desktop alert window that is displayed. When the Image property is set to null (Nothing in VB), the value of the
By default, a border is drawn around the image when the
If a non-empty value is specified for the Key property, it must be unique among the keys of any desktop alert window instances currently open by the associated
When this property is set to true, the associated desktop alert window does not automatically close, i.e., the value of the
The Pinned property can be used to set the initial value of the
When this property is set to true, the associated desktop alert window displays a button with a pushpin (a.k.a., thumbtack) graphic to the immediate left of the close button to provide a way for the end user to change the value of the Pinned property.
The
The Screen property is not applicable when the
The ScreenLocation property is only applicable when the
When the ScreenPosition property is set to 'Manual', the
The Sound property only accepts values of type string,
If the Sound property contains a string which does not reference a valid sound file, the default system sound is played.
The sound is played asynchronously.
The Text property is displayed under the
The Text property accepts formatted text as recognized by the
The VisibleAlertButtons collection makes it possible to control which members of
the
Since an
Note: Since an UltraDesktopAlertShowWindowInfo instance has no association with an
The VisibleAlertButtons property returns an instance of type
An UltraDesktopAlertWindowInfo instance essentially represents a snapshot of the
An UltraDesktopAlertWindowInfo instance can also be used to programmatically close the associated desktop alert by calling
its
The UltraDesktopAlertWindowInfo instance associated with a desktop alert window is exposed by the
The DesktopAlert property will return null (Nothing in VB) under normal circumstances (i.e., this instance has not yet been passed to the
The Pinned property can be set to suspend or resume the timer which causes the desktop alert window to automatically close after the amount of time defined by the
The Bounds property can be used by listeners of the
The UltraDesktopAlertWindowUIElement contains the following child elements:
The border color(s) for the UltraDesktopAlertWindowUIElement are controlled by the
The name of the
Note: The AddToPreviousLocations property is only applicable when the
Note: Changing the value of the Path property has no effect when the event fires as the result of the
Note: Setting the Path property to a new value is only applicable when the
Note: The StayInEditMode property is not applicable when the event fires as the result of the
When the value returned from the
When the
If the value of the associated
When the
If the value of the associated
The LocationDropDownButtonUIElement contains one of the following child elements:
When the
The name of the AppStyling
The LocationDropDownButtonUIElement contains one or more of the following child elements:
When the
The name of the AppStyling
The LocationUIElement contains one of each of the following child elements:
The LocationUIElement is a container for the
When the
The
The
The Sort method of the
The Sort method of the
The Sort method of the
The
If the Sort method is optimized so that if it is called with the same SortOrder value as the last time the method was called, and the contents of the collection have not changed since that last call, no sorting takes place.
When an
Note: When the collection contains the maximum allowable number of items (as specified by the
Note: The contents of the collection can be persisted during runtime to a stream via the
Note: When the collection contains the maximum allowable number of items (as specified by the
The
The PreviousLocationsDropDownButtonUIElement contains one of the following child elements:
The name of the AppStyling
The SelectedLocationImageAreaUIElement contains one of the following child elements:
The size at which the image is displayed is determined by the
The name of the AppStyling
The UltraNavigationBar Windows Forms Control builds on the metaphor introduced with the Windows Vista Address Bar.
It provides the ability to navigate a hierarchical structure such as a file system or relational data.
Each node in the structure is referred to as a location, and is encapsulated by the
Since many nodes of larger hierarchical structures may never be accessed by the end user
during the lifetime of an application, the UltraNavigationBar control supports "on-demand"
population of the Locations collections via the
The UltraNavigationBar control provides extensive support for customizing the appearance of locations via the following properties:
The UltraNavigationBar control provides the ability to display buttons which appear in a separate area than the locations, which can execute some application-specific action when clicked by the end user, via the following members:
The UltraNavigationBar control provides "previous history" support via the following members:
The UltraNavigationBar control provides user interface customization support via the following properties:
When the
Note: By default, no MessageBox is displayed to the end user when the specified path could not be successfully parsed into a location. Use the
Note: Before attempting to enter edit mode, the control will first attempt to acquire the input focus; if it fails, the method will return false, and edit mode will not be entered.
This method must be called after
Note: Calling this method passing in false should only be done when it is known that the changes made between
the
The ActionButtonClicked event provides a way to perform some application-specific action when an
The EnteringEditMode event can be canceled to prevent the edit mode session from occurring.
If the event is not canceled, the
The ExitingEditMode event can be canceled to prevent the edit mode session from ending.
If the ExitingEditMode event is not canceled, the text typed by the end user during the edit mode session is parsed into a navigation path;
if this parsing operatrion is successful, the resulting location is assigned to the
The
Note: Unlike most Infragistics controls, the UltraNavigationBar's
Note: Unlike most Infragistics controls, the UltraNavigationBar's
When the end user clicks the
The LocationExpanding event also fires when an
The UltraNavigationBar's
Setting the SelectedLocation property to null is logically equivalent to setting it to reference the RootLocation.
When an edit mode session ends, or the
There is no mechanism extended through the public object model by which to to prevent the dropdown list from closing; for this reason, the control exposes no cancelable event which occurs prior to the dropdown closing, i.e., there is no LocationCollapsing event.
The LocationToolTipDisplaying event fires whenever the cursor hovers over the
Note: When the
The ActionButtonToolTipDisplaying event fires whenever the cursor hovers over the
The PreviousLocationsDropDownButtonToolTipDisplaying event fires whenever the cursor hovers over the
Action buttons appear on the right side of the control, next to the previous locations dropdown button.
They provide a simple mechanism for executing an application-specific task; the end developer handles the
The UltraNavigationBarActionButtonSettings instance returned from the ActionButtonSettings property can be used to customize the appearance of all action buttons displayed by the control; the instance returned from the
Note: Adding a member to the Appearances collection does not affect the visual appearance of the control; the Appearances collection is exposed as a convenience to the end developer, to provide a way to store
When the AutoSize property is set to true, the control's height cannot be modified.
The calculated height is based on the largest font size assigned for the
The value of the
The NonAutoSizeHeight is the value that the control uses to initialize the height when the
The ActiveLocation is the location on which most navigational key actions are based. For example, the 'ActivateNextLocation' keyboard action navigates to the next location as relative to the currently active one.
Note: Unlike most Infragistics controls, the UltraNavigationBar's ActiveLocation property changes when the cursor enters
and exits the user interface elements associated with an
The
By default, no focus rectangle is drawn for the user interface elements which depict the active state. This is primarily because
the Windows Vista Address Bar, after which the control is patterned, also does not display a focus rectangle. This behavior can be changed
by setting the
Note: A focus rectangle is never drawn for the control unless it actually has the input focus; setting the DrawsFocusRect property to true causes the focus rectangle to appear only when the control has focus.
Because the Windows Vista Address Bar, after which the UltraNavigationBar control is patterned, does not display a focus rectangle for the element with the keyboard focus, the DrawsFocusRect property resolves to false by default.
When the end user clicks the
A location can be expanded programmatically by either setting its
Note: The
Note: When the value of the PathSeparator property is changed, all locations belonging to this control instance are verified to ensure that their text does not include the new value for the PathSeparator. If any locations contain the new value, an exception is thrown.
The LocationSettings property can be used to apply settings for all the
When the same
When the end user types a navigation path and commits the result of an edit mode session,
the
A limit is imposed on the number of members that can exist in this collection via the
The contents of the collection can be persisted during runtime to a stream via the
Note: The number of items allowed in the
By default, the image associated with the
The RootLocation always appears in the navigation path; when no location has been selected by the end user,
the
Note: The dropdown button cannot be hidden for the root location, i.e., the
Note: The
The UltraNavigationBar's
Setting the SelectedLocation property to null is logically equivalent to setting it to reference the RootLocation.
Edit mode is entered when the end user clicks the area between the
Note: The
The
This property is only used at design-time.
Action buttons appear on the right side of the control, next to the previous locations dropdown button.
They provide a simple mechanism for executing an application-specific task; the end developer handles the
By default, the
The Settings property exposes an
The ToolTipText property provides a simple way to customize the tooltip that is displayed for the button.
For some applications, however, it may be necessary to change the text that is displayed dynamically, based
on the current state of the control. In these cases the end developer can handle the
By default, no tooltip is displayed for the action button; the
The Visible property makes it possible to hide the
When the
The
Note: This overload of the Reset method will not reinitialize the Locations collection, i.e., the
When the
Note: The DisplayText property cannot be set to a value that contains the
Note: The DisplayText is only displayed when the
In the case where the DisplayText property is not explicitly set, the value of the
The IncludeTextInFullPath property makes it possible to preclude this location's text when constructing the navigation path for a descendant location.
For example, if the navigation path represents a file path, it may be desirable to omit one or more high-level ancestors when constructing the path to an actual directory.
Assuming the
Explicitly setting the
The
The
The
The IsExpanded property returns true when the
The
"Selected" in the context of an
The
The UltraNavigationBar's
The navigation path displayed by the
The Locations collection contains all children of the parent location, regardless of their visibility, and in the order in which they were added to the collection.
The collection's
The
Note: The Parent property always returns null for the
Note: Since an
The
The properties which are exposed by the
When the Text property is not explicitly set, the value of the
Note: The Text property cannot be set to a value that contains the
Note: Setting the Text property to an empty string is functionally equivalent to setting the
If the text button is being displayed for a location, i.e., the
Note: If the ToolTipText property is not explicitly set, no tooltip is displayed for this location.
The
An
An
An UltraNavigationBarLocation which appears in the locations dropdown list is represented in the user interface by
a
The Level property describes how "deep" into the hierarchy an
"Selected" in the context of an
Since it is always present in the navigation path, the root location always returns true from the IsSelected property.
Note: The
Note: The root location does not and can not belong to any
An UltraNavigationBarLocationSettings instance is returned from the
Note: Setting the property on the instance returned from the
Note: The SelectedAppearance is only used by the
Note: Setting the property on the instance returned from the
Note: The LocationsDropDownListAppearance is applied to the list which contains the immediate children of the
Note: Setting the property on the instance returned from the
An
Note: Setting the property on the instance returned from the
When a location's dropdown button is clicked by the end user, it becomes the
The default value, -1, signifies that the property is not specifically set at this level of the property resolution hierarchy, and that the actual value will be determined at a higher level. A value of zero signifies that the number of items displayed will only be restricted by the size of the display.
Note: Setting the property on the instance returned from the
Clicking a location's text button is the equivalent of assigning the
The user interface representation of an
By default, a dropdown button is displayed for an
Note: The
An UltraNavigationBarPreviousLocationsSettings instance is returned from the
Note: The DropDownButtonVisible property can be set to false to provide additional horizontal space for the navigation path, but does not prevent the previous locations dropdown list from appearing when the F4 key is pressed.
To prevent the previous locations dropdown list from appearing altogether, handle the
The MaximumDropDownItems property does not restrict the number of items that exist in the
The MaximumItems property determines the maximum number of members that can exist in the control's
Note:
Note: The MaximumItems property can be set to zero to signify that no limit should be imposed. In the absence of an explicit setting, the collection allows 25 members to exist before any are removed.
Note: The DropDownButtonToolTipText property can be set to an empty string to prevent the tooltip from appearing.
The tooltip can be dynamically customized by handling the
The name of the AppStyling
When the entity being validated is an
Note: The 'BalloonTip' setting is only applicable in the case where a single entity
is being validated; in the case where the
Note: For "standalone editors", i.e., UltraWinEditors controls that closely resemble intrinsic .NET controls, the Validating event is used rather than the editor’s BeforeExitEditMode event, in the interest of remaining consistent with the intrinsic .NET controls.
If, for example, ValidationPropertyName is set to "Text", the Validator registers as a listener of the TextChanged event, and performs validation in reponse to the firing of that event.
Note: For "standalone editors", i.e., UltraWinEditors controls that closely resemble intrinsic .NET controls, the property value changed event is used rather than the editor’s ValueChanged event, in the interest of remaining consistent with the intrinsic .NET controls.
Note: This setting requires the use of classes in the System.Reflection namespace, and as such requires that the caller have the appropriate security permissions in order to function properly.
The Control and Editor properties are mutually exclusive in that when one returns a valid reference, the other must return null.
The Control and Editor properties are mutually exclusive in that when one returns a valid reference, the other must return null.
The IsValid property is settable, and as such, any listener in the notification chain can
set the property to a value that does not reflect the actual result of the validation.
If the IsValid property was false at the time the
When a validation session is triggered by user interaction, or programmatically by calling
the
Note: The NotificationSettings property is not applicable in the case where the
Note: In the case where the validation was triggered by one of the
The Control and Editor properties are mutually exclusive in that when one returns a valid reference, the other must return null.
Validation of multiple embeddable editors is not supported, so when the IsSingleEntityValidation property returns false, the Editor property always returns null.
The Editor and Control properties are mutually exclusive in that when one returns a valid reference, the other must return null.
The NotificationSettings class enacapsulates the notification functionality extended
by the
| Constant | Description |
|---|---|
| Image |
For standalone controls, this setting closely resembles the funtionality provided
by the Windows Forms ErrorProvider
component. Where the ErrorProvider only supports icons, however, UltraValidator supports
the display of any image. The image that is displayed
is defined by the
For |
| MessageBox |
This setting causes a MessageBox to be displayed
when a validation session fails. The value of the |
| BalloonTip | This setting causes a|
| SoundOnly | With all of the previously mentioned settings, a sound is played prior to the visual notification if the|
| None | As the name implies, no notification is issued by the UltraValidator. The
Notification settings can be specified in design mode on two different levels, the one that
takes precedence being the instance returned by the
The properties of the NotificationSettings class are only applicable to the case where a single
control or embeddable editor is being validated, i.e., when the validation is triggered by user
interaction, or by the
The Action property determines how the end user is notified of a failed validation, i.e., whether an image, balloon tip, MessageBox, or nothing is displayed.
The Caption property provides the title of the MessageBox or balloon tip that is displayed when validation fails.
The Image property defines which image is displayed when an error image is used as the notification action.
Note: The Sound property only accepts values of type string, SystemSound,
If the Sound property contains a string which does not reference a valid sound file, the default system sound is played.
Not all constants from the
If the specified sound is not available on the local machine, a Beep is played.
The sound is played asynchronously, i.e., the thread on which the notification is issued is not blocked while the sound is played.
When the notification action resolves to 'SoundOnly', and the Sound property has not been explicitly set, a Beep is played.
The Caption property provides the text displayed by the MessageBox or balloon tip that is displayed when validation fails.
A Validation instance corresponds to a validation operation which can involve either one
The IsValid property returns true when the
In the case where a validation operating involved more than one control,
the Results collection will contain more than one member. The number of
members in the Results collection is always equal to the number of controls
that were validated; by contrast, the
The Errors collection returns a subset of the contents of the
A validation session can be triggered by user interaction in two different ways - in response
to the control's Validating event,
or in response to a change in the value of the property referenced by
The UltraValidator component provides the ability to solve most common validation problems in a declarative manner. For typical validation scenarios such as ensuring that a number falls within a given range, or that a text field is non-empty, or conforms to the character pattern for a postal code, email address or telephone number, no code whatsoever needs to be written by the end developer. The designer support extended by the component is adequate for implementing these common solutions.
The UltraValidator component extends its functionality to all Windows Forms controls
via the IExtenderProvider interface, which is utilized
by Visual Studio to provide "extender properties". When an UltraValidator component is instantiated
in design mode, a
Validation criteria is specified using the properties of the object. A required field
condition can be enforced by setting the
The UltraValidator component provides several different kinds of notifications to alert an end
user of a failed validation. By default, an error image is displayed alongside the right edge
of the validated control, which displays a balloon tip when the cursor is hovered over the image.
Unlike the ErrorProvider component, which only
supports the display of an Icon, UltraValidator provides
the ability to display an image, with full support for
complete and partial transparency. Alternatively, a MessageBox
or balloon tip can be displayed, or
a sound can be played. An
A
While a ValidationSettings instance can be extended to any control, doing so will only have an effect if the control supports validation in the classic sense of the word. For example, extending a ValidationSettings instance to a Panel control is possible, but doing so will have no real effect since the Panel control does not support editing a value. The reason a ValidationSettings is extended more liberally than might be expected is that the alternative could prevent one from being extended to a control that a developer might have added validation support to in a derived class.
The ErrorAppearance property is only applicable to
The ErrorAppearance exposed by this
By default, the error image is displayed alongside the outer right edge of the control with which it is associated, centered vertically. The ErrorImageAlignment property, in conjunction with the ErrorImagePadding property, makes it possible to customize the placement of the error image.
Note: Changing the vertical alignment of the error image is only possible when the vertical component of the
The ErrorImageAlignment property is not applicable when the entity being validated is an
The ErrorImageBlinkRate property is not applicable when the entity being validated is an
Setting the ErrorImageBlinkRate property to zero is the functional equivalent of setting the
The error image does not blink while the cursor is positioned over it.
The ErrorImageBlinkStyle property is not applicable when the entity being validated is an
The ErrorImagePadding property can be used to increase the amount of space between the error image and the right or left edge of the control with which it is associated. By default, there is no padding between the error image and the control.
The ErrorImagePadding property is not applicable when the entity being validated is an
The ErrorImageSize property can be used to customize the size of the error image. By default, the error image is displayed at a size of (16 x 16).
The ErrorImageSize property is not applicable when the entity being validated is an
The ErrorImageSize property cannot be set to a value that contains a negative width or height; attempting to do so will cause an
The ErrorImageTransparentColor property is not applicable when the entity being validated is an
By default, the transparent color is determined automatically by the color of the lower-left pixel of the error image.
Note: The
| Constant(s) | Description |
|---|---|
| None | The message box contains no symbols. |
| Hand, Error, Stop | The message box contains a symbol consisting of a white X in a circle with a red background. |
| Question | The message box contains a symbol consisting of a question mark in a circle. |
| Exclamation, Warning | The message box contains a symbol consisting of an exclamation point in a triangle with a yellow background. |
| Asterisk, Information | The message box contains a symbol consisting of a lowercase letter i in a circle. |
Also note that the 'Question' setting is included only for backward compatibility, and its use is no longer recommended because it does not clearly represent a specific type of message.
The NotificationSettings property makes it possible to specify the manner in which the end user is notified of a failed validation.
A NotificationSettings property is also exposed by the
Note: The NotificationSettings property applies only to the validation of a single control or embeddable editor.
Also note that the 'BalloonTip' setting is only applicable when the entity being validated has focus, as is the case
when the
Validation of a control or
A
When the leaves a control/editor, or changes its value while it has focus, a validation session
can be initiated, depending on the value of the
In the case where a validation session could potentially involve more than one control (as is the case when the
When a validation session yields one or more failures, the ValidationError event is fired.
The
This property is only used at design-time.
The
The ValidationGroup class exposes only one significant property,
A non-empty,
The Validate method can be used to programmatically validate each member of the ValidationGroup.
Note that the value of the
Note: In the case where each member of a group is validated programmatically (by calling the
The
A ValidationResult instance corresponds to a single validation. In the case where multiple controls
are validated by calling one of the
A ValidationResult instance is returned from the indexer of the collection
returned by the
When a control or embeddable editor is validated, and validation succeeds, the Status property
returns 'Valid'. When the validation fails, a value is returned which describes the reason for
the failure. If the
In the case where a validation fails because the value could not be converted
to the type specified by the
The ValidationSettings class enacapsulates the validation functionality extended
by the
The
Various kinds of validation can be realized through the ValidationSettings object, the
simplest example being enforcement of a non-empty value for a control. This is accomplished
by setting the
Since validation criteria must often go beyond the simple case of merely enforcing non-emply values,
the
The properties which determine how the end user is notified of a failed validation are grouped under
the
The
Validation functionality can be easily extended to an Infragistics control that hosts
externally provided
An
The
Note: When using a
When the
Assign an instance of the
Assign an instance of the
Assign an instance of the
The Enabled property can be used to temporarily suppress validation for the associated control or editor.
Note that the Enabled property is not applicable to programmatic validations; when the
Whether an String.Empty should be considered the logical equivalent to null (Nothing in VB) is often specific to the application; the EmptyValueCriteria makes it possible to customize that aspect of the validation behavior.
The ErrorAppearance property is only applicable to
When IsRequired is set to true, and the value is null or empty as defined by EmptyValueCriteria, the entity fails validation, and the
The various different ways of notifying the end user of a failed validation is controlled by the properties of the
By some definitions of good UI design, "trapping" the end user in a field is not recommended. For this reason, the RetainFocusOnError property is false by default.
Note: In the absence of an explicit setting, the value to be validated is obtained from the Text property
for non-Infragistics controls. For Infragistics "standalone editors", i.e., controls which implement the
In the case where the entity being validated is an
In the case where the entity being validated is an Infragistics "standalone editor", i.e., a control that implements the
A ValidationGroup makes it possible to arrange controls into logical groups for the purpose of temporarily disabling validation for the members of that group, or to programmatically trigger validation of each member.
When the ValidationTrigger is set to 'OnValidating' validation is initiated by the control's
Validating event (or