Version

TextUIElement Class Members

The following tables list the members exposed by TextUIElement.

Public Constructors
 NameDescription
Public ConstructorTextUIElement ConstructorConstructor  
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 PropertyAccessibilityInstanceReturns the accessible object associated with the element. (Inherited from Infragistics.Win.UIElement)
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 PropertyAreTouchMetricsEnabledReturns whether Touch mode is currently enabled on this control. (Inherited from Infragistics.Win.UIElement)
Public PropertyBorderSidesOverridden. Returns flags indicating which borders will be drawn  
Public PropertyBorderStyleOverridden. Returns the style of border that will be drawn.  
Public PropertyCancelCaptureOnEscapeIndicates if capture for this element should be terminated if the escape key is pressed. (Inherited from Infragistics.Win.UIElement)
Public PropertyCharactersRenderedReturns the number of characters rendered during the last draw operation. (Inherited from Infragistics.Win.TextUIElementBase)
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 PropertyControlWalks up the parent chain until it reaches a Control element (which overrides this method) (Inherited from Infragistics.Win.UIElement)
Public PropertyControlElementReturns the top level/control element. Read-only. (Inherited from Infragistics.Win.UIElement)
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 (Inherited from Infragistics.Win.UIElement)
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 PropertyEnabledGets/sets whether this element is enabled. Note: this will return false the element or any of its ancestors are disabled. (Inherited from Infragistics.Win.UIElement)
Public PropertyFirstTabOffsetThe number of spaces between the beginning of the text and the first tab stop. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyFocusableMouseButtonsControls the mouse buttons that will cause the control to take focus defaults to all. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyHasChildElementsReturns true if there are any child elements (read-only) (Inherited from Infragistics.Win.UIElement)
Public PropertyHotkeyPrefixOverridden. Indicates how mnemonics in the text are rendered.  
Public PropertyIsAccessibleElementIndicates if the element supports accessibility. (Inherited from Infragistics.Win.UIElement)
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 PropertyIsTextFullyVisibleReturns 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. (Inherited from Infragistics.Win.TextUIElementBase)
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 PropertyMultiLineOverridden. Determines if the text is displayed one one or more lines  
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 PropertyPaddingOverridden. Number of pixels in the X dimension (left/right) and the Y dimension (above/below) of extra space to leave around the text  
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 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 PropertyRectInsidePaddingThe rect inside the borders and padding (read-only) (Inherited from Infragistics.Win.TextUIElementBase)
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 PropertyRightToLeftGets a value indicating whether elements are aligned to support locales using right-to-left fonts. (Inherited from Infragistics.Win.UIElement)
Public PropertyRightToLeftResolvedReturns the resolved RightToLeft state of the element. (Inherited from Infragistics.Win.UIElement)
Public PropertyRotatedDetermines if the text should be rotated 180 degrees. (Inherited from Infragistics.Win.TextUIElementBase)
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 PropertyShouldUseTypographicFormatStringBoolean property which shows if the UIElement should use Typographic FormatString (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyTabStopsAn array of floats indicating the number of spaces between tab stops. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyTextOverridden. The text string.  
Public PropertyTextAreaWe cache a rectangle during DrawForeground that keeps track of the text area. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyTextHAlignGets/sets the horizontal text alignment  
Public PropertyTextOrientationGets or sets the text orientation to use when drawing the text. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyTextSizeReturns the cached size of the string calculated in the last DrawForeground invocation. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyTextVAlignGets/sets the vertical text alignment  
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 PropertyToolTipEnabledSpecifies whether to display the tooltip if the text element is not able to render the tooltip completely. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyToolTipItemOverridden. Returns or sets an object that provides tooltip information for the element. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyTrackCharactersRenderedGets/sets whether the element should maintain the count of characters when rendering the text. (Inherited from Infragistics.Win.TextUIElementBase)
Public PropertyTrackTextAreaSpecifies whether to track the text area (TextUIElementBase.TextArea). Default is true. (Inherited from Infragistics.Win.TextUIElementBase)
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 PropertyVerticalOverridden. Determines if the text is displayed vertically  
Public PropertyWrapTextOverridden. Determines if the text should be wrapped if it doesn't fit  
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 PropertyDelegateMousePanningToParentReturns the element which handles mouse panning for this element. (Inherited from Infragistics.Win.UIElement)
Protected PropertyDrawsBackColorDetermines if the backcolor is drawn (read-only) (Inherited from Infragistics.Win.TextUIElementBase)
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 PropertyDrawsImageBackgroundDetermines if the backgroud image is drawn (read-only) (Inherited from Infragistics.Win.TextUIElementBase)
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 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 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 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 MethodContainsOverloaded. Checks if the point is over the element. This may be overridden in derived classes for specialized hit test logic. (Inherited from Infragistics.Win.UIElement)
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. Draws the element. (Inherited from Infragistics.Win.UIElement)
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 MethodFireClickEventTriggers the ElementClick event (Inherited from Infragistics.Win.TextUIElementBase)
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. Returns an object of requested type that relates to the element or null. (Inherited from Infragistics.Win.TextUIElementBase)
Public MethodGetDescendantOverloaded. Returns an element of the requested type or null. (Inherited from Infragistics.Win.UIElement)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetLineCountReturns the total number of lines of text in the element accounting for word wrapping. (Inherited from Infragistics.Win.TextUIElementBase)
Public MethodGetLineNumberReturns the index of the line that contains the specified character index in a multiline edit control. A character index is the zero-based index of the character from the beginning of the edit control. (Inherited from Infragistics.Win.TextUIElementBase)
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 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 MethodAdjustTextDisplayRectCalled during draw so that the text rect can be adjusted. This may be needed, for example, with the text on a button that is pressed. In this case the text may be offset 1 pixel right and down. (Inherited from Infragistics.Win.TextUIElementBase)
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 MethodDrawBackColorNo background is drawn for a text element unless DrawsBackColor returns true (Inherited from Infragistics.Win.TextUIElementBase)
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 MethodDrawForegroundRender the text in the foreground (Inherited from Infragistics.Win.TextUIElementBase)
Protected MethodDrawImageDefault image rendering - does nothing (Inherited from Infragistics.Win.UIElement)
Protected MethodDrawImageBackgroundNo background is drawn for a text element unless DrawsImageBackground returns true (Inherited from Infragistics.Win.TextUIElementBase)
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  
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 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 (Inherited from Infragistics.Win.UIElement)
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 MethodOnBeforeDrawA virtual method that gets called before the element draw process starts. (Inherited from Infragistics.Win.UIElement)
Protected MethodOnDisposeCalled when element is disposed of. (Inherited from Infragistics.Win.UIElement)
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 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 MethodResetCaptureFlagsclear the internal capture flags (Inherited from Infragistics.Win.TextUIElementBase)
Protected MethodSetParentSets the parent element (Inherited from Infragistics.Win.UIElement)
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)
Public Events
 NameDescription
Public EventElementClickFired when the button is clicked (Inherited from Infragistics.Win.TextUIElementBase)
See Also