|
Override this method to support irregular regions.
|
Returns True if it is in the element’s rectangle.
|
|
This method is called after DrawTheme and during a drawing operation to draw an element’s background color. It is usually overridden to provide a Null implementation that prevents the element’s background from being drawn (e.g. the TextUIElement does this). It can also be used to perform custom drawing.
|
Calls the DrawBackColor method with the passed-in UIElementDrawParams structure to fill the invalid area.
|
|
This method is called after DrawImageBackground during a drawing operation to draw an element’s borders. It is actually very rare that this method would need to be overridden since the BorderStyle and BorderSides properties allow very flexible control of the borders. However, it can be overridden to perform custom border drawing.
|
Calls the DrawBorders method with the passed-in UIElementDrawParams structure, which draws the borders based on the BorderStyle and BorderSides properties of the element.
|
|
This method is called after DrawForeground during a drawing operation to draw an element’s child elements. It is usually overridden to provide a Null implementation to prevent the element’s child elements from drawing.
|
Draws the child elements.
|
|
This method is called during a drawing operation to draw a focus indicator for the element. It is called after the element and all of its child elements have been drawn. It is called only if the control has focus (or the forceDrawAsFocused parameter was set to True on the call to the Draw method) and the element returns True from the DrawsFocusRect property.
|
Draws a focus rectangle inside the borders of the element using the RectInsideBorders property.
|
|
This method is called after DrawImage during a drawing operation to draw an element’s foreground (e.g. the TextUIElement draws the text in this method).
|
|
|
This method is called after DrawBorders during a drawing operation to draw an element’s foreground image (e.g. the ImageUIElement draws the image in this method).
|
|
|
This method is called after DrawBackColor during a drawing operation to draw an element’s background image. It is usually overridden to provide a Null implementation to prevent the element’s background from being drawn (e.g. the TextUIElement does this). It can also be used to perform custom drawing.
|
Draws the ImageBackground of the resolved appearance which is exposed by the passed-in UIElementDrawParams structure.
|
|
This is the first 'Draw…' method called during a drawing operation to draw the element as an XP themed element. Themed elements like drop-down buttons and scrollbar elements override this method and use the XPThemes class to render the element appropriately and return true so that the other draw methods are bypassed.
|
Does nothing and returns False so the other 'Draw…' methods will be called.
|
|
This method is overridden by elements that return True from the Adjustable property to supply the appropriate cursor when the mouse is over an adjustable area of the element .
|
|
|
The range parameter is set to a structure that contains the range limits for adjusting the element in either or both dimensions. It also returns the initial rectangles for the vertical and horizontal bars that need to be inverted during a mouse drag operation.
|
Sets the range parameter to a structure filled with zeroes.
|
|
This method returns the context for the element. Overriding this method is not very common at all. It is normally overridden only by elements that have more than one context object (which means the base class’s PrimaryContext property is inadequate). For example, in UltraGrid, the only element to override this method is the RowColRegionIntersectionUIElement which must maintain a reference on both a RowScrollRegion object and a ColScrollRegion object.
|
Checks if the context object has been set and if its type matches the requested type. If so, it returns the context object, if not, it calls this method on its parent (which effectively walks up the parent chain until it finds a match or reaches the control’s main element). This is important because if, for example, you ask for the Row context of a CellUIElement’s child TextUIElement, it will walk up the parent element chain until it reaches the RowUIElement and return the appropriate Row context.
|
-
AppearanceData
-
AppearancePropFlags
|
Called before an element is drawn so that the element can specify its fore color, back color, border color etc. Note: any appearance settings left to their default values will pick up the parent element’s settings (except for the ImageBackground, BackGradientStyle and BackHatchStyle properties).
|
|
-
integer deltaX
-
integer deltaY
-
Boolean recursive
|
Normally there is no reason to override this method.
|
Offsets this element’s rectangle and if the recursive flag is true calls this method on each of its child elements.
|
|
Called after an element has been drawn.
|
|
|
Called before an element is about to be drawn.
|
|
|
Called when mouse capture is cancelled on the element that captured the mouse (e.g. in the OnMouseDown).
|
Stops any panning timers and resets the cursor and then calls this method on its parent element which effectively just walks up the parent chain.
|
|
Called when mouse is clicked on an element.
|
Calls this method on its parent element which effectively just walks up the parent chain.
|
|
Called when mouse is double-clicked on an element.
|
Calls this method on its parent element, which effectively just walks up the parent chain.
|
|
This method is called when a mouse button is pressed while the mouse is over the element. It is normally overridden to perform some action and/or capture the mouse. Setting the captureMouseForElement parameter to an element (usually this element) before returning from this method will capture the mouse for the element and cause subsequent OnMouseMove calls to be made on the element.
|
If the middle mouse button has been pressed and either the SupportsHorizontalMousePanning or the SupportsVerticalMousePanning properties return True, then the appropriate mouse panning cursor is displayed and a timer is started to generate OnMousePanHorizontal and/or OnMousePanVertical method calls and the method returns True. Otherwise it calls this method on its parent element (effectively walking up the parent chain) until an element overrides the method or the main element is reached and False is returned.
|
|
This method is called when the mouse enters the element’s rectangle.
|
|
|
This method is normally overridden to show tool tips. It is called when the mouse is paused over the element. If an element overrides this method it should also override the WantsMouseHoverNotification property and return true.
|
Calls this method on its parent element which effectively just walks up the parent chain.
|
|
This method is called when the mouse leaves the element’s rectangle.
|
|
|
Called when the mouse is moved over an element or the mouse is moved and the element captured the mouse in OnMouseDown.
|
Calls this method on its parent element which effectively just walks up the parent chain.
|
|
This method is called during a horizontal panning operation by elements that return true for their SupportsHorizontalMousePanning property. The number of pixels between the cursor position and the origin mark is passed into this method. This value is positive when the cursor is to the right of the origin mark, negative when it is left of the origin mark and zero if it is within the origin mark threshold.
|
Does nothing. Should be overridden by elements that return true for their SupportsHorizontalMousePanning property.
|
|
This method is called during a vertical panning operation by elements that return true for their SupportsVerticalMousePanning property. The number of pixels between the cursor position and the origin mark is passed into this method. This value is positive when the cursor is below the origin mark, negative when it is above the origin mark and zero if it is within the origin mark threshold.
|
Does nothing. Should be overridden by elements that return true for their SupportsVerticalMousePanning property.
|
|
Called when the mouse is released over the element or the mouse is released and the element captured the mouse in OnMouseDown. Note: returning true from this method will ignore the next click event.
|
Stops any panning timers and resets the cursor and then calls this method on its parent element which effectively just walks up the parent chain.
|
|
This method is overridden by elements that return True from the Adjustable property to determine if a point is over an adjustable area of the element.For example, a column header element may want to allow resizing of its width if the user clicking within 3 pixels of its right border. In this case if the point was within 3 pixels of the right border this method would return true.
|
|
|
This is called when an element needs to create/position its child elements. This method must be overridden by any element that has child elements.
|
Does nothing (no child elements are created).
|
|
Called during a drawing operation to ensure that all child elements are created and positioned properly. Normally this method does not need to be overridden.
|
If the ChildElementsDirty flag is True then the default implementation will call PositionChildElements and reset the flag.
|
