Version

ControlUIElementBase Class Members

The following tables list the members exposed by ControlUIElementBase.

Protected Fields
 NameDescription
Protected FieldchildElementsCollectionThe collection of child elements (Inherited from Infragistics.Win.UIElement)
Protected FieldchildElementsCollectionDirtyIndicates if the child elements for this element need to be repositioned/created (Inherited from Infragistics.Win.UIElement)
Protected FieldparentElementThe parent UIElement (will be null for the ControlUIElementBase derived classes (Inherited from Infragistics.Win.UIElement)
Protected FieldrectValueThe rect of this elements in client coordinates of the control (Inherited from Infragistics.Win.UIElement)
Public Properties
 NameDescription
Public PropertyAccessibilityInstanceOverridden. Returns the accessible object associated with the control.  
Public PropertyAccessibilityInstanceResolvedReturns the accessible object associated with this element or one of its parent elements. (Inherited from Infragistics.Win.UIElement)
Public PropertyAdjustableReturns true is this element can be moved or resized by the user (Inherited from Infragistics.Win.UIElement)
Public PropertyAreTouchMetricsEnabledOverridden. Returns whether Touch mode is currently enabled on this control.  
Public PropertyBorderSidesReturns flags indicating which borders will be drawn (Inherited from Infragistics.Win.UIElement)
Public PropertyBorderStyleBorderStyle of the element. UIElementBorderStyle (Inherited from Infragistics.Win.UIElement)
Public PropertyCancelCaptureOnEscapeIndicates if capture for this element should be terminated if the escape key is pressed. (Inherited from Infragistics.Win.UIElement)
Public PropertyChildElementsReturns the child elements array (read-only) (Inherited from Infragistics.Win.UIElement)
Public PropertyChildElementsDirtyTrue indicates that the child elements need to be created/adjusted on the next draw operation (read-only) (Inherited from Infragistics.Win.UIElement)
Public PropertyClipRectReturns the intersection of this element's rect's with all of its parent element's rects (Inherited from Infragistics.Win.UIElement)
Public PropertyComponentRoleReturns the Infragistics.Win.AppStyling.ComponentRole used to obtain the application style information for the associated component.  
Public PropertyControlOverridden. Returns the Control associated with this element.  
Public PropertyControlElementReturns the top level/control element. Read-only. (Inherited from Infragistics.Win.UIElement)
Public Propertystatic (Shared in Visual Basic)ControlElementWithMouseCaptureThe control element that captured the mouse or null if the mouse hasn't been captured by any control element. (read-only)  
Public PropertyCurrentCursorReturns the current cursor that will be used based on the current position of the mouse. (read-only)  
Public PropertyCurrentMousePositionReturns the current mouse position relative to the associated Control  
Public PropertyCursorOverridden. Returns the cursor that should be used when the mouse is over the element.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyDrawingClipRectReturns the intersection of this element's rect's with all of its parent element's rects. This can differ from the ClipRect when RightToLeft is true or if the ZoomFactor is different than 1. (Inherited from Infragistics.Win.UIElement)
Public PropertyDrawingRectReturns the rect into which the element will draw. This can differ from the Rect when RightToLeft is true or if the ZoomFactor is different than 1. (Inherited from Infragistics.Win.UIElement)
Public PropertyDrawingRectInsideBordersReturns the rect into which the element will draw after adjusting for any borders. This can differ from the RectInsideBorders when RightToLeft is true or if the ZoomFactor is different than 1. (Inherited from Infragistics.Win.UIElement)
Public PropertyDrawingRegionReturns the Region into which the element will draw. This can differ from the Region when RightToLeft is true or if the ZoomFactor is different than 1. (Inherited from Infragistics.Win.UIElement)
Public PropertyElementWithMouseCaptureThe element that captured the mouse or null if the mouse hasn't been captured by an element. (read-only)  
Public PropertyEnabledOverridden. Gets/sets whether this element is enabled. Note: this will return false the element or any of its ancestors are disabled.  
Public PropertyHasChildElementsReturns true if there are any child elements (read-only) (Inherited from Infragistics.Win.UIElement)
Public PropertyIsAccessibleElementOverridden. Indicates if the element supports accessibility.  
Public PropertyIsDrawingTrue if this element is in a drawing operation (read-only). (Inherited from Infragistics.Win.UIElement)
Public PropertyIsElementDrawnTrue if this element is drawn normally. The default implementation of this property returns true. It may be overidden by some elements who don't do any rendering (e.g. scrollbars since they are actually scrollbar windows that render themselves) (Inherited from Infragistics.Win.UIElement)
Public PropertyIsFullyVisibleReturns true if the entire elment is visible or false if any part is clipped (Inherited from Infragistics.Win.UIElement)
Public PropertyIsPrintReturns true if this element is used for print rather than normal screen display operations (read-only).  
Public PropertyIsUiaDelegatingElementIndicates that this element supports UI Automation, but only as an invisible delegate that does not display in the UIAutomation tree. (Inherited from Infragistics.Win.UIElement)
Public PropertyIsUiaElementIndicates if the element supports UI Automation. (Inherited from Infragistics.Win.UIElement)
Public PropertyLastElementEnteredReturns the last element that was entered with the mouse or null (read-only).  
Public PropertyNestDepthThe nesting depth, 0 for top level control elements, 1 for their direct child elements, 2 for those element's child elements etc. (read-only) (Inherited from Infragistics.Win.UIElement)
Public PropertyParentThe parent/containing element (will be null for a top level/control element). (Inherited from Infragistics.Win.UIElement)
Public PropertyParentIsRightToLeftReturns whether this element is contained within an element that is RightToLeft. (Inherited from Infragistics.Win.UIElement)
Public PropertyPathSpecifies a GraphicsPath to use for drawing the Background, Borders, or ImageBackground of the UIElement. (Inherited from Infragistics.Win.UIElement)
Public PropertyPrintColorModeIndicates how colors and images are rendered when printed.  
Public PropertyRectThe element's bounding rectangle in client coordinates (Inherited from Infragistics.Win.UIElement)
Public PropertyRectInsideBordersReturns the rectangle after adjusting for any borders (Inherited from Infragistics.Win.UIElement)
Public PropertyRegionReturns the region of this element. The default returns the element's Rect as a region. This method can be overriden to supply an irregularly shaped region (Inherited from Infragistics.Win.UIElement)
Public PropertyRightToLeftOverridden. Gets a value indicating whether elements are aligned to support locales using right-to-left fonts.  
Public PropertyRightToLeftResolvedReturns the resolved RightToLeft state of the element. (Inherited from Infragistics.Win.UIElement)
Public PropertySelectableItemIf the context for this element is a selectable item (e.g. a grid row, cell or header) it is returned. The default implementation walks up the parent chain calling this method recursively until a selectable item is found or the control element is reached (Inherited from Infragistics.Win.UIElement)
Public PropertySuppressKeyPressForHandledKeyActionMappingsDetermines whether to set SuppressKeyPress to true in KeyDown when the key is handled by the KeyActionMappings. By default, returns false.  
Public PropertyThemedElementRegionReturns the region of this element that themed drawing should be clipped to. The default implementation returns null. (Inherited from Infragistics.Win.UIElement)
Public PropertyToolTipItemReturns or sets an object that provides tooltip information for the element. (Inherited from Infragistics.Win.UIElement)
Public PropertyUIAutomationProviderReturns a UIAutomation provider for this UIElement. (Inherited from Infragistics.Win.UIElement)
Public PropertyUIRoleReturns the Infragistics.Win.AppStyling.UIRole associated with this element. (Inherited from Infragistics.Win.UIElement)
Public PropertyUIRoleResolvedReturns the Infragistics.Win.AppStyling.UIRole used by this element or an element higher up the parent chain. (Inherited from Infragistics.Win.UIElement)
Public PropertyUltraControlReturns the control's IUltraControl interface  
Public PropertyZoomFactorThe zoom factor of the ControlUIElement.  
Protected Properties
 NameDescription
Protected PropertyChildElementArrayCapacityReturns the expected number of child elements for this element (Inherited from Infragistics.Win.UIElement)
Protected PropertyClipChildrenReturning true causes all drawing of this element's child elements to be expicitly clipped to the area inside this elements borders (Inherited from Infragistics.Win.UIElement)
Protected PropertyClipRectChildrenReturns the rect inside borders as the default (Inherited from Infragistics.Win.UIElement)
Protected PropertyClipSelfReturning true causes all drawing of this element to be expicitly clipped to its region (Inherited from Infragistics.Win.UIElement)
Protected PropertyControlElementScalingDirtiesChildElementsDetermines whether or not the child collection will be dirtied when drawing, if the control element rect is scaled due to its zoom factor.  
Protected PropertyCurrentStateReturns bit flags indicating the current state of the control (used to get appropriate key actions on keyDown)  
Protected PropertyDefaultToolTipDisplayStyleThe default ToolTipDisplayStyle used when the control element displays a tooltip via the element's UIElement.ToolTipItem  
Protected PropertyDelegateMousePanningToParentReturns the element which handles mouse panning for this element. (Inherited from Infragistics.Win.UIElement)
Protected PropertyDrawsFocusRectReturns true if this element needs to draw a focus rect. This should be overridden since the default implementation always returns false. (Inherited from Infragistics.Win.UIElement)
Protected PropertyForceDrawsFocusRectReturns a boolean value indicating whether this element's focus rectangle drawing logic should ignore the associated control's focused state. (Inherited from Infragistics.Win.UIElement)
Protected PropertyHasCaptureIndicates if the element has capture. (Inherited from Infragistics.Win.UIElement)
Protected PropertyInkProviderReturns the InkProvider registered for our control's container. (Inherited from Infragistics.Win.UIElement)
Protected PropertyKeyActionMappingsReturns the control's key mappings collection  
Protected PropertyNotificationBadgeProviderIf the element can show Notification Badges it will return its provider. (Inherited from Infragistics.Win.UIElement)
Protected PropertyPrimaryContextUsed to keep track of the primary context for this element (e.g. its Row, Cell, Header etc.). Since most elements need only one context this property is usually adequate. (Inherited from Infragistics.Win.UIElement)
Protected PropertyRectangleIsScaledDownGets whether or not the ControlUIElement is scaled down, due to its ZoomFactor.  
Protected PropertySupportsHorizontalMousePanningGets whether this Element supports horizontal mouse panning Default implementation returns false; derived elements that want to support panning must override this property implementation and return true If a derived element returns true, the mouse is captured when the middle button is pressed. The virtual 'OnMousePanHorizontal' method will be called during the capture. Derived elements that want to support panning should override OnMousePanHorizontal, and perform scrolling operations from within that method (Inherited from Infragistics.Win.UIElement)
Protected PropertySupportsVerticalMousePanningGets whether this Element supports vertical mouse panning Default implementation returns false; derived elements that want to support panning must override this property implementation and return true If a derived element returns true, the mouse is captured when the middle button is pressed. The virtual 'OnMousePanVertical' method will be called during the capture. Derived elements that want to support panning should override OnMousePanVertical, and perform scrolling operations from within that method (Inherited from Infragistics.Win.UIElement)
Protected PropertyWantsMouseHoverNotificationReturn true if this element wants to be notified when the mouse hovers over it. This property is read-only. (Inherited from Infragistics.Win.UIElement)
Public Methods
 NameDescription
Public MethodAdjustableElementFromPointOverloaded. Returns an element reference if the passed in point is over the AdjustableArea of this element (or any of its child elements) (Inherited from Infragistics.Win.UIElement)
Public MethodAdjustForTouchModeOverloaded. Adjusts the extent of an element for touch mode.  
Public MethodAdjustRectForRightToLeftTakes a rect and adjusts it for RightToLeft relative to this UIElement. (Inherited from Infragistics.Win.UIElement)
Public MethodAdjustRectForZoomingAdjust the rectangle size and position based on the zoom factor of the ControlUIElement. (Inherited from Infragistics.Win.UIElement)
Public MethodAdjustRegionToZoomFactorAdjusts the region for the provided zoom factor (Inherited from Infragistics.Win.UIElement)
Public MethodCaptureMouseForElementCaptures the mouse for the passed in element.  
Public MethodContainsOverloaded. Overridden. Checks if the point is over the element. This may be overridden in derived classes for specialized hit test logic.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDirtyChildElementsOverloaded. Sets the dirty flag so that the next time the element is drawn it will reposition its child elements (Inherited from Infragistics.Win.UIElement)
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDrawOverloaded. Overridden. Draws the control.  
Public MethodDrawElementRenders the element into the graphics object of the specified defaultDrawParams. This method will recursively invoke itself for rendering the descendant elements. (Inherited from Infragistics.Win.UIElement)
Public MethodDrawToBitmapReturns a bitmap into which the UIElement has been drawn. (Inherited from Infragistics.Win.UIElement)
Public MethodElementFromPointOverloaded. Returns the lowest level element that contains the passed in point (Inherited from Infragistics.Win.UIElement)
Public MethodGetAdjustableCursorThe adjustable cursor is used by any element that can be moved or resized. Returning null means the element can not be adjusted by clicking on the passed in point. (Inherited from Infragistics.Win.UIElement)
Public MethodGetAdjustmentRangeReturns the range limits for adjusting the element in either or both dimensions. It also returns the initial rects for the vertical and horizontal bars that will need to be inverted during the mouse drag operation. Default implementation sets everything to zero. (Inherited from Infragistics.Win.UIElement)
Public MethodGetAncestorWalks up the parent chain until it reaches the parent of the requested type. Also, if this element is of the passed in type then this elemnt will be returned. (Inherited from Infragistics.Win.UIElement)
Public MethodGetBorderWidthsReturns the widths of all four borders (Inherited from Infragistics.Win.UIElement)
Public MethodGetContextOverloaded. Overridden. Returns an object of requested type that relates to the element or null.  
Public MethodGetDescendantOverloaded. Returns an element of the requested type or null. (Inherited from Infragistics.Win.UIElement)
Public MethodGetInkProviderGets and caches the InkProvider registered for the control's container.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodHasAncestorReturns true if the passed in element is in this elment's parent chain (Inherited from Infragistics.Win.UIElement)
Public MethodHasContextOverloaded. Returns true if this element (or any of its ancestors) has this context (Inherited from Infragistics.Win.UIElement)
Public MethodHitTestRetrieves the child accessible object at the specified screen coordinates. (Inherited from Infragistics.Win.UIElement)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInvalidateOverloaded. Invalidates this element (Inherited from Infragistics.Win.UIElement)
Public MethodIsDescendantOfReturns true if this element is the same as the specified element or if this element is a descendant of the specified element. (Inherited from Infragistics.Win.UIElement)
Public MethodNavigateOverloaded. Navigates to another accessible object (Inherited from Infragistics.Win.UIElement)
Public MethodOffsetOverloaded. Offsets this element rect and all of its child elements (Inherited from Infragistics.Win.UIElement)
Public MethodPointInAdjustableAreaReturns true if the passed in point is over an area of this element that would require the AdjustableCursor to be displayed (Inherited from Infragistics.Win.UIElement)
Public MethodPointInElementOverloaded. Checks if the point is over the element and is not over an overlapping sibling element. (Inherited from Infragistics.Win.UIElement)
Public MethodPrintDraws the element into a printer dc. (Inherited from Infragistics.Win.UIElement)
Public MethodProcessKeyDownkeydown event handler  
Public MethodRefreshLastElementEnteredRecalculates the element at the current mouse location and synchronizes the mouse enter/leave for the control element.  
Public MethodTerminateCaptureCancels the mouse capture and notifies the selection strategy or element that has captured the mouse.  
Public MethodValidateLastElementEnteredUsed to validate that the current LastElementEntered is currently in the uielement parent chain and if not causes the mouse element enter/leave events to be invoked as required.  
Public MethodVerifyChildElementsOverloaded. Called to ensure that all child elements are created and positioned properly. If the ChildElementsDirty flag is true then the PositionChildElements will be called and the dirty flag will be reset. This method gets called recursively for all descendant elements. (Inherited from Infragistics.Win.UIElement)
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodAdjustMousePositionInvoked before the control element utilizes the current mouse position to allow a derived control element to offset the position if necessary.  
Protected MethodContinueDescendantSearchThis method is called from UIElement.GetDescendant as an optimization to prevent searching down element paths that can't possibly contain the element that is being searched for. (Inherited from Infragistics.Win.UIElement)
Protected MethodCreateUIAutomationProviderFactory method which creates a UI Automation wrapper for the specified context. (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawBackColorDefault backcolor drawing just does a FillRectangle with the backcolor. (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawBordersDefault border rendering (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawChildElementsDefault child element rendering - draws each of the child elements. (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawFocusDefault drawfocus method draws a focus rect inside the element's borders (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawForegroundDefault foreground rendering - does nothing (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawImageDefault image rendering - does nothing (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawImageBackgroundDefault background picture drawing (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawThemeUsed by an element to render using the system theme. This method will not be invoked if the themes are not supported. (Inherited from Infragistics.Win.UIElement)
Protected MethodGetUIRoleHelper method for obtaining a Infragistics.Win.AppStyling.UIRole for a particular role name. (Inherited from Infragistics.Win.UIElement)
Protected MethodInitAppearanceOverridden. Initialize the appearance structure for this element. The default implementation sets the backcolor to the system color for controls.  
Protected MethodInternalCursorFromAppearanceExtracts the cursor from the appearance object this method is overridden by an element with a mousepointer set (Inherited from Infragistics.Win.UIElement)
Protected MethodInternalSetElementsChangedOverridden. Dirties a flag that some descendant element have changed.  
Protected MethodIntersectInvalidRectReturns the intersection of the element's rect with the invalid rect for the current draw operation. (Inherited from Infragistics.Win.UIElement)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnAfterDrawA virtual method that gets called after the element draw operation finishes. (Inherited from Infragistics.Win.UIElement)
Protected MethodOnBeforeDisplayToolTipNotifies this instance that a tooltip is about to be displayed.  
Protected MethodOnBeforeDrawA virtual method that gets called before the element draw process starts. (Inherited from Infragistics.Win.UIElement)
Protected MethodOnDisposeOverridden. Called when the object is disposed  
Protected MethodOnFontChangedCalled when the control's font changes. The default implemention calls DirtyChildElements and invalidates this element.  
Protected MethodOnGotFocusGotFocus event handler. Gets called when the control takes focus.  
Protected MethodOnLostFocusGotFocus event handler. Gets called when the control takes focus.  
Protected MethodOnMousePanCaptureCalled when this element is captured to begin a mouse panning operation. (Inherited from Infragistics.Win.UIElement)
Protected MethodOnMousePanCaptureTerminatedCalled when capture is released from this element to end a mouse panning operation. (Inherited from Infragistics.Win.UIElement)
Protected MethodOnMousePanHorizontalVirtual method that is called each time the mouse pans horizontally Derived classes should override this method (Inherited from Infragistics.Win.UIElement)
Protected MethodOnMousePanVerticalVirtual method that is called each time the mouse pans vertically Derived classes should override this method (Inherited from Infragistics.Win.UIElement)
Protected MethodOnPreMouseDownCalled when a mouse down message is received. Returning true will cause normal mouse down processing to be skipped  
Protected MethodOnVerifyChildElementsCompleteGets called when any verification process of contained elements completes  
Protected MethodPerformKeyActionPerforms the specified action  
Protected MethodPositionChildElementsMakes sure that the child elements for this element are in the ChildElements array and that they are positioned properly. This needs to be overridden if the element has any child elements. (Inherited from Infragistics.Win.UIElement)
Protected MethodSetParentSets the parent element (Inherited from Infragistics.Win.UIElement)
Protected MethodShouldDeferMouseDownForDoubleClickReturns true to defer the processing of a MouseDown until it can be determined if a Double-Click occurs.  
Protected MethodSupportsSelectionReturns whether selection is supported for the specified mouse state.  
Protected MethodWantsInputNotificationReturns true if this ui element is interested in getting notificaions of type inputType at the specified location. Default implementation always returns true. (Inherited from Infragistics.Win.UIElement)
See Also