Infragistics(R) NetAdvantage(R) Windows Forms
UIElement Class Members
See Also  Fields  Properties  Methods  E-mail your feedback on this topic.
Infragistics.Win Namespace : UIElement Class


The following tables list the members exposed by UIElement.

Public Constructors

 NameDescription
public ConstructorUIElement ConstructorOverloaded.   
Top

Protected Fields

 NameDescription
protected FieldchildElementsCollection The collection of child elements  
protected FieldchildElementsCollectionDirty Indicates if the child elements for this element need to be repositioned/created  
protected FieldparentElement The parent UIElement (will be null for the ControlUIElementBase derived classes  
protected FieldrectValue The rect of this elements in client coordinates of the control  
Top

Public Properties

 NameDescription
public PropertyAccessibilityInstance Returns the accessible object associated with the element.  
public PropertyAccessibilityInstanceResolved Returns the accessible object associated with this element or one of its parent elements.  
public PropertyAdjustable Returns true is this element can be moved or resized by the user  
public PropertyBorderSides Returns flags indicating which borders will be drawn  
public PropertyBorderStyleBorderStyle of the element. UIElementBorderStyle  
public PropertyCancelCaptureOnEscape Indicates if capture for this element should be terminated if the escape key is pressed.  
public PropertyChildElements Returns the child elements array (read-only)  
public PropertyChildElementsDirty True indicates that the child elements need to be created/adjusted on the next draw operation (read-only)  
public PropertyClipRect Returns the intersection of this element's rect's with all of its parent element's rects  
public PropertyControl Walks up the parent chain until it reaches a Control element (which overrides this method)  
public PropertyControlElement Returns the top level/control element. Read-only.  
public PropertyCursor Returns 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 PropertyEnabled Gets/sets whether this element is enabled. Note: this will return false the element or any of its ancestors are disabled.  
public PropertyHasChildElements Returns true if there are any child elements (read-only)  
public PropertyIsAccessibleElement Indicates if the element supports accessibility.  
public PropertyIsDrawing True if this element is in a drawing operation (read-only).  
public PropertyIsElementDrawn True 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 PropertyIsFullyVisible Returns true if the entire elment is visible or false if any part is clipped  
public PropertyNestDepth The 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 PropertyParent The parent/containing element (will be null for a top level/control element).  
public PropertyRect The element's bounding rectangle in client coordinates  
public PropertyRectInsideBorders Returns the rectangle after adjusting for any borders  
public PropertyRegion Returns 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 PropertySelectableItem If 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 PropertyThemedElementRegion Returns the region of this element that themed drawing should be clipped to. The default implementation returns null.  
public PropertyToolTipItem Returns or sets an object that provides tooltip information for the element.  
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.  
Top

Protected Properties

 NameDescription
protected PropertyChildElementArrayCapacity Returns the expected number of child elements for this element  
protected PropertyClipChildren Returning true causes all drawing of this element's child elements to be expicitly clipped to the area inside this elements borders  
protected PropertyClipRectChildren Returns the rect inside borders as the default  
protected PropertyClipSelf Returning true causes all drawing of this element to be expicitly clipped to its region  
protected PropertyDrawsFocusRect Returns true if this element needs to draw a focus rect. This should be overridden since the default implementation always returns false.  
protected PropertyForceDrawsFocusRect Returns a boolean value indicating whether this element's focus rectangle drawing logic should ignore the associated control's focused state.  
protected PropertyHasCapture Indicates if the element has capture.  
protected PropertyInkProvider Returns the InkProvider registered for our control's container.  
protected PropertyPrimaryContext Used 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 PropertySupportsHorizontalMousePanning Gets 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 PropertySupportsVerticalMousePanning Gets 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 PropertyWantsMouseHoverNotification Return true if this element wants to be notified when the mouse hovers over it. This property is read-only.  
Top

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 MethodContainsOverloaded.  Checks if the point is over the element. This may be overridden in derived classes for specialized hit test logic.  
public MethodCreateObjRef Creates 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 MethodDrawElementRenders the element into the graphics object of the specified defaultDrawParams. This method will recursively invoke itself for rendering the descendant elements.  
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 MethodGetAdjustableCursor The 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 MethodGetAdjustmentRange Returns 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 MethodGetAncestor Walks 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 MethodGetBorderWidths Returns the widths of all four borders  
public Methodstatic (Shared in Visual Basic)GetCommonAncestor Static 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)GetDeskTopWorkArea Gets the desktop area. In a multi-monitor setup, it gets the desktop area of the monitor that most of the rect resides in.  
public MethodGetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
public MethodHasAncestor Returns 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 MethodHitTest Retrieves the child accessible object at the specified screen coordinates.  
public MethodInitializeLifetimeService Obtains 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)IsContextOfType Determines if the context is of the specified type.  
public MethodIsDescendantOf Returns 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 MethodPointInAdjustableArea Returns 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 MethodPrint Draws 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)
Top

Protected Methods

 NameDescription
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.  
protected MethodDrawBackColor Default backcolor drawing just does a FillRectangle with the backcolor.  
protected MethodDrawBorders Default border rendering  
protected MethodDrawChildElements Default child element rendering - draws each of the child elements.  
protected MethodDrawFocus Default drawfocus method draws a focus rect inside the element's borders  
protected MethodDrawForeground Default foreground rendering - does nothing  
protected MethodDrawImage Default image rendering - does nothing  
protected MethodDrawImageBackground Default background picture drawing  
protected MethodDrawTheme Used 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 MethodInitAppearance Initialize the appearance structure for this element  
protected MethodInternalCursorFromAppearance Extracts the cursor from the appearance object this method is overridden by an element with a mousepointer set  
protected MethodInternalSetElementsChanged Default 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 MethodIntersectInvalidRect Returns 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 MethodOnAfterDraw A virtual method that gets called after the element draw operation finishes.  
protected MethodOnBeforeDraw A virtual method that gets called before the element draw process starts.  
protected MethodOnDisposeOverridden.  Called when element is disposed of.  
protected MethodOnMousePanHorizontal Virtual method that is called each time the mouse pans horizontally Derived classes should override this method  
protected MethodOnMousePanVertical Virtual method that is called each time the mouse pans vertically Derived classes should override this method  
protected MethodPositionChildElements Makes 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 MethodSetParent Sets the parent element  
protected MethodWantsInputNotification Returns true if this ui element is interested in getting notificaions of type inputType at the specified location. Default implementation always returns true.  
Top

See Also