The AccessibleObjectWrapper is a thread safe object for
providing accesible information. The
The default implementation does not make use of the type parameter. It will always return true except if this element has a
For example, if the search was for a CellUIElement in an UltraGrid control and this is a RowUIElement and its
However, if the
This method is normally overridden by classes that override the
Normally, rendering of the the element is done using the
various
Note: It is up to the caller to manage the lifetime of the
The method returns the following:
If either parameter is null it returns false.
If the context type is equal to the passed in type or if it is a subclass of the type the method returns true.
If the passed in type is an interface and if the object implements the interface then true is returned. Otherwise, false is returned.
The distance between elements is measured only in the direction of the search operation.
The element found must overlap this element when moving in the direction of the find operation.
The element found must also be completely past this element in the direction of the find operation.
If there are two elements found with the same distance to this element, the element whose edge is closest to the center line drawn thourgh this element in the direction of the find operation is chosen.
The distance between elements is measured only in the direction of the search operation.
The element found must overlap this element when moving in the direction of the find operation.
The element found is only allowed to overlap this element in the direction of the find operation by the amount specified by the evaluator.
If there are two elements found with the same distance to this element, the element whose edge is closest to the center line drawn thourgh this element in the direction of the find operation is chosen.
Note Derived elements that plan to return an accessible object must override
the
The property get will return "Default", "Center", "Left" or "Right".
The property set will set the
The reason for this parallel string property is to allow version independent serialization of the
The property get will return "Default", "Middle", "Top" or "Right".
The property set will set the
The reason for this parallel string property is to allow version independent serialization of the
The
The properties set on the Appearance itself (e.g.
Note: The
Since the
Since the
The StyleResourceName is used to indicate the name of the
resource whose style information should be included when the
The properties set on the Appearance itself (e.g.
Note: The
Since the
Since the
Defines a set of margins for use when drawing a stretched
The
The properties set on the Appearance itself (e.g.
Since the
Since the
The StyleResourceName is used to indicate the name of the
resource whose style information should be included when the
The properties set on the Appearance itself (e.g.
Since the
Since the
Defines a set of margins for use when drawing a stretched
The
The properties set on the Appearance itself (e.g.
Note: The
Since the
Since the
The StyleResourceName is used to indicate the name of the
resource whose style information should be included when the
The properties set on the Appearance itself (e.g.
Note: The
Since the
Since the
This object defines a set of margins for use when drawing a stretched
The format of the string is "(left), (top), (right), (bottom)".
The left margin extends from the left edge of the image rightwards. The value of left must be greater than or equal to 0.
If a left margin is specified (greater than 0), then when the image is stretched, the left part of the image before the margin will not be stretched horizontally.
The top margin extends from the top edge of the image downwards. The value of top must be greater than or equal to 0.
If a top margin is specified (greater than 0), then when the image is stretched, the to part of the image up to the margin will not be stretched vertically.
The right margin extends from the right edge of the image leftwards. The value of right must be greater than or equal to 0.
If a right margin is specified (greater than 0), then when the image is stretched, the right part of the image before the margin will not be stretched horizontally.
The bottom margin extends from the bottom edge of the image upwards. The value of bottom must be greater than or equal to 0.
If a bottom margin is specified (greater than 0), then when the image is stretched, the bottom part of the image up to the margin will not be stretched vertically.
Defines a set of margins for use when drawing a stretched
Colors added via this method will always appear after the control's default colors.
The Equals method of the color object is restrictive in that a Named color will not equal an unnamed color even if their ARGB values are the same. This method is less restrictive and will return that such colors are the same.
This event only fires when a color is selected by clicking on it. Unlike the
If the ColorSelectorMode is set to ColorSelectorMode.Single then this event will only fire for the left mouse button (ForeColor) or when a color is selected via the ColorChooser.
When set to null (Nothing in VB), a default set of colors is used to populate the palette.
Returns the ImagelistProvider for this collection.
This is used by the
Assuming the
After selecting an
By default, this property defaults to an empty string and as such will obtain
its style information from the default style library that is loaded into memory using the
StyleManager.Load() method. However, there is also an overload of that method
which will accept a string name which will be used to identify the library (
Note: If this property is set and the name does not match up with the name of a loaded style library, the control/component will not have any style information.
Note:The implementations of these methods should be thread safe.
Note: A parameterless constructor is required for all derived classes.
Note: The name must be unique amongst all controls.
Standalone editor controls like UltraTextEditor would return the specific editor
that they use - e.g. EditorWithText. Controls such as UltraGrid that can use any editor can return
the constant value
Note: The
A shared object is an object that may be used by one or more controls. This includes objects such as EmbeddableEditorBase derived classes.
Note: The name must be unique amongst all shared objects.
Note: The
Note: When the StyleSetLibrary is set to null it indicates that all libraries have changed.
In design mode notifies the
At runtime this method does nothing.
Use this method to get the
This method associates an
Use this method to determine if a StyleSettings object has been created and contains data that needs to be serialized.
This method resets the
Use this method to determine if the
Invoke this method to reset the
Once this method is invoked, the
Use this method to determine if the
Invoke this method to reset the
Once this method is invoked, the
This method will reset all properties of the
If this property is not set then the Application Styling framework will look at the
If that property is not set, the the Application Styling framework will use the default style library specified for the application.
If this property is not set then the Application Styling framework will look at the
If that property is not set, the the Application Styling framework will use the default style specified for the application
If this property is not set then the Application Styling framework will look at the
If that property is not set, the the Application Styling framework will use the default style specified for the application
This is used to convert a
It also allows expanding the properties of the object in the PropertyGrid.
The event is only invoked when the
The event is only invoked when the
The event is only invoked when the
The
Note: This method only has significance to the
Note: MRU(Most recently used) functionality is suspended when the owner returns 'Suggest' or 'SuggestAppend' from this method, since in those modes the dropdown can only contain the filtered items.
By default, an editor might display a custom cursor, appropriate to the type of editor it is; for example, the
If the editor's owner does not want the editor to display its default cursor, it must return false from this method.
The default implementation returns true.
The default implementation returns true.
Note: This method is only applicable when the owner returns true from the
Also, when the owner returns true from the
GetEditorContext and
Implementing owner will return the object that was last cached using SetEditorContext method.
Implementing owner will return the object that was last cached using SetEditorContext method.
When the owner returns true from the ShowHotkeyPrefix method, and there exists an ampersand character in the string representation of its value, the character following the ampersand is displayed as a hotkey. When the owner returns false from the ShowHotkeyPrefix method, ampersands are treated as standard characters.
The default implementation returns false.
The default implementation returns ShowInkButton.Default.
Do NOT call the Dispose method on the graphics object returned from this method.
Instead, each call to this method should be paired with a call to
During graphics caching calls to
Do NOT call the Dispose method on the graphics object returned from
During graphics caching calls to
Note: This method is currently only used by the
Checkboxes are only displayed by the standard dropdown used by the
This method is equivalent to saving the style library information into a stream and then calling
This method is equivalent to saving the style library information into a stream and then calling
Note: The Tag property is not saved with the style information.
Note: The Tag property is not saved with the style information.
Note: This property is only supported for components that indicate they utilize ButtonStyle when they are registered.
Note: This property is only supported for components that indicate they utilize headers when they are registered.
Note: This property is only supported for components that indicate they utilize ViewStyle when they are registered.
Note: This property is only supported for components that indicate they utilize CheckBoxGlyphInfo when they are registered.
Note: This property is only supported for components that indicate they utilize RadioButtonGlyphInfo when they are registered.
Note: The collection contains references to the same objects that are in the
A
A
Note: If the specified style name does not
exist or if
Note: You must use the returned StyleManager from the thread on which you retreived it.
Note: If the specified style name does not
exist or if
Note: You must use the returned StyleManager from the thread on which you retreived it.
Note: You must use the returned StyleManager from the thread on which you retreived it.
When set to Default, which is the default value,
the value from the
When set to Color.Default, which is the default value,
the value from the
If the
A default button is usually rendered with an additional
Overrides OnCreateControl and OnHandleCreated to ensure that an owner drawn listbox is set to redraw its contents when resized and provides. It also provides basic functionality for rendering an insertion mark while dragging over the listbox and also for automatically initiating a drag when pressing down on selected items.
The owner and ownerContext values are saved by the added element to get value and state information later.
The owner and ownerContext values are saved by the added element to get value and state information later.
The owner and ownerContext values are saved by the added element to get value and state information later.
The default implementation ignores the height parameter, and calls the overload that doesn't take height
The default implementation returns false.
Note: If the editor is in edit mode for the specified owner and ownerContext, the value of the editor's
If the editor doesn't take focus when it is in edit mode then it may want to listens in to keystrokes while the owner retains focus.
The default implemenation returns the opposite of the CanFocus property.
If the editor makes use of value list returned by EmbeddableEditorOwnerBase, it returns true.
The default implemenation returns false.
If the editor supports automatically sizing itself to accommodate the data it contains, it returns true
The default implementation returns false.
The first time that the UIElement property is invoked after calling this method, the element will be cached until
the
Note This method must be invoked once for each time that the
The owner and ownerContext values are saved by the added element to get value and state information later.
Note: Some embeddable elements must render borders in order to support WindowsXP themes. Consequently, when the DrawOuterBorders property is false, certain elements may not fully support themes.
Note: This is not based upon the
Note: This value is only maintained if the
Returns true if the text is fully displayed in the text element. Note that this method relies on TrackCharactersRendered and TrackTextArea properties being true, which they are by default.
The EmbeddableEditorButtonBase is the base class for an
editor that displays a custom collection of buttons to the left and right of an
edit area. The buttons are exposed via the
The owner and ownerContext values are saved by the added element to get value and state information later.
Typically, format strings are not applied to the value when the editor is in edit mode. Returning true from this property will cause the editor to apply the format string when it is in edit mode.
The owner and ownerContext values are saved by the added element to get value and state information later.
In the case where an empty string is specified in the 'text' parameter, Color.Empty is returned.
In the case where an empty string is specified in the 'text' parameter, Color.Empty is returned.
When set to true (default), and the edit portion is cleared, the new value is assumed to be Color.Empty.
When set to false and the edit portion is cleared, the value of the
Note: In the case where the
The ControlContainerEditor is used to embed a control within a control that supports embeddable editors, such as the WinGrid or WinTree.
Use this method to determine if a ApplyOwnerAppearanceToEditingControl object has been created and contains data that needs to be serialized.
Use this method to determine if a EditingControl object has been created and contains data that needs to be serialized.
Use this method to determine if a EditingControlPropertyName object has been created and contains data that needs to be serialized.
Use this method to determine if a ApplyOwnerAppearanceToRenderingControl object has been created and contains data that needs to be serialized.
Use this method to determine if a RenderingControl object has been created and contains data that needs to be serialized.
Use this method to determine if a RenderingControlPropertyName object has been created and contains data that needs to be serialized.
Use this method to determine if a EnterEditModeMouseBehavior object has been created and contains data that needs to be serialized.
For Internal use only.
During mouse capture all mouse messages will be routed to the element.
In other words, the elements
This method is called by the framework when a MouseDown is received by the associated control. The default implementation returns true if the left mouse button is pressed.
The default implementation returns true unconditionally. This method can be overridden for the purpose of receiving a notification immediately before a tooltip is about to be displayed.
Note: The
The is a static property that returns the control element that has capture.
If this is not null, the
Note: This property only affects how a control element is rendered when its
Note: If the control is disposed or the handle has not yet been created, the coordinates returned will be invalid.
This method must be called after
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
In design mode notifies the
At runtime this method does nothing.
The specified sound file is played asynchronously, meaning that the main thread is not blocked while the sound file is being played.
The specified system sound event is played asynchronously, meaning that the main thread is not blocked while the sound file is being played.
Note: The clone is mapped to the original template through the Name
property, so if this value is changed, this method will not be able to function. In cases where
the Name property is changed for clones, it is recommended to call the
Indicates whether the control can utilize an
Indicates whether the control can utilize an
Note that not all user interface entities may use the specified text rendering mode. For example, if the user interface entity happens to make use some .NET control that doesn't support the specified text rendering mode.
Also note that when printing GDIPlus will be used, even if this property is set otherwise. This is because .NET printing infrastructure does not support drawing text using GDI.
By default, this property defaults to an empty string and as such will obtain
its style information from the default style library that is loaded into memory using the
Note: If this property is set and the name does not match up with the name of a loaded style library, the control/component will not have any style information.
Note: This property does not affect the control when the
Note: This property does not affect the control when the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
This event is generated after a cell enters edit mode, meaning that the cell is prepared to accept input from the user.
The buttons in the column can visually emulate the display styles seen in Office2000, OfficeXP, or Office2003 by setting the DisplayStyle property appropriately, regardless of the operating system on which the control is running.
Note that the cells do not draw borders, so this propertly will only affect buttons and other UIElements contained within the cell.
A DataGridViewColumnSortMode that specifies the criteria used to order the rows based on the cell values in a column.
If the Value assigned to this property conflicts with the
GetEditorContext and
Implementing owner will return the object that was last cached using SetEditorContext method.
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
The Appearances collection is used to contain Appearance objects that you have created and added to the control as pre-defined formatting templates. It does not represent a collection of all the Appearance objects that exist in the control. The intrinsic Appearance objects that are stored by objects such as the UltraGridBand, UltraGridRow, UltraGridCell are not included in the grid's Appearances collection.
This property is used to determine how mask literals and prompt characters are displayed when the control is not in edit mode. Based on the setting of this property, the text displayed in the control will contain no prompt characters or literals (just the raw data), the data and just the literals, the data and just the prompt characters, or all the text including both prompt characters and literals. The formatted spacing of partially masked values can be preserved by indicating to include literals with padding, which includes data and literal characters, but replaces prompt characters with spaces.
Generally, prompt characters disappear when the control is no longer in edit mode, as a visual cue to the user. In some cases, however, it may be appropriate in your application to display mask literals as well as data when the control is no longer in edit mode.
The property is used to specify how data input will be masked for the control. The mask usually includes literal characters that are used to delimit the data entered by the user. This property has no effect unless the property is set, meaning that data masking is enabled.
This property is used to determine how mask literals and prompt characters are handled when the text of the control is copied to the Windows clipboard. Based on the setting of this property, the text in the clipboard will contain no prompt characters or literals (just the raw data), the data and just the literals, the data and just the prompt characters, or all the text including both prompt characters and literals. The formatted spacing of partially masked values can be preserved by indicating to include literals with padding, which includes data and literal characters, but replaces prompt characters with spaces.
The property is used to specify how data input will be masked for the control. The mask usually includes literal characters that are used to delimit the data entered by the user. This property has no effect unless the InputMask property is set, meaning that data masking is enabled.
Note:Because the column requires a prompt character to indicate unpopulated mask positions, the PromptChar property cannot be set to the null character ('\x00'). If the property is set to the null character, the value will be changed to the space character ('\x32') instead.
The ValidateCheckState event can be used to force the cell's CheckState property to a certain value when the control is clicked, overriding the next value in the cycle.
When set to true (default), and the edit portion is cleared, the new value is assumed to be Color.Empty.
When set to false and the edit portion is cleared, the value of the
Note: In the case where the
The BeforeDropDown event can be canceled; when this happens, the dropdown list is not displayed, and the
Invoke this method to reset the
The BeforeDropDown event can be canceled; when this happens, the dropdown list is not displayed, and the
The column provides the ability to situate the dropdown button on either the right (default) or left side of the cell.
The column provides the ability to control whether the dropdown button is displayed.
When set to Always (default), the dropdown button is always displayed, as is the case with an intrinsic ComboBox control.
When set to Never, the dropdown button is never displayed. Note that this does not affect whether the list portion of the control can be displayed.
When set to OnMouseEnter, the dropdown button is displayed when the cursor passes into the boundaries of the cell, and hidden when it passes outside.
When this property is set to a value that is less than the current number of items in the MRUList, all items whose index is >= MaxMRUItems are removed; i.e., this property supercedes the addition of members to the collection.
MRU is an acronym for 'Most Recently Used'. The column's MRU list contains the text of the items that were most recently selected by the end user.
When the property is set to true, as items are selected, a copy of the item is added to the top of the MRU portion of the list. The other items contained in the MRU list, if any, are moved down. This process continues until the number of items in the MRU portion exceeds the value specified by the property. When this happens, the 'oldest' item is removed from the list.
Note: While the MRUList can be set, items that do not match the text of an item in the columns's collection have no relevance and are discarded.
The column provides the ability to sort the items in its dropdown list. The value of the SortStyle property dictates the order in which items will appear.
This property returns a reference to a ValueList object that can be used to set properties of, and invoke methods on, the valuelist that is associated with a column. You can use this reference to access any of the returned valuelist's properties or methods.
This property is also used to assign a particular valuelist object to a column. Once assigned, the valuelist enables a column to use the dropdown list styles and intelligent data entry, specified by the Style and AutoEdit properties, respectively, of the column for which this property is set.
If true will act as a combo with a style of DropDownList.
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
The pad character is the character that is used to replace the prompt characters when getting the data from the Masked Edit control with DataMode.
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
When the control's dropdown button is clicked, a calendar is displayed. Its selected date is preset to the date in the edit portion, or, if no valid date is set, the current date. When the control's dropdown calendar closes up, the edit portion is set to display the date that was selected in the calendar portion. The DropDownCalendarAlignment property determines which side of the control the dropdown calendar will be aligned with.
The BeforeDropDown event can be canceled; when this happens, the dropdown list is not displayed, and the
This property returns a reference to a ValueList object that can be used to set properties of, and invoke methods on, the valuelist that is associated with a column. You can use this reference to access any of the returned valuelist's properties or methods.
This property is also used to assign a particular valuelist object to a column. Once assigned, the valuelist enables a column to use the dropdown list styles and intelligent data entry, specified by the Style and AutoEdit properties, respectively, of the column for which this property is set.
By default, each font name in the dropdown list is displayed in the font that it represents. The ShowFontNamesInFont property provides the ability to disable this feature.
The cells in this column will automatically detect images if the column contains System.Drawing.Bitmap or Byte[] data and display it in the cell.
The column will support either integer or double-precision decimal numeric entry.
The OptionSet will display items based on the ValueList property of the column.
This property returns a reference to a ValueList object that can be used to set properties of, and invoke methods on, the valuelist that is associated with a column. You can use this reference to access any of the returned valuelist's properties or methods.
This property is also used to assign a particular valuelist object to a column. Once assigned, the valuelist enables a column to use the dropdown list styles and intelligent data entry, specified by the Style and AutoEdit properties, respectively, of the column for which this property is set.
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
The FillAppearance property is used to determine appearance of the filled area of the ProgressBar.
The
The Minimum and
The ProgressBar can be oriented vertically or horizontally. When rendering horizontally, the fill increases from left to right as the percent increases. When oriented vertically, the fill increases from bottom to top as the percent increases. The default value for the Orientation is horizontal.
The Style property determines the type of fill that is rendered. The fill may be a continuous block or be rendered in segments.
This property controls the display of multiple lines of text in edit cells in the band or the grid controlled by the specified override. When True, text will wrap in the area of the cell. If the RowSizing property is set to automatically resize the row, the row will expand in height until all lines of text are displayed (or the number of lines specified by the RowSizingAutoMaxLines property is reached).
The CellMultiLine property does not pertain to multi-line editing, only display. Also, you should note that setting a cell to multi-line mode will disable data masking. Only single-line cells can be masked (using the MaskInput and MaskDisplayMode properties.)
When the column's Multiline property is true, the PasswordChar property is not applicable.
When the property is false, the Scrollbars property is not applicable.
Note:The control's scrollbars are only displayed when the control is in edit mode.
The default implementation returns true.
Note: This method is only applicable when the owner returns true from the
Also, when the owner returns true from the WrapText method, horizontal scrollbars are not displayed, regardless of the value returned from this method.
This property returns a reference to a ValueList object that can be used to set properties of, and invoke methods on, the valuelist that is associated with a column. You can use this reference to access any of the returned valuelist's properties or methods.
This property cannot be set on the TimeZoneEditorColumn.
The owner and ownerContext values are saved by the added element to get value and state information later.
When you invoke this method, the control tries to delete the currently selected text and shift characters. If nothing is selected, it tries to delete the character at the current input position.
This method returns True if the operation was successful. If the operation fails because characters after the selection could not be shifted, the method returns False.
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
Event that is fired when user performs an action that can not be executed because the state of the control (caret position, selection and other properties) does not allow it. For example, when the user presses left arrow key when caret is already at the first display character in the MaskedEdit, the left arrow key action (which is to move the caret to previous display character) can not be performed. In this case such an action is cosidered an invalid operation and this event is fired.
If true the spin button will wrap the value incremented/decremented based on its Min/Max value.
When this property is set to True, characters typed will be inserted at the current text caret position and any following characters will be moved. When set to false, typing at an insertion point that contains an existing character will replace that character. The value of this flag also affects how characters are deleted using either The Delete key or the Backspace key. When in insert mode, characters after the character being deleted will be shifted by one to the left within the section.
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.
| KeyCode | ActionCode | StateRequired | StateDisallowed | SpecialKeysRequired | SpecialKeysDisallowed |
|---|---|---|---|---|---|
| Right | NextCharacter | Character | None | None | Ctrl |
| Right | NextSection | Character | LastSection | Ctrl | None |
| Right | AfterLastCharacter | LastSection | None | Ctrl | None |
| Right | SetPivot | None | UnInitialized | None | Shift |
| Left | PrevCharacter | None | FirstCharacter | None | Ctrl |
| Left | PrevSection | None | FirstSection | Ctrl | None |
| Left | FirstCharacter | FirstSection | FirstCharacter | Ctrl | None |
| Left | SetPivot | None | UnInitialized | None | Shift |
| Home | FirstCharacter | None | FirstCharacter | None | None |
| Home | SetPivot | None | UnInitialized | None | Shift |
| End | AfterLastCharacter | None | AfterLastCharacter | None | None |
| End | SetPivot | None | UnInitialized | None | Shift |
| Tab | NextSection | Character | LastSection | None | Shift |
| Tab | SetPivot | Character | LastSection | None | Shift |
| Tab | SelectSection | Character | LastSection | None | Shift |
| Tab | NextControl | LastSection | None | None | Shift |
| Tab | NextControl | AfterLastCharacter | None | None | Shift |
| Tab | NextControl | UnInitialized | Character, AfterLastCharacter | None | |
| Tab | PrevSection | None | FirstSection | Shift | None |
| Tab | SetPivot | None | FirstSection | Shift | None |
| Tab | SelectSection | None | FirstSection | Shift | None |
| Tab | PrevControl | FirstSection | None | Shift | None |
| Tab | PrevControl | UnInitialized | Character, AfterLastCharacter | Shift | |
| Delete | Delete | Selected | None | None | None |
| Delete | Delete | Character | Selected | None | Shift |
| Delete | Backspace | None | None | Shift | Ctrl |
| Delete | AfterLastCharacter | Character | Selected | Ctrl | Shift |
| Delete | Delete | Character | Selected | Ctrl | Shift |
| Back | Backspace | Selected | None | None | None |
| Back | Backspace | None | FirstCharacter, Selected | None | None |
| C | Copy | Selected | None | Ctrl | None |
| X | Cut | Selected | None | Ctrl | None |
| V | Paste | None | None | Ctrl | None |
| Insert | ToggleInsertionMode | None | None | None | None |
| Up | UpKeyAction | None | UnInitialized | None | None |
| Down | DownKeyAction | None | UnInitialized | None | None |
When this property is set to SelectEnteredCharacters, the select-all-text operation will select text starting from the first entered character to the last entered character, including adjacent literals.
The owner and ownerContext values are saved by the added element to get value and state information later.
Controls that are docked and implement the
Register calls need to be matched with unregister calls.
Each call to
The parent control is monitored until the 'register' count goes to 0 or the control is disposed.
The higher the priority the farther outside the docking area is placed.
Any control that implements IDockingArea and returns a PriorityLevel > 0 will be placed outside of all docked controls that don't implement IDockingArea.
Note: Controls that implement
Note: This interface is used by the
The
Note: The values Min and Max are not supported for the 'direction' parameter.
Each call to this method must be eventually paired with a call to
During graphics caching calls to
Each call to this method must be paired with a prior call to
During graphics caching calls to
Do NOT call the Dispose method on the graphics object returned from this method.
Instead, each call to this method should be paired with a call to
During graphics caching calls to
Do NOT call the Dispose method on the graphics object returned from
During graphics caching calls to
There is a limitation in the
The IconToBitmap method will only function correctly on a computer which has the right to execute unmanaged code; this is determined by using the
The IconToBitmap method catches any exceptions that are thrown during the process of accessing the Icon's pixel data; when an exception is thrown, the
The
The limitation in the
Returns an object for the current thread that can be used to synchronize calls to this thread.
Version 2.0 of the .NET framework contains support for GDI text measurement and rendering, which is employed for Infragistics controls by default. This flag can be set to true to force the use of GDI+ for text measurement and rendering.
In 7.3, performance enahancements were made to the PLF's drawing logic so when the invalid area of the paint operation is not the full size of the control, the internal drawing buffer created for painting is only the size of the invalid area. Previously, the buffer's size was increased so its top-left corner matched the top-left corner of the control. This made paint operations like this slower, but did have the benefit of having all Graphics objects in all drawing situations backed by buffers with the same origin.
With the invalid rect performance optimizations enabled, any code changing the Transform or RenderingOrigin of a Graphics object must first determine the current Transform or RenderingOrigin and offset them instead of replacing them. Likewise, if unmanaged drawing methods are being used and an hDC created from the Graphics object is passed into these unmanaged methods with a location or rect to draw to, the locations and rects must be transformed with the TransformPoints method of the Transform on the Graphics object.
Note: If it is not possible or too time consuming to make the changes necessary for the drawing logic to be correct as described above, this property should be set to True.
Note: This will only be in relation to other objects that add their message filter via the
This is called for example when a combo is closed up on a popup menu.
If the user had clicked on the combo list's scroll bar we wanted to postpone the menu close up until after the combo closes up. This is accomplished by calling
This is used for example when a combo is dropped down on a popup menu.
If the user clicks on the combo list's scroll bar we want to postpone the menu close up until after the combo closes up. This is accomplished by calling
Adding a listener here will cause a message hook to be added.
Only one hook is created no matter how many event listeners there are. The hook is removed when there are no more listeners.
Clicking on this form with the mouse will not automatically activate it.
It returns MA_NOACTIVATE for the WM_MOUSEACTIVATE message.
The DefaultEditorOwner class may be used to provide default values to an editor. Each editor class takes a "default owner" to one of its constructors. When the editor requests a property value of its owner, the owner may or may not provide the value for that property. When the owner does not provide the value for the editor, the value used is returned from the default owner, if there is one.
The DefaultEditorOwner overrides several of the members of the base
The DefaultEditorOwnerSettings is essentially a property bag of
settings for a
The EditorButtonBase is the base class for an editor button. An editor button
provides a way to display a generic button within a text or mask editor. Many of
the editor classes already provide their own buttons that relate specifically to
their value and are controlled by the editor itself. The editor buttons allow you to
add additional buttons and affect the editor as required. For example, you can use an
As well as providing several basic properties (e.g.
Implements that provide events should derive their event arguments from
Note The editor buttons do not automatically affect the value of the
editor in any way. The
Note Implementors must override 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
Use this property to determine if an
The AccessibleName property is used by accessibility clients to identify the object to the user.
The EditorButton is an editor button designed to
display image and/or text. The button acts as a standard button invoking its
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 property to determine if an
The AutoRepeatEditorButton is similar to the
The StateEditorButton is used to display a
checkbox, state button or option set within a text or mask editor. The type
of display used is based on the
The class provides 4 events. The
The DropDownEditorButtonBase is a base editor button class
for displaying a dropdown window. It exposes common events relating to dropping
down a separate window including the
The DropDownEditorButton represents an editor button that is
capable of displaying a
The
Note Attempting to set the Control property while the associated dropdown window is displayed will result in an exception.
The SpinEditorButton class is an editor button used
to provide spin button style functionality. Two or more buttons are displayed
depending on the
When the spin button is clicked, the
The EditorButtonControlBase is the base control class for editor controls
that provide editor button functionality. The editor buttons are accessible via the
The control exposes events corresponding to the current events exposed from the various
Note The events exposed by this control (
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
Invoke the
You can use the
You can use the
The Appearances collection is used to contain Appearance objects that you have created and added to the control as pre-defined formatting templates. It does not represent a collection of all the Appearance objects that exist in the control. The intrinsic Appearance objects that are stored by objects such as the UltraGridBand, UltraGridRow, UltraGridCell are not included in the grid's Appearances collection.
The default implementation returns ShowInkButton.Default.
When set to true, the default value, the button will fire the initial click when the button is pressed down and fires at the specified interval thereafter until the mouse is release. When false, the auto repeat logic is bypassed and the button will act as a standard button element.
This constructor is used to provide the owner and owner context so
that the
Since the
This constructor is used to provide the owner and owner context so
that the
Since the
This constructor is used to provide the owner and owner context so
that the
This constructor is used to provide the owner and owner context so
that the
This constructor is used to provide the owner and owner context so
that the
This constructor is used to provide the owner and owner context so
that the
The EditorWithCombo class uses the existing
The owner and ownerContext values are saved by the added element to get value and state information later.
If the editor makes use of value list returned by EmbeddableEditorOwnerBase, it returns true.
The default implemenation returns false.
Note: The HasMRUList property is not applicable when the
MRUItems must correspond to an item in the editor's
When the MRUList property is set, the contents of the array is checked to verify that each items correspond
Note: The MRUList property is not applicable when the
When this property is set to a value that is less than the current number of items in the MRUList, all items whose index is >= MaxMRUItems are removed; i.e., this property supercedes the addition of members to the collection
Note: The MaxMRUItems property is not applicable when the
The ScrollBarLook property provides a way for the end developer to customize the look of the vertical scrollbar which appears in the dropdown list when the number of items exceeds the value of the
This property will affect all Infragistics WinForms controls that draw glyphs (checkboxes or radio buttons).
The setting may be overriden on indivual controls. For example, the UltraCheckEditor control and UltraOptionSet control have a GlyphStyle property. The setting on the indivudual control will override this global setting.
Note: Setting this property will not force a repaint of controls. Therefore it is recommended that this property be set when the applicaiton starts, before the controls have pained, such as in the Load event of the main application form.
This property will affect all Infragistics WinForms controls that draw checkboxes.
The setting may be overriden on individual controls. For example, the UltraCheckEditor control has a GlyphInfo property. The setting on the indivudual control will override this global setting.
Note: Setting this property will not force a repaint of controls. Therefore it is recommended that this property be set when the applicaiton starts, before the controls have pained, such as in the Load event of the main application form.
This property will affect all Infragistics WinForms controls that draw RadioButtones.
The setting may be overriden on individual controls. For example, the UltraOptionSet control has a GlyphInfo property. The setting on the indivudual control will override this global setting.
Note: Setting this property will not force a repaint of controls. Therefore it is recommended that this property be set when the applicaiton starts, before the controls have pained, such as in the Load event of the main application form.
The combinedGlyphImage is a single image which contains all of the possisble states that the glyph a may draw. The images must all be the same size (13x13) and are arranged in a grid.
There must be 5 columns in the grid.
Column 0 is the CheckBox in it's disabled state.
Column 1 is the CheckBox in it's normal state.
Column 2 is the CheckBox in it's MouseOver state.
Column 3 is the CheckBox in it's MouseDown state.
Column 4 is the CheckBox in it's MouseOver and MouseDown state.
The number of rows varies based on the
This method will save the combined image of all possible states into a Bitmap file.
The combinedGlyphImage is a single image which contains all of the possisble states that a CheckBox Glyph may draw. The images must all be the same size (glyphSize) and are arranged in a grid.
There must be three rows in the grid.
Row 0 is the CheckBox in it's unchecked state.
Row 1 is the CheckBox in it's checked state.
Row 2 is the CheckBox in it's indeterminate state.
There must be 5 columns in the grid.
Column 0 is the CheckBox in it's disabled state.
Column 1 is the CheckBox in it's normal state.
Column 2 is the CheckBox in it's MouseOver state.
Column 3 is the CheckBox in it's MouseDown state.
Column 4 is the CheckBox in it's MouseOver and MouseDown state.
The combinedGlyphImage is a single image which contains all of the possisble states that a RadioButton Glyph may draw. The images must all be the same size (glyphSize) and are arranged in a grid.
There must be two rows in the grid.
Row 0 is the Radiobutton in it's unchecked (unselected) state.
Row 1 is the Radiobutton in it's checked (selected) state.
There must be 5 columns in the grid.
Column 0 is the Radiobutton in it's disabled state.
Column 1 is the Radiobutton in it's normal state.
Column 2 is the Radiobutton in it's MouseOver state.
Column 3 is the Radiobutton in it's MouseDown state.
Column 4 is the Radiobutton in it's MouseOver and MouseDown state.
By default,
This property is only applicable when the
The owner and ownerContext values are saved by the added element to get value and state information later.
The owner and ownerContext values are saved by the added element to get value and state information later.
With the 'Append' setting, characters are appended to the text typed in the edit portion so as to match the string representation of the "most likely" candidate in the list. For example, consider a list containing the strings "Apple", "Application", and "Apprehend". If the end user types an "A" into the edit portion when it is empty, the character string "pple" is appended to the "A" to produce "Apple", because that is the first entry in the list which matches the typed character string. The appended characters are selected. If the appended characters are overwritten to produce the character string "Appli", the character string "cation" is appended to produce "Application", since the presence of the character "i" now precludes "Apple" as a match.
When set to 'Suggest', the contents of the list displayed to the end user is modified so as to only contain entries whose display text begins with the text in the edit portion of the control. For example, consider a list containing the strings "Apple", "Application", and "Apprehend". If the end user types an "A" into the edit portion when it is empty, all three list items appear in the dropdown list, since they all begin with the letter "A". If the end user continues typing to produce "Appl", the "Apprehend" item no longer appears in the dropdown list, since it is no longer a match candidate.
The default value is true.
The default value is true.
The property get will return "True", "False" or "Default".
The property set will set the
The reason for this parallel string property is to allow version independent serialization of the
The property get will return "True", "False" or "Default".
The property set will set the
The reason for this parallel string property is to allow version independent serialization of the
The property get will return "True", "False" or "Default".
The property set will set the
The reason for this parallel string property is to allow version independent serialization of the
The property get will return "True", "False" or "Default".
The property set will set the
The reason for this parallel string property is to allow version independent serialization of the
Note that because each item is drawn using the font that it represents, the ValueListItem's Appearance in not honored.
Also note that only the following Appearance properties are honored at the ValueList level:
Note that because each item is drawn using the font that it represents, the ValueListItem's Appearance in not honored.
Also note that only the following Appearance properties are honored at the ValueList level:
Encodes the specified image into a string that can be embedded. The returned value can be assigned to the 'data' attribute of the 'img' tag to embedd the image directly inside the formatted text value. Note that you can also display an image from a file or URL by using the 'src' attribute of the 'img' tag without having to embedd it inside the formatted text value.
If the specified value has syntax error or if there is an error inserting the value, including when the control is read-only, this method will throw an exception.
Note: If some contents are selected, they will be deselected and the value will be inserted at the caret position.
Note that modifying the returned StyleInfo will not have any effect on the value being edited.
To modify the style, use the
Applies the specified style to the current selection. If nothing is currently selected, then style will be stored for applying to any further input at this current location. If the caret is moved, the stored state style will be discarded.
Makes the current selection into a link. The specified value is the anchor tag that
specifies link. The value must simply be the anchor tag. Example:
ultraTextEditor.EditInfo.MakeSelectionIntoLink( "<a href=\"url\"></a>" );
Note that you must include reference to Infragistics.Win.SupportDialogs assembly in order for this option to work. SupportDialogs assembly has the actual dialogs that this menu option displays.
Note that you must include reference to Infragistics.Win.SupportDialogs assembly in order for this option to work. SupportDialogs assembly has the actual dialogs that this menu option displays.
Note that you must include reference to Infragistics.Win.SupportDialogs assembly in order for this option to work. SupportDialogs assembly has the actual dialogs that this menu option displays.
AddToVisitedLinks property specifies whether the link should be added to the visited links collection. When a link is considered to be visited, it will be drawn using the visited link appearance. You would typically set this property to false if for example you cancel the opening of the link operation.
OpenLink property is useful if you want to prevent the control from opening the link so you can open the link yourself, using some custom code.
Since the
FormattedLinkEditor is an embeddable editor that lets you display and edit formatted text. Supported formatting attributes include bold, italic, underline, font, font size, text color, background color, line alignment of left, right, center and justified. It also supports displaying one or more links that the user can click to perform certain actions, typically open the associated URL. You can also embedd one or more images along with the text. Images can be embedded inline along with the text or they can be floated left or right where the text will wrap around the image. Images themselves can be links. Please consult the help topics for WinFormattedLinkLabel for more information and a listing of supported tags.
The syntax for accomplishing formatting as well as embedding images, hyper-links, horizontal lines
is in XML. Examples include:
Click here to go to <a href="http://www.infragistics.com">Infragistics</a> website.
This an inline image <img src="image.bmp"/>.
<img src="image.bmp" align="left" />This is a floating image. Text will wrap around it.
The owner and ownerContext values are saved by the added element to get value and state information later.
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
Encodes the specified image into a string that can be embedded. The returned value can be assigned to the 'data' attribute of the 'img' tag to embedd the image directly inside the formatted text value. Note that you can also display an image from a file or URL by using the 'src' attribute of the 'img' tag without having to embedd it inside the formatted text value.
This event is fired when the value specified to the formatted link editor has parsing errors.
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....
You can use 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.
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.
| KeyCode | ActionCode | StateRequired | StateDisallowed | SpecialKeysRequired | SpecialKeysDisallowed |
|---|---|---|---|---|---|
| Right | NextCharacter | Character | None | None | Ctrl |
| Right | NextSection | Character | LastSection | Ctrl | None |
| Right | AfterLastCharacter | LastSection | None | Ctrl | None |
| Right | SetPivot | None | UnInitialized | None | Shift |
| Left | PrevCharacter | None | FirstCharacter | None | Ctrl |
| Left | PrevSection | None | FirstSection | Ctrl | None |
| Left | FirstCharacter | FirstSection | FirstCharacter | Ctrl | None |
| Left | SetPivot | None | UnInitialized | None | Shift |
| Home | FirstCharacter | None | FirstCharacter | None | None |
| Home | SetPivot | None | UnInitialized | None | Shift |
| End | AfterLastCharacter | None | AfterLastCharacter | None | None |
| End | SetPivot | None | UnInitialized | None | Shift |
| Tab | NextSection | Character | LastSection | None | Shift |
| Tab | SetPivot | Character | LastSection | None | Shift |
| Tab | SelectSection | Character | LastSection | None | Shift |
| Tab | NextControl | LastSection | None | None | Shift |
| Tab | NextControl | AfterLastCharacter | None | None | Shift |
| Tab | NextControl | UnInitialized | Character, AfterLastCharacter | None | |
| Tab | PrevSection | None | FirstSection | Shift | None |
| Tab | SetPivot | None | FirstSection | Shift | None |
| Tab | SelectSection | None | FirstSection | Shift | None |
| Tab | PrevControl | FirstSection | None | Shift | None |
| Tab | PrevControl | UnInitialized | Character, AfterLastCharacter | Shift | |
| Delete | Delete | Selected | None | None | None |
| Delete | Delete | Character | Selected | None | Shift |
| Delete | Backspace | None | None | Shift | Ctrl |
| Delete | AfterLastCharacter | Character | Selected | Ctrl | Shift |
| Delete | Delete | Character | Selected | Ctrl | Shift |
| Back | Backspace | Selected | None | None | None |
| Back | Backspace | None | FirstCharacter, Selected | None | None |
| C | Copy | Selected | None | Ctrl | None |
| X | Cut | Selected | None | Ctrl | None |
| V | Paste | None | None | Ctrl | None |
| Insert | ToggleInsertionMode | None | None | None | None |
| Up | UpKeyAction | None | UnInitialized | None | None |
| Down | DownKeyAction | None | UnInitialized | None | None |
By default the editor doesn't display the scrollbars even if there is more content then the available space. Set this property to display the scrollbars.
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 application-wide by setting the FormattedLinkEditor's
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 BaseURLDefault property to control how relative URL's are resolved. Note that
this property is static and can be used to set the base URL for all instances of formatted text editors
in an application. To set the base URL for a specific instance of FormattedLinkEditor, use it's
If this property is set to true, the key action mappings logic will skip the actions after this action in the associated key action mappings collection if this action matches the state.
By default all the actions matching the
The LoadFromBinary method is used in conjunction with the
The LoadFromBinary method is used in conjunction with the
The LoadFromXml method is used in conjunction with the
The LoadFromXml method is used in conjunction with the
The SaveAsBinary method is used in conjunction with the
The SaveAsBinary method is used in conjunction with the
The SaveAsBinary method is used in conjunction with the
The SaveAsBinary method is used in conjunction with the
When the
The ConditionOperator property determines the logical operator that is used to make comparisons.
The names of the constants are implied to mean that the CompareValue property is the target of the comparison.
For example, if the ConditionOperator property is set to 'GreaterThan', the
This method must be overridden by the Root reference object to deal with external or root references. The Root referece object must advance past the optional control name in a Fully Qualified Reference before calling RefLoop
The MinimumValue is inclusive, i.e., a value that is equal to the MinimumValue is within range.
The MaximumValue is inclusive, i.e., a value that is equal to the MaximumValue is within range.
Note: A reference to the value of the
Note: A reference to the value of the
If the specified
Designer support is provided for creating a
Passed a boolean value called 'disposing' to determine if the resources should be cleaned up.
The SourceControl is analogous of the SourceControl property of a context menu. It is used to identify which control is displaying the popup window. The IPopupItem should return this value from its SourceControl property.
Note that in order for the Appearance.Image or ToolTipAppearance.Image setting to apply, this property must be set to Custom or Default.
By default, a tooltip is not displayed for an item when the owning form is inactive. The ShowWhenOwningFormInactive can be set to true to override this behavior.
Layout manager keeps track of the order in which items are added. Some layout managers may layout items in the order in which they were added.
Fill indicates whether to resize the item to fill the extra space if the layout item's display area is larger than its size.
OriginX and OriginY define where the layout item will be placed in the virtual grid of the grid-bag layout. OriginX specifies the location horizontally while specifies the location vertically. These locations are the coordinates of the cells in the virtual grid that the grid-bag layout represents.
The leftmost cell has OriginX of 0. The constant
The default value is
OriginX and OriginY define where the layout item will be placed in the virtual grid of the grid-bag layout. OriginX specifies the location horizontally while specifies the location vertically. These locations are the coordinates of the cells in the virtual grid that the grid-bag layout represents.
The topmost cell has OriginY of 0. The constant
The default value is
Specifies the number of cells this item will span horizontally. The constant
Specifies the number of cells this item will span vertically. The constant
Fill indicates whether to resize the item to fill the extra space if the layout item's display area is larger than its size,
OriginX and OriginY define where the layout item will be placed in the virtual grid of the grid-bag layout. OriginX specifies the location horizontally while specifies the location vertically. These locations are the coordinates of the cells in the virtual grid that the grid-bag layout represents.
The leftmost cell has OriginX of 0. The constant Relative specifies that the item be placed just to the right of the item that was added to the layout manager just before this item was added.
The default value is Relative. OriginX should be a non-negative value.
OriginX and OriginY define where the layout item will be placed in the virtual grid of the grid-bag layout. OriginX specifies the location horizontally while specifies the location vertically. These locations are the coordinates of the cells in the virtual grid that the grid-bag layout represents.
The topmost cell has OriginY of 0. The constant Relative specifies that the item be placed just below the item that was added to the layout manager just before this item was added.
The default value is Relative. OriginY should be a non-negative value.
Specifies the number of cells this item will span horizontally. The constant Remainder specifies that this item be the last one in the row and thus occupy remaining space.
Specifies the number of cells this item will span vertically. The constant Remainder specifies that this item be the last one in the column and thus occupy remaining space.
Gridbag layout manager caches layout information which needs to be invalidated any time a change is made that would effect how the items are laid out.
When IncludeMethod is set to Always, the display character will always be included except when it is empty, in which case normal processing takes effect. (The mask is examined to determine whether a prompt character ot a pad character should be used.) If this property is set to Never, it will never be included in the text. The default setting (DisplayCharIncludeMethod.Default) is to look at the MaskMode that's being applied to the text and determine which character to use accordingly.
By default, this property is set to Color.Empty or Color.Transparent which indicates that no color should be blended with
the colors of the current
By default, this property is set to Color.Empty or Color.Transparent which indicates that no color should be blended with
the colors of the current
The owner and ownerContext values are saved by the added element to get value and state information later.
If the editor makes use of value list returned by EmbeddableEditorOwnerBase, it returns true.
The default implemenation returns false.
This is usually only set true if the Handled property of the
The class that derives from or utilizes the
Returns a Boolean value that determines whether the
The TextLeft is used to provide a custom header or footer text on the left side of the page.
Note: If the
The TextCenter is used to provide custom centered header or footer text.
The TextRight is used to provide a custom header or footer text on the right side of the page.
Note: If the
Note, when left to its default value of -1, the height will be based on the height required to show the section text and border.
The UltraPrintDocument is a specialized
Property settings may be saved using the
Property settings of the base PrintDocument class, including the
Returns a Boolean value that determines whether the
In design mode notifies the
At runtime this method does nothing.
Raising an event invokes the event handler through a delegate.
The OnPagePrinting 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 OnPagePrinting in a derived class, be sure to call the base class's OnPagePrinting method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPagePrinted 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 OnPagePrinted in a derived class, be sure to call the base class's OnPagePrinted method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPageBodyPrinting 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 OnPageBodyPrinting in a derived class, be sure to call the base class's OnPageBodyPrinting method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPageBodyPrinted 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 OnPageBodyPrinted in a derived class, be sure to call the base class's OnPageBodyPrinted method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPageHeaderPrinting 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 OnPageHeaderPrinting in a derived class, be sure to call the base class's OnPageHeaderPrinting method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPageHeaderPrinted 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 OnPageHeaderPrinted in a derived class, be sure to call the base class's OnPageHeaderPrinted method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPageFooterPrinting 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 OnPageFooterPrinting in a derived class, be sure to call the base class's OnPageFooterPrinting method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPageFooterPrinted 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 OnPageFooterPrinted in a derived class, be sure to call the base class's OnPageFooterPrinted method so that registered delegates receive the event.
The LoadFromBinary method is used in conjunction with the
The LoadFromBinary method is used in conjunction with the
The LoadFromXml method is used in conjunction with the
The LoadFromXml method is used in conjunction with the
The SaveAsBinary method is used in conjunction with the
The SaveAsBinary method is used in conjunction with the
The SaveAsXml method is used in conjunction with the
The SaveAsXml method is used in conjunction with the
The UltraPrintDocument overrides this member to invoke the various print events (e.g.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Note, this does not automatically affect the output of the print operation.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
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
The Appearance property is used to determine appearance of the non-filled area of the ProgressBar.
Use this property to determine if an
The FillAppearance property is used to determine appearance of the filled area of the ProgressBar.
Use this property to determine if an
The ProgressBarControlUIElement is the main
The ProgressBarControlUIElement contains only one child element - a
The Minimum and
The
The Style property determines the type of fill that is rendered. The fill may be a continuous block or be rendered in segments.
The label may include special characters to insert the different values.
e.g.
The format used to display the [Formatted] and [RemainingFormatted] can be specified using the
The label may include special characters to insert the different values.
e.g.
The format used to display the [Formatted] and [RemainingFormatted] can be specified using the
The label may include special characters to insert the different values.
e.g.
The format used to display the [Formatted] and [RemainingFormatted] can be specified using the
The ProgressBarFillUIElement has only one child element - a
Depending upon the
The percentage of the area filled is based on the
The main source of information for resolving the
Since the child
The ProgressBarFillUIElement contains only one child element - a
The region is used to clip the filled area to the percentage of the parent's
The ProgressBarUIElement can have two child elements - a
The info parameter specifies the class that implements the
The ProgressBarUIElement can only contain two elements - a
The percent is calculated using the
The
This class is a UITypeEditor for the
This class is a UITypeEditor for the
Note: MouseMove and MouseUp message processing calls this method only if this method returned true on the MouseDown and thereby captured the mouse.
Note: MouseMove and MouseUp message processing calls this method only if this method returned true on the MouseDown and thereby captured the mouse.
Note: MouseMove and MouseUp message processing calls this method only if this method returned true on the MouseDown and thereby captured the mouse.
When set to a color other than Color.Transparent (the default), all occurrences of the color in the image will be made transparent.
If a tab image is supplied by setting an Appearance.Image property to an Imagelist index, the ImageList's TransparentColor property is looked at first. If the property is set to Color.TransparentColor, then the components ImageTransparentColor is used. If it is set to Color.TransparentColor, then no color masking is done.
If a tab 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.
This value is ignored unless
A value of zero will result in a default size being applied.
If the tab item is already in view this method does nothing.
Otherwise the tab is scrolled into view but is not selected.
Note: This method is only used by certain layout styles.
Clicking the close button element should hide/close the
By default, the buttons are aligned adjacent to the client area. e.g. If the TabOrientation is set to TopLeft, the scroll and close buttons are aligned at the bottom edge of the tabs.
Note:
Currently this is only used for the Office2007Ribbon tab styleNote:
Currently this is only used for the Office2007Ribbon tab styleUse 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
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
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Note: This property is only used when the
The MaxTabWidth determines the maximum width for a single tab item. When set to 0, the default value, the tab has no maximum size.
Note: If a vertical flow direction is specified, the value of the rotation angle must be 0 degrees. Rotating vertical flow text is not supported.
The default implementation calls DoDefaultAction which will normally bring up the code window.
However, this method can be overridden to prevent this behavior. For example, button type elements would want a double click to generate 2 clicks instead of bringing up the code window.
Note: If the point is over a button or scrollbar element the default implementation does nothing.
If the
Note: If the caller is uncertain as to the value of the specified time's Kind property, use the overload of this method which allows the DateTimeKind to be expressed independently of the value of the specified time's Kind property.
Note: Starting in the spring of 2007, daylight saving time (DST) start and end dates have changed for several time zones, including all time zones in the United States. As a result of this change, the IsDaylightSavingTime method now relies more heavily on the Windows Registry than it did previously in order to function. If the time zone entries in the registry of the local computer are not up to date, the IsDaylightSavingTime method might return invalid values.
Note: If no daylight saving information is available in the registry, this property returns false.
UtcOffset specifies the number of hours and minutes the current time differs from Coordinated Universal Time (UTC). This value should be added to the current time in order to obtain (GMT) Greenwich mean time.
Note that since the display name of a TimeZone is relative to GMT, the UtcOffset will appear with the opposite sign. For example, "(GMT-05:00) Eastern Time (US and Canada)" indicates that the Eastern Time zone is 5 hours prior to GMT. So the UtcOffset of Eastern Time is +5:00.
This value is added to the value of the
This value is added to the value of the
Note: If no information is available in the registry, this property returns the minimum value for the DateTime data type. When this is the case, the value returned from this property should be considered undefined.
The registry supports two date formats. Absolute format specifies an exact
date and time when standard time begins. In this form, the year, month,
day, hour, minute, second, and milliseconds parameters are used to specify
an exact date.
"Day-in-month format" is specified by setting the year member to zero,
setting the dayOfWeek member to an appropriate weekday, and using a
day value in the range 1 through 5 to select the occurrence of that
day of the week in the month. Using this notation, the first Sunday
in April can be specified, as can the last Thursday in October
(5 is equal to the last).
When the information contained in the registry is in "day-in-month" format,
that information is used to calculate the date of transition for the current year.
Note: Starting in the spring of 2007, daylight saving time (DST) start and end dates have changed for several time zones, including all time zones in the United States.
The DaylightDate property reflects the date and time of transisition to daylight time for the current year only; changing the system time to a different year than the actual one might cause the DaylightDate property to return an incorrect value.
To determine whether a specific date falls within daylight saving time, use the
Note: If no information is available in the registry, this property returns the minimum value for the DateTime data type. When this is the case, the value returned from this property should be considered undefined.
The registry supports two date formats. Absolute format specifies an exact
date and time when daylight time begins. In this form, the year, month,
day, hour, minute, second, and milliseconds parameters are used to specify
an exact date.
"Day-in-month format" is specified by setting the year member to zero,
setting the dayOfWeek member to an appropriate weekday, and using a
day value in the range 1 through 5 to select the occurrence of that
day of the week in the month. Using this notation, the first Sunday
in April can be specified, as can the last Thursday in October
(5 is equal to the last).
When the information contained in the registry is in "day-in-month" format,
that information is used to calculate the date of transition for the current year.
Time zone information is obtained from the Windows Registry. If the caller does not have permission to read the registry of the local machine, or if the registry contains incomplete or incorrect time zone information, the CurrentTimeZone can return null (Nothing in VB).
Note The shadow is displayed by default when available. The shadow is only available on operating systems that support shadows and when unmanaged code rights have been assigned to the assembly.
Note The shadow is displayed by default when available. The shadow is only available on operating systems that support shadows and when unmanaged code rights have been assigned to the assembly.
Note The drop shadow is only displayed on systems that support a drop shadow (e.g. Windows XP) and when unmanaged code rights are assigned to the assembly.
The tooltip may not display immediately when the Show method is called because of the InitialDelay. This even fires when the tooltip is actuall displayed, after the delay has elapsed.
By default, the tooltip will attempt to obtain a
By default, this property defaults to an empty string and as such will obtain
its style information from the default style library that is loaded into memory using the
Note: If this property is set and the name does not match up with the name of a loaded style library, the control/component will not have any style information.
This method must be called after
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
Note that not all user interface entities may use the specified text rendering mode. For example, if the user interface entity happens to make use some .NET control that doesn't support the specified text rendering mode.
Also note that when printing GDIPlus will be used, even if this property is set otherwise. This is because .NET printing infrastructure does not support drawing text using GDI.
The default implementation calls DoDefaultAction which will normally bring up the code window.
However, this method can be overridden to prevent this behavior. For example, button type elements would want a double click to generate 2 clicks instead of bringing up the code window.
Note: If the point is over a button or scrollbar element the default implementation does nothing.
The UltraProgressBar can be used to indicate the percent that a process has completed and also provides an indication during a long process that the process is progressing.
The type of flood fill that is rendered can be determined via the
The UltraProgressBar can also displayed a label (
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
The IncrementStep is analogous to adding a particular amount to the
The FormatText method provides a way to determine the text that is or would be displayed based on the label and data from the class implementing the
The UltraProgressBar control implements the
The main source for the resolved values of the filled appearance is the
The main source for the resolved values of the unfilled appearance is the
The main source for the resolved values of the filled appearance is the
The main source for the resolved values of the unfilled appearance is the
Raising an event invokes the event handler through a delegate.
The OnValueChanged 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 OnValueChanged in a derived class, be sure to call the base class's OnValueChanged method so that registered delegates receive the event.
When the control is not rendering themes, the default value is Inset. When themes are supported, the default BorderStyle is none.
The UltraProgressBar can be oriented vertically or horizontally. When rendering horizontally, the fill increases from left to right as the percent increases. When oriented vertically, the fill increases from bottom to top as the percent increases. The default value for the Orientation is horizontal.
The Minimum and
The
The Value must be a value within the
The Appearance property is used to determine appearance of the non-filled area of the ProgressBar.
Use this property to determine if an
The FillAppearance property is used to determine appearance of the filled area of the ProgressBar.
Note:
Use this property to determine if an
This string is used to format the percent when replacing a [Formatted] or [FormattedRemaining] value in the
The Text is used to provide a
The Style property determines the type of fill that is rendered. The fill may be a continuous block or be rendered in segments.
The UltraProgressBar control does not receive focus so changing this property will not affect the control.
Since the UltraProgressBar control does not receive focus and does not use the key messages, the default ImeMode is disabled.
Do NOT call the Dispose method on the graphics object returned from this method.
Instead, each call to this method should be paired with a call to
During graphics caching calls to
Do NOT call the Dispose method on the graphics object returned from
During graphics caching calls to
By default, an editor might display a custom cursor, appropriate to the type of editor it is; for example, the
If the editor's owner does not want the editor to display its default cursor, it must return false from this method.
The default implementation returns true.
The UltraScrollBar control provides all the functionality of the intrinsic ScrollBar plus several other features. In addition to the benefits of the Presentation Layer Framework (including the ability to owner draw an aspect of the control, one property
The UltraScrollBar also provides some additional properties and methods to make the control easier to use. The
To make setup of the control easier, the
This constructor was designed to be used when the control was a child control of an
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
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
Since the actual maximum value that can be achieved by using the interface may be less than the
Raising an event invokes the event handler through a delegate.
The OnScroll 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 OnScroll in a derived class, be sure to call the base class's OnScroll method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnValueChanged 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 OnValueChanged in a derived class, be sure to call the base class's OnValueChanged method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnMouseEnterElement 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 OnMouseEnterElement in a derived class, be sure to call the base class's OnMouseEnterElement method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnMouseLeaveElement 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 OnMouseLeaveElement in a derived class, be sure to call the base class's OnMouseLeaveElement method so that registered delegates receive the event.
The ScrollBarInfo object is used to maintain the state information for the ScrollBar. The control delegates many of its properties to the ScrollBarInfo.
If the Minimum is set to a value greater than the
If the new Maximum is less than the
When set, the new Value must be within the
The value returned is the minimum of the
The value returned is the minimum of the LargeChange and the current range. The current range is determined by subtracting the
The intrinsic ScrollBar displays a scroll thumb that encompasses the entire scroll track when the scroll thumb cannot be moved. When AutoDisable is set to true, the ScrollBar will appear disabled when the thumb cannot be scrolled. This occurs when the
When the
The default
The ScrollContextMenu is only used if the
This property is read-only
The following table lists the default key mappings for the
| KeyCode | ActionCode | StateRequired | StateDisallowed | SpecialKeysRequired | SpecialKeysDisallowed |
|---|---|---|---|---|---|
| Left | SmallDecrement | ThumbDrag | Alt | ||
| Right | SmallIncrement | ThumbDrag | Alt | ||
| Up | SmallDecrement | ThumbDrag | Alt | ||
| Down | SmallIncrement | ThumbDrag | Alt | ||
| Prior | LargeDecrement | ThumbDrag | Alt | ||
| Next | LargeIncrement | ThumbDrag | Alt | ||
| Home | First | ThumbDrag | Alt | ||
| End | Last | ThumbDrag | Alt |
The Infragistics ScrollBar was designed to duplicate the functionality and behavior of the intrinsic ScrollBar but utilize the Presentation Layer Framework. In the intrinsic ScrollBar, the large change value is taken into consideration when determining the maximum value that you can drag the scroll thumb, use the scroll arrows or click in the scroll track. Specifically, the maximum value is a result of Maximum minus the LargeChange plus 1. The MaximumDragValue property has been exposed to make it easier to determine this value.
The MinMaxButtonUIElement contain no child elements and are contained within a
The ScrollArrowUIElement contain no child elements and are contained within a
Since the actual maximum value that can be achieved by using the interface may be less than the
Raising an event invokes the event handler through a delegate.
The OnScroll 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 OnScroll in a derived class, be sure to call the base class's OnScroll method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnValueChanged 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 OnValueChanged in a derived class, be sure to call the base class's OnValueChanged method so that registered delegates receive the event.
If the Minimum is set to a value greater than the
If the new Maximum is less than the
When set, the new Value must be within the
The value returned is the minimum of the
The value returned is the minimum of the LargeChange and the current range. The current range is determined by subtracting the
When the
The
The Infragistics ScrollBar was designed to duplicate the functionality and behavior of the intrinsic ScrollBar but utilize the Presentation Layer Framework. In the intrinsic ScrollBar, the large change value is taken into consideration when determining the maximum value that you can drag the scroll thumb, use the scroll arrows or click in the scroll track. Specifically, the maximum value is a result of Maximum minus the LargeChange plus 1. The MaximumDragValue property has been exposed to make it easier to determine this value.
The intrinsic ScrollBar displays a scroll thumb that encompasses the entire scroll track when the scroll thumb cannot be moved. When AutoDisable is set to true, the ScrollBar will appear disabled when the thumb cannot be scrolled. This occurs when the
By default, the Focus method of the containing control is invoked when the scroll buttons are pressed. This property can be used to prevent that behavior if necessary.
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
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
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
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
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
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
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
The ScrollBarUIElement can contain 0,2 or 4
Note: this will return false if the element, the associated ScrollBarInfo, or any of its ancestors are disabled.
The ScrollTrackUIElement is contained in a
The UltraScrollBarControlUIElement only contains a
Note: The Tag property is not saved with the settings information.
Note: The Tag property is not saved with the settings information.
Note: The default value of -1 will cause the frequency to be resolved to the LargeChange property for major tickmarks or the SmallChange property for minor tickmarks.
Note: Setting this property to a value that is not the midpoint of the range of the TrackBar will cause there to be a different number of values on either half of the track; this will take effect even if the midpoint tickmark is not visible.
The owner and ownerContext values are saved by the added element to get value and state information later.
The KeyActionMappings property provides access to the control's mechanism for handling keyboard input from users. All keystrokes for actions such as selection, navigation and editing are stored in a table-based system that you can examine and modify using this property. Through the KeyActionsMappings property, you can customize the keyboard layout of the control to match your own standards for application interactivity.
For example, if you wanted users to be able to change the value by pressing the F8 key, you could add this behavior. You can specify the key code and any special modifier keys associated with an action, as well as determine whether a key mapping applies in a given context.
| KeyCode | ActionCode | StateRequired | StateDisallowed | SpecialKeysRequired | SpecialKeysDisallowed |
|---|---|---|---|---|---|
| Left | Last | Horizontal, NullValue | Alt | ||
| Up | Last | Horizontal, NullValue | Alt | ||
| Right | First | Horizontal, NullValue | Alt | ||
| Down | First | Horizontal, NullValue | Alt | ||
| Next | First | Horizontal, NullValue | Alt | ||
| PageUp | Last | Horizontal, NullValue | Alt | ||
| Home | First | Horizontal, NullValue | Alt | ||
| End | Last | Horizontal, NullValue | Alt | ||
| Left | First | Vertical, NullValue | Alt | ||
| Up | First | Vertical, NullValue | Alt | ||
| Right | Last | Vertical, NullValue | Alt | ||
| Down | Last | Vertical, NullValue | Alt | ||
| Next | Last | Vertical, NullValue | Alt | ||
| PageUp | First | Vertical, NullValue | Alt | ||
| Home | Last | Vertical, NullValue | Alt | ||
| End | First | Vertical, NullValue | Alt | ||
| Left | SmallDecrement | Horizontal | NullValue | Alt | |
| Up | SmallDecrement | Horizontal | NullValue | Alt | |
| Right | SmallIncrement | Horizontal | NullValue | Alt | |
| Down | SmallIncrement | Horizontal | NullValue | Alt | |
| Next | LargeIncrement | Horizontal | NullValue | Alt | |
| PageUp | LargeDecrement | Horizontal | NullValue | Alt | |
| Home | First | Horizontal | NullValue | Alt | |
| End | Last | Horizontal | NullValue | Alt | |
| Left | SmallIncrement | Vertical | NullValue | Alt | |
| Up | SmallIncrement | Vertical | NullValue | Alt | |
| Right | SmallDecrement | Vertical | NullValue | Alt | |
| Down | SmallDecrement | Vertical | NullValue | Alt | |
| Next | LargeDecrement | Vertical | NullValue | Alt | |
| PageUp | LargeIncrement | Vertical | NullValue | Alt | |
| Home | Last | Vertical | NullValue | Alt | |
| End | First | Vertical | NullValue | Alt |
Note: This property only affects thumb movement triggered by mouse clicks
when the
Note: This property only affects thumb movement triggered by mouse clicks
when the
Note: This property is useful when the thumb image being used should not be centered over the associated tickmark; an example would be a right triangle whose flat edge should be aligned along the tickmark.
The size of the thumb is automatically calculated based on the largest image that
is assigned to either
Note: This property is not honored in the Office2007 or Vista ViewStyles.
The UltraToolTip has several advantages over the standard inbox tooltip. It has properties to control it's appearance like BackColor and ForeColor. It can even display using Gradient or Hatch style or use an ImageBackGround. It can also display in BalloonTip style and display Title information as well as an Image.
The UltraToolTipManager has several advantages over the standard inbox tooltip. It has properties to control it's appearance like BackColor and ForeColor. It can even display using Gradient or Hatch style or use an ImageBackGround. It can also display in BalloonTip style and display Title information as well as an Image.
The UltraToolTipManager has several advantages over the standard inbox tooltip. It has properties to control it's appearance like BackColor and ForeColor. It can even display using Gradient or Hatch style or use an ImageBackGround. It can also display in BalloonTip style and display Title information as well as an Image.
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 a AutoPopDelay object has been created and contains data that needs to be serialized.
Use this method to determine if a DisplayStyle object has been created and contains data that needs to be serialized.
Use this method to determine if a Enabled object has been created and contains data that needs to be serialized.
Use this method to determine if an ToolTipTitleAppearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if a ToolTipImage object has been created and contains data that needs to be serialized.
Use this method to determine if a ToolTipTitle object has been created and contains data that needs to be serialized.
Use this method to determine if a InitialDelay object has been created and contains data that needs to be serialized.
If a ToolTipInfo already exists for the control, it is returned. If not, a new ToolTipInfo is created.
If a ToolTipInfo already exists for the control, it is removed and replaced by the new one.
Use this method to determine if a TipInfo object has been created and contains data that needs to be serialized.
If there is no ToolTipInfo for the specified control, an
Note: An UltraToolTip will automatically hide when the AutoPopDelay expires, when a mouse button is clicked, or when the
If there is no ToolTipInfo for the specified control, an
Note: An UltraToolTip will automatically hide when the AutoPopDelay expires, when a mouse button is clicked, or when the
If there is no ToolTipInfo for the specified control, an
Note: An UltraToolTip will automatically hide when the AutoPopDelay expires, when a mouse button is clicked, or when the
If there is no ToolTipInfo for the specified control, an
Note: An UltraToolTip will automatically hide when the AutoPopDelay expires, when a mouse button is clicked, or when the
If there is no ToolTipInfo for the specified control, an
Note: An UltraToolTip will automatically hide when the AutoPopDelay expires, when a mouse button is clicked, or when the
If there is no ToolTipInfo for the specified control, an
Note: An UltraToolTip will automatically hide when the AutoPopDelay expires, when a mouse button is clicked, or when the
Use this method to determine if a ToolTipTextStyle object has been created and contains data that needs to be serialized.
This appearance applies to all ToolTips displayed by this component. It may be overriden by the
The tooltips will only honor the following appearance properties:
The tooltip will automatically close when the control displaying it receives a MouseLeave message or when the AutoPopDelay has expired. If AutoPopDelay is 0, the tooltip will never time out.
When set to false, all tooltip are disabled (not shown).
This appearance applies to the title of all ToolTips displayed by this component. Any settings on this appearance may be overriden by the
The tooltips will only honor the following appearance properties:
Note that in order for the Appearance.Image or ToolTipAppearance.Image setting to apply, this property must be set to Custom or Default.
The tooltip title appears above the tooltip text. By default, it will use the same Font as the tooltip. The font will be made bold, if possible. To specify a different font, use the
When the mouse enters the control and remains stationary for the amount of time specified by InitialDelay, the tooltip is automatically shown.
When set to ToolTipTextStyle.Default, the property will be resolved based on the
If
If
If both properties are set, ToolTipTextStyle.Formatted will be used.
UltraToolTipInfo defines a set of properties that describe how a UltraToolTip is displayed. The
UltraToolTipInfo defines a set of properties that describe how an UltraToolTip is displayed. 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
Use this method to determine if a Enabled object has been created and contains data that needs to be serialized.
Use this method to determine if an ToolTipTitleAppearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if a ToolTipImage object has been created and contains data that needs to be serialized.
Use this method to determine if a ToolTipTitle object has been created and contains data that needs to be serialized.
Use this method to determine if a ToolTipText object has been created and contains data that needs to be serialized.
Use this method to determine if a ToolTipTextFormatted object has been created and contains data that needs to be serialized.
Use this method to determine if a ToolTipTextStyle object has been created and contains data that needs to be serialized.
This appearance applies only to the control associated with this UltraToolTipInfo object. When applied to the tooltip title, this will be overridden by the
The tooltips will only honor the following appearance properties:
The default setting of this property is DefaultableBoolean.Default. By default, the tooltip will display when the mouse is over the control in the same position and the amount of time specified by the
A setting of DefaultableBoolean.False will prevent the tooltip from displaying.
A setting of DefaultableBoolean.True will allow the tooltip to display even when ToolTipText has not been set. This is user if, for example, it is neccessary to show a tooltip with just an image or an image and title with no text.
Note that regardless of the setting of this property, no tooltips will be displayed if the
This appearance applies only to the control associated with this UltraToolTipInfo object.
The tooltips will only honor the following appearance properties:
All properties not listed here are ignored.
Note that in order for the Appearance.Image or ToolTipAppearance.Image setting to apply, this property must be set to Custom or Default.
The tooltip title appears above the tooltip text. By default, it will use the same Font as the tooltip. The font will be made bold, if possible. To specify a different font, use the
ToolTipText is only used when
ToolTipTextFormatted is only used when
When set to ToolTipTextStyle.Default, the property will be resolved based on the
If
If
If both properties are set, ToolTipTextStyle.Formatted will be used.
Note: The default separator (+) will be used to segment the string.
Note:If the
Note:If the
Once this method has been invoked, all subsequent calls
to the
This method cannot be reversed and should only be used when it is known that the .Net Application MessageFilter will not be invoked (e.g. when using Application.AddMessageFilter while in the Visual Studio IDE.
Note: The
Note: This method should be called the same number of times as
Note: To ensure that an up-to-date list is returned, the caller must have permission to read the registry keys that contain the time zone information. If the caller does not have such permission, a static list is returned, which cannot be guaranteed to contain current information.
By default embeddable editors do not use type converters to convert values. Setting this property to True will convert the values using underlying type converters.
This will affect all the embeddable editor owners including standalone editor controls and embeddable editor owner controls like UltraGrid, UltraWinTree etc... For example the cells in UltraGrid will display values converted using underlying type converter. If the underlying field (property descriptor associated with the column) in the data source has a type converter then it will be used. Otherwise the type converter of the data type will be used.
Also note that type conversions done using ValueConstraint's
Each
Note: The ValueList class handles population of the dropdown list displayed by the
This property is used to alphabetically sort the valuelistitems in a valuelist.
Valuelistitems are sorted based on their display text, which is set by the DisplayText property, not their data value.
When valuelistitems are sorted, their order in the ValueListItems collection does not actually change, only the order in which they are displayed to the user.
If ValueListDisplayStyle is set to any of the settings that make use of a picture, the picture will be resolved using:
If no ValueListItem object in the ValueList matches the cell's value, or if a ValueListItem is matched to the cell's value, but its Picture property is not set, then the Picture property of the ValueList's Appearance object will be used. If the Picture property of the ValueList's Appearance object is not set, no picture will be used.
The Appearance property of an object is used to associate the object with an Appearance object that will determine its appearance. The Appearance object has properties that control settings such as color, borders, font, transparency, etc. For many of the objects in the UltraWinGrid, you do not set formatting properties directly. Instead, you set the properties of an Appearance object, which controls the formatting of the object it is attached to.
There are two ways of working with the Appearance property and assigning the attributes of an SSAppearance object to other objects. One way is to create a new Appearance object, adding it directly to the Appearances collection. Then you assign the new Appearance object to the Appearance property of the object you want to format. This method uses a "named" Appearance object that you must explicitly create (and to which you must assign property settings) before it can be used. For instance, you could create an object in the grid's Appearances collection and assign it some values as follows:
UltraWinGrid1.Appearances.Add "New1"
UltraWinGrid1.Appearances("New1").BorderColor = vbBlue
UltraWinGrid1.Appearances("New1").ForeColor = vbRed
Creating the object in this way does not apply formatting to any visible part of the grid. The object simply exists in the collection with its property values, waiting to be used. To actually use the object, you must assign it to the grid's (or another object's) Appearance property:
UltraWinGrid1.Appearance = UltraWinGrid1.Appearances("New1")
In this case, only one Appearance object exists. The grid's appearance is governed by the settings of the "New1" object in the collection. Any changes you make to the object in the collection will immediately be reflected in the grid.
The second way of working with the Appearance property is to use it to set property values directly, such as:
UltraWinGrid1.Appearance.ForeColor = vbBlue
In this case, an Appearance object is automatically created by the control. This Appearance object is not a member of an Appearances collection and it does not have a name. It is specific to the object for which it was created; it is an "intrinsic" Appearance object. Changes to the properties of an intrinsic Appearance object are reflected only in the object to which it is attached.
Note that you can assign properties from a named Appearance object to an intrinsic Appearance object without creating a dependency relationship. For example, the following code...
UltraWinGrid1.Appearance.ForeColor = UltraWinGrid1.Appearances("New1").ForeColor
...does not establish a relationship between the foreground color of the intrinsic object and that of the named object. It is simply a one-time assignment of the named object's value to that of the intrinsic object. In this case, two Appearance objects exist - one in the collection and one attached to the grid - and they operate independently of one another.
If you wish to assign all the properties of a named object to an intrinsic object at once without creating a dependency relationship, you can use the Clone method of the Appearance object to duplicate its settings and apply them. So if you wanted to apply all the property settings of the named Appearance object "New1" to the grid's intrinsic Appearance object, but you did not want changes made to "New1" automatically reflected in the grid, you would use the following code:
UltraWinGrid1.Appearance = UltraWinGrid1.Appearances("New1").Clone
Note that the properties of an Appearance object can also operate in a hierarchical fashion. Certain properties can be set to a "use default" value, which indicates to the control that the property should take its setting from the object's parent. This functionality is enabled by default, so that unless you specify otherwise, child objects resemble their parents, and formatting set at higher levels of the grid hierarchy is inherited by objects lower in the hierarchy.
When set to 0, the dropdown list has no minimum width restriction.
This property returns a reference to a ValueList collection that can be used to retrieve references to the ValueListItem objects that are contained by the valuelist. You can use this reference to access any of the returned collection's properties or methods, as well as the properties or methods of the objects within the collection.
A reference to a ValueList object for a column can be obtained from the column's ValueList property. Valuelistitems can be added to or removed from a ValueList object by invoking its Add and Remove methods, respectively.
Items whose CheckState property returns 'Indeterminate' are not included in the CheckedItems collection.
The CheckedItems property is similar to the property of the same name exposed by the .NET CheckedListBox control.
When the EditorWithCombo's
The
Setting the CheckBoxStyle property to 'CheckBox' or 'TriState' in and of itself does not affect
selection behavior, except in that clicking on the checkbox does not cause the dropdown to close,
and by extension does not cause the EditorWithCombo's
This attribute only has meaning for those System.Windows.Forms.Control derived classes that implement the IValueList interface.
Note: If a System.Windows.Forms.Control derived classes implements the IValueList interface but does not has this attribute it will be considered bindable by default and added to a ValueListEditor's drop down list.
When the DrawValueListItem event fires, the DoDefaultDrawing parameter of the event arguments is true. If it is set to false, default drawing will not occur, and the listener will be able to draw the item.
When checkboxes are displayed by the items, the rectangle returned by the TextAndImageAreaBounds property will be different than that of the Bounds property of the
When checkboxes are displayed by the items, the rectangle returned by the CheckBoxBounds represents the area in which the checkbox is drawn; otherwise, this property returns an empty rectangle.
Note: In the case where the contents of the entire
When the MeasureValueListItem event fires, the DoDefaultMeasuring parameter of the event arguments is true. If it is set to false, default drawing will not occur, and the listener will be able to draw the item.
The ItemCheckArea property determines which part of the item must be clicked to change its CheckState. When set to 'CheckBox', the user must click directly on the checkbox to change the checked state of the item. When set to 'Item', clicking anywhere on the item changes the checked state. In either case, when the user's click results in a change in the checked state, the dropdown is not automatically closed.
When clicking on the item causes the checked state to change, the
The character or characters assigned to the ListSeparator determine which characters are used
to separate the display text of each item whose value is included in the editor's value when
the
When the ListSeparator property is not explicitly set, the value of the current culture's ListSeparator property, followed by one space character (ASCII character 34), is used.
The ListSeparator is used to separate the display string of each member of the
In the absence of an explicit setting, the current culture's list separator, followed by a single space character, is used. This string is appended to all items except for the last one.
When the EditorValueSource property is set to 'CheckedItems', alpha-numeric keyboard
entry is effectively disabled, i.e., the editor portion does not accept keystrokes. In this
case the editor's value is changed by checking items, which can be done by clicking on the checkbox
(or anywhere on the item depending on the value of the
The EditorValueSource property is only applicable to the
When set to 'SelectedItem' (default), the editor's value is determined by the selected item, as was the case in previous versions. Items are selected by clicking on or navigating to an entry in the dropdown list. Doing this typically triggers a selection changed notification, which is by and large the equivalent of a change in value.
When set to 'CheckedItems', the editor's value is then determined by multiple items, namely
those that are checked. Exactly what constitutes "checked" can vary between the different standalone
controls that use/provide the embeddable editor. In the case of the UltraComboEditor control (which
uses an EditorWithCombo embeddable editor and a
The data type of the entity using the editor (for example, an UltraGrid cell) must be a type that handles
arrays of simple object values, i.e., object or object[]. Additionally, the string data type is also supported.
In the case where the string data type is used, the
The Text property returns the value of the
Setting the Text property to the same value as the
The Value property returns the value of the
Setting the Value property to the same value as the
This property returns a reference to a ValueList object that can be used to set properties of, and invoke methods on, the valuelist that is associated with a column. You can use this reference to access any of the returned valuelist's properties or methods.
This property is also used to assign a particular ValueList object to a column. Once assigned, the valuelist enables a column to use the dropdown list styles and intelligent data entry, specified by the Style and AutoEdit properties, respectively, of the column for which this property is set.
This property, in conjunction with the DataValue property, provides a way to store one value in the data source while displaying another. In this manner, the user can be presented with a list of states, for example, and if he or she selects "New York," the value "NY" could be stored in the data source. In this example, this property is set to "New York" while "NY" is the value of the DataValue property.
Values for this property do not have to be unique within the ValueListItems collection.
The Find method can be invoked to search for a valuelistitem by its display text.
Note: When the DisplayText property is not explicity set, a ValueListItem will display the string representation of its
Also note that it is possible for a ValueListItem to have its DisplayText property set while no value has been specified for the
This property, in conjunction with the DisplayText property, provides a way to store one value in the datasource while displaying another. In this manner, the user can be presented with a list of states, for example, and if he or she selects "New York," the value "NY" could be stored in the data source. In this example, "New York" is the value of the DisplayText property while "NY" is the value of the DataValue property.
When data from the data source matches the data value for a particular valuelistitem, that valuelistitem's display text will be shown in the cell.
Values for this property do not have to be unique within the ValueListItems collection.
The Find method can be invoked to search for a valuelistitem by its data value.
The Appearance property of an object is used to associate the object with an Appearance object that will determine its appearance. The Appearance object has properties that control settings such as color, borders, font, transparency, etc. For many of the objects in the UltraWinGrid, you do not set formatting properties directly. Instead, you set the properties of an Appearance object, which controls the formatting of the object it is attached to.
There are two ways of working with the Appearance property and assigning the attributes of an SSAppearance object to other objects. One way is to create a new Appearance object, adding it directly to the Appearances collection. Then you assign the new Appearance object to the Appearance property of the object you want to format. This method uses a "named" Appearance object that you must explicitly create (and to which you must assign property settings) before it can be used. For instance, you could create an object in the grid's Appearances collection and assign it some values as follows:
UltraWinGrid1.Appearances.Add "New1"
UltraWinGrid1.Appearances("New1").BorderColor = vbBlue
UltraWinGrid1.Appearances("New1").ForeColor = vbRed
Creating the object in this way does not apply formatting to any visible part of the grid. The object simply exists in the collection with its property values, waiting to be used. To actually use the object, you must assign it to the grid's (or another object's) Appearance property:
UltraWinGrid1.Appearance = UltraWinGrid1.Appearances("New1")
In this case, only one Appearance object exists. The grid's appearance is governed by the settings of the "New1" object in the collection. Any changes you make to the object in the collection will immediately be reflected in the grid.
The second way of working with the Appearance property is to use it to set property values directly, such as:
UltraWinGrid1.Appearance.ForeColor = vbBlue
In this case, an Appearance object is automatically created by the control. This Appearance object is not a member of an Appearances collection and it does not have a name. It is specific to the object for which it was created; it is an "intrinsic" Appearance object. Changes to the properties of an intrinsic Appearance object are reflected only in the object to which it is attached.
Note that you can assign properties from a named Appearance object to an intrinsic Appearance object without creating a dependency relationship. For example, the following code...
UltraWinGrid1.Appearance.ForeColor = UltraWinGrid1.Appearances("New1").ForeColor
...does not establish a relationship between the foreground color of the intrinsic object and that of the named object. It is simply a one-time assignment of the named object's value to that of the intrinsic object. In this case, two Appearance objects exist - one in the collection and one attached to the grid - and they operate independently of one another.
If you wish to assign all the properties of a named object to an intrinsic object at once without creating a dependency relationship, you can use the Clone method of the Appearance object to duplicate its settings and apply them. So if you wanted to apply all the property settings of the named Appearance object "New1" to the grid's intrinsic Appearance object, but you did not want changes made to "New1" automatically reflected in the grid, you would use the following code:
UltraWinGrid1.Appearance = UltraWinGrid1.Appearances("New1").Clone
Note that the properties of an Appearance object can also operate in a hierarchical fashion. Certain properties can be set to a "use default" value, which indicates to the control that the property should take its setting from the object's parent. This functionality is enabled by default, so that unless you specify otherwise, child objects resemble their parents, and formatting set at higher levels of the grid hierarchy is inherited by objects lower in the hierarchy.
Checkboxes are only displayed by the standard dropdown used by the
The
A collection containing only the items whose CheckState is set to 'Checked' is returned by
the ValueList's
Note: When ValueListItems are added via this overload, the item's
This property returns a reference to a ValueList object that can be used to set properties of, and invoke methods on, the valuelist that is associated with a column. You can use this reference to access any of the returned valuelist's properties or methods.
This property is also used to assign a particular ValueList object to a column. Once assigned, the valuelist enables a column to use the dropdown list styles and intelligent data entry, specified by the Style and AutoEdit properties, respectively, of the column for which this property is set.
This overload returns the same string that is built by the
The elements of this collection can be indexed by their associated
This indexer provides a way to access an
This class requires that:
The term valueset refers to a complex type in an XSD. For example, a table in a grid is considered a 'valueset' because it contains multiple columns. The term value refers to a simple type in an XSD. For example, a column in a grid is considered a 'value' because it contains only single data objects (each cell contains one piece of data).
This is the constructor overload used to initialize the
This is the constructor overload used to initialize the
This is the string passed into the
This class requires that:
The term valueset refers to a complex type in an XSD. For example, a table in a grid is considered a 'valueset' because it contains multiple columns. The term value refers to a simple type in an XSD. For example, a column in a grid is considered a 'value' because it contains only single data objects (each cell contains one piece of data).
If the
Setting this property to null (Nothing) indicates that there is no default value.
This is a convenience property used to determine whether the XSD value has a default value specified.
If the target entity could not be located in the schema this property returns false. The target entity
is specified via the
The target value is specified via the
This class requires that:
The term valueset refers to a complex type in an XSD. For example, a table in a grid is considered a 'valueset' because it contains multiple columns. The term value refers to a simple type in an XSD. For example, a column in a grid is considered a 'value' because it contains only single data objects (each cell contains one piece of data).
Creates an
Returns a
If the valueset whose name was specified in the constructor does not exist in the schema then this property
will return false. If this property returns false, the
For example, if the target valueset corresponds to a DataTable in a DataSet this value indicates the minimal row count allowed in that table.
This property will return false if the valueset does not have a meaningful value for the
For example, if the target valueset corresponds to a DataTable in a DataSet this value indicates the maximal row count allowed in that table.
This property will return false if the valueset does not have a meaningful value for the
Returns true if the target valueset can occur an infinte number of times.