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.
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.
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 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 three 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 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 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