Version

UIElement Class Members

The following tables list the members exposed by UIElement.

Public Constructors
 NameDescription
Public ConstructorUIElement ConstructorOverloaded.   
Protected Fields
 NameDescription
Protected FieldchildElementsCollectionThe collection of child elements  
Protected FieldchildElementsCollectionDirtyIndicates if the child elements for this element need to be repositioned/created  
Protected FieldparentElementThe parent UIElement (will be null for the ControlUIElementBase derived classes  
Protected FieldrectValueThe rect of this elements in client coordinates of the control  
Public Properties
 NameDescription
Public PropertyAccessibilityInstanceReturns the accessible object associated with the element.  
Public PropertyAccessibilityInstanceResolvedReturns the accessible object associated with this element or one of its parent elements.  
Public PropertyAdjustableReturns true is this element can be moved or resized by the user  
Public PropertyAreTouchMetricsEnabledReturns whether Touch mode is currently enabled on this control.  
Public PropertyBorderSidesReturns flags indicating which borders will be drawn  
Public PropertyBorderStyleBorderStyle of the element. UIElementBorderStyle  
Public PropertyCancelCaptureOnEscapeIndicates if capture for this element should be terminated if the escape key is pressed.  
Public PropertyChildElementsReturns the child elements array (read-only)  
Public PropertyChildElementsDirtyTrue indicates that the child elements need to be created/adjusted on the next draw operation (read-only)  
Public PropertyClipRectReturns the intersection of this element's rect's with all of its parent element's rects  
Public PropertyControlWalks up the parent chain until it reaches a Control element (which overrides this method)  
Public PropertyControlElementReturns the top level/control element. Read-only.  
Public PropertyCursorReturns the cursor that should be used when the mouse is over the element. By default this just walks up the parent chain by returning its parent's cursor  
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.  
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.  
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.  
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.  
Public PropertyEnabledGets/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)  
Public PropertyIsAccessibleElementIndicates if the element supports accessibility.  
Public PropertyIsDrawingTrue if this element is in a drawing operation (read-only).  
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)  
Public PropertyIsFullyVisibleReturns true if the entire elment is visible or false if any part is clipped  
Public PropertyIsUiaDelegatingElementIndicates that this element supports UI Automation, but only as an invisible delegate that does not display in the UIAutomation tree.  
Public PropertyIsUiaElementIndicates if the element supports UI Automation.  
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)  
Public PropertyParentThe parent/containing element (will be null for a top level/control element).  
Public PropertyParentIsRightToLeftReturns whether this element is contained within an element that is RightToLeft.  
Public PropertyPathSpecifies a GraphicsPath to use for drawing the Background, Borders, or ImageBackground of the UIElement.  
Public PropertyRectThe element's bounding rectangle in client coordinates  
Public PropertyRectInsideBordersReturns the rectangle after adjusting for any borders  
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  
Public PropertyRightToLeftGets a value indicating whether elements are aligned to support locales using right-to-left fonts.  
Public PropertyRightToLeftResolvedReturns the resolved RightToLeft state of the element.  
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  
Public PropertyThemedElementRegionReturns the region of this element that themed drawing should be clipped to. The default implementation returns null.  
Public PropertyToolTipItemReturns or sets an object that provides tooltip information for the element.  
Public PropertyUIAutomationProviderReturns a UIAutomation provider for this UIElement.  
Public PropertyUIRoleReturns the Infragistics.Win.AppStyling.UIRole associated with this element.  
Public PropertyUIRoleResolvedReturns the Infragistics.Win.AppStyling.UIRole used by this element or an element higher up the parent chain.  
Protected Properties
 NameDescription
Protected PropertyChildElementArrayCapacityReturns the expected number of child elements for this element  
Protected PropertyClipChildrenReturning true causes all drawing of this element's child elements to be expicitly clipped to the area inside this elements borders  
Protected PropertyClipRectChildrenReturns the rect inside borders as the default  
Protected PropertyClipSelfReturning true causes all drawing of this element to be expicitly clipped to its region  
Protected PropertyDelegateMousePanningToParentReturns the element which handles mouse panning for this element.  
Protected PropertyDrawsFocusRectReturns true if this element needs to draw a focus rect. This should be overridden since the default implementation always returns false.  
Protected PropertyForceDrawsFocusRectReturns a boolean value indicating whether this element's focus rectangle drawing logic should ignore the associated control's focused state.  
Protected PropertyHasCaptureIndicates if the element has capture.  
Protected PropertyInkProviderReturns the InkProvider registered for our control's container.  
Protected PropertyNotificationBadgeProviderIf the element can show Notification Badges it will return its provider.  
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.  
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  
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  
Protected PropertyWantsMouseHoverNotificationReturn true if this element wants to be notified when the mouse hovers over it. This property is read-only.  
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)  
Public MethodAdjustRectForRightToLeftTakes a rect and adjusts it for RightToLeft relative to this UIElement.  
Public MethodAdjustRectForZoomingAdjust the rectangle size and position based on the zoom factor of the ControlUIElement.  
Public MethodAdjustRegionToZoomFactorAdjusts the region for the provided zoom factor  
Public MethodContainsOverloaded. 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  
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDrawOverloaded. Draws the element.  
Public MethodDrawElementRenders the element into the graphics object of the specified defaultDrawParams. This method will recursively invoke itself for rendering the descendant elements.  
Public MethodDrawToBitmapReturns a bitmap into which the UIElement has been drawn.  
Public MethodElementFromPointOverloaded. Returns the lowest level element that contains the passed in point  
Public Methodstatic (Shared in Visual Basic)FindElementInDirectionOverloaded. Find the closest element to this one in the element's control element.  
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.  
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.  
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.  
Public MethodGetBorderWidthsReturns the widths of all four borders  
Public Methodstatic (Shared in Visual Basic)GetCommonAncestorStatic method that returns the deepest nested element that is a common ancestor element of both the passed in elements.  
Public MethodGetContextOverloaded. Returns the primary context object.  
Public MethodGetDescendantOverloaded. Returns an element of the requested type or null.  
Public Methodstatic (Shared in Visual Basic)GetDeskTopWorkAreaGets the desktop area. In a multi-monitor setup, it gets the desktop area of the monitor that most of the rect resides in.  
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  
Public MethodHasContextOverloaded. Returns true if this element (or any of its ancestors) has this context  
Public MethodHitTestRetrieves the child accessible object at the specified screen coordinates.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInvalidateOverloaded. Invalidates this element  
Public Methodstatic (Shared in Visual Basic)IsContextOfTypeDetermines if the context is of the specified type.  
Public MethodIsDescendantOfReturns true if this element is the same as the specified element or if this element is a descendant of the specified element.  
Public MethodNavigateOverloaded. Navigates to another accessible object  
Public MethodOffsetOverloaded. Offsets this element rect and all of its child elements  
Public MethodPointInAdjustableAreaReturns true if the passed in point is over an area of this element that would require the AdjustableCursor to be displayed  
Public MethodPointInElementOverloaded. Checks if the point is over the element and is not over an overlapping sibling element.  
Public MethodPrintDraws the element into a printer dc.  
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.  
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodContinueDescendantSearchThis method is called from GetDescendant(Type) as an optimization to prevent searching down element paths that can't possibly contain the element that is being searched for.  
Protected MethodCreateUIAutomationProviderFactory method which creates a UI Automation wrapper for the specified context.  
Protected MethodDrawBackColorDefault backcolor drawing just does a FillRectangle with the backcolor.  
Protected MethodDrawBordersDefault border rendering  
Protected MethodDrawChildElementsDefault child element rendering - draws each of the child elements.  
Protected MethodDrawFocusDefault drawfocus method draws a focus rect inside the element's borders  
Protected MethodDrawForegroundDefault foreground rendering - does nothing  
Protected MethodDrawImageDefault image rendering - does nothing  
Protected MethodDrawImageBackgroundDefault background picture drawing  
Protected MethodDrawThemeUsed by an element to render using the system theme. This method will not be invoked if the themes are not supported.  
Protected Methodstatic (Shared in Visual Basic)ExtractExistingElementOverloaded. Static method that searches thru the passed in collection and returns the first object of the requested type that it finds  
Protected MethodGetUIRoleHelper method for obtaining a Infragistics.Win.AppStyling.UIRole for a particular role name.  
Protected MethodInitAppearanceInitialize the appearance structure for this element  
Protected MethodInternalCursorFromAppearanceExtracts the cursor from the appearance object this method is overridden by an element with a mousepointer set  
Protected MethodInternalSetElementsChangedDefault implementation just walks up the parent chain. This is overriden by the ControlUIElementBase class which maintains a flag that some descendant element may have changed  
Protected MethodIntersectInvalidRectReturns the intersection of the element's rect with the invalid rect for the current draw operation.  
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.  
Protected MethodOnBeforeDrawA virtual method that gets called before the element draw process starts.  
Protected MethodOnDisposeOverridden. Called when element is disposed of.  
Protected MethodOnMousePanCaptureCalled when this element is captured to begin a mouse panning operation.  
Protected MethodOnMousePanCaptureTerminatedCalled when capture is released from this element to end a mouse panning operation.  
Protected MethodOnMousePanHorizontalVirtual method that is called each time the mouse pans horizontally Derived classes should override this method  
Protected MethodOnMousePanVerticalVirtual method that is called each time the mouse pans vertically Derived classes should override this method  
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.  
Protected MethodSetParentSets the parent element  
Protected MethodWantsInputNotificationReturns true if this ui element is interested in getting notificaions of type inputType at the specified location. Default implementation always returns true.  
See Also

Reference

UIElement Class
Infragistics.Win Namespace
Infragistics.Shared.DisposableObject