See Also

FormattedTextUIElement Class  | Infragistics.Win.FormattedLinkLabel Namespace

See Also Infragistics2.Win.v7.2

FormattedTextUIElement Class Members

Infragistics.Win.FormattedLinkLabel Namespace : FormattedTextUIElement Class

FormattedTextUIElement Overview

Public Constructors

Public Constructor FormattedTextUIElement Constructor Constructor. Initializes a new instance of FormattedTextUIElement object.

Public Properties

Public Property AccessibilityInstance (Inherited from Infragistics.Win.UIElement) Returns the accessible object associated with the element.
Public Property AccessibilityInstanceResolved (Inherited from Infragistics.Win.UIElement) Returns the accessible object associated with this element or one of its parent elements.
Public Property Adjustable (Inherited from Infragistics.Win.UIElement) Returns true is this element can be moved or resized by the user
Public Property AreLinksSupported Indicates whether links are supported by this formatted text element instance. Default implementation returns true. By default the links will be processed and opened when they are clicked. If you want to prevent that, override this and return false from this method.
Public Property BorderSides (Inherited from SectionUIElement) Overridden. Returns flags indicating which borders will be drawn
Public Property BorderStyle (Inherited from SectionUIElement) Overridden. BorderStyle of the element. UIElementBorderStyle
Public Property CancelCaptureOnEscape (Inherited from Infragistics.Win.UIElement) Indicates if capture for this element should be terminated if the escape key is pressed.
Public Property ChildElements (Inherited from Infragistics.Win.UIElement) Returns the child elements array (read-only)
Public Property ChildElementsDirty (Inherited from Infragistics.Win.UIElement) True indicates that the child elements need to be created/adjusted on the next draw operation (read-only)
Public Property ClipRect (Inherited from Infragistics.Win.UIElement) Returns the intersection of this element's rect's with all of its parent element's rects
Public Property Control (Inherited from Infragistics.Win.UIElement) Walks up the parent chain until it reaches a Control element (which overrides this method)
Public Property ControlElement (Inherited from Infragistics.Win.UIElement) Returns the top level/control element. Read-only.
Public Property Cursor (Inherited from Infragistics.Win.UIElement) 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 Property Disposed (Inherited from Infragistics.Shared.DisposableObject) 
Public Property Enabled (Inherited from Infragistics.Win.UIElement) Gets/sets whether this element is enabled. Note: this will return false the element or any of its ancestors are disabled.
Public Property HasChildElements (Inherited from Infragistics.Win.UIElement) Returns true if there are any child elements (read-only)
Public Property IsAccessibleElement (Inherited from Infragistics.Win.UIElement) Indicates if the element supports accessibility.
Public Property IsDataFullyVisible Returns whether the data this element displays is fully visible.
Public Property IsDrawing (Inherited from Infragistics.Win.UIElement) True if this element is in a drawing operation (read-only).
Public Property IsElementDrawn (Inherited from Infragistics.Win.UIElement) 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 Property IsFullyVisible (Inherited from Infragistics.Win.UIElement) Returns true if the entire elment is visible or false if any part is clipped
Public Property NestDepth (Inherited from Infragistics.Win.UIElement) 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 Property Parent (Inherited from Infragistics.Win.UIElement) The parent/containing element (will be null for a top level/control element).
Public Property Rect (Inherited from Infragistics.Win.UIElement) The element's bounding rectangle in client coordinates
Public Property RectInsideBorders (Inherited from Infragistics.Win.UIElement) Returns the rectangle after adjusting for any borders
Public Property Region (Inherited from Infragistics.Win.UIElement) 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 Property SelectableItem (Inherited from Infragistics.Win.UIElement) 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 Property ThemedElementRegion (Inherited from Infragistics.Win.UIElement) Returns the region of this element that themed drawing should be clipped to. The default implementation returns null.
Public Property ToolTipItem (Inherited from Infragistics.Win.UIElement) Returns or sets an object that provides tooltip information for the element.
Public Property UIRole (Inherited from SectionUIElement) Returns the ui role for the element.
Public Property UIRoleResolved (Inherited from Infragistics.Win.UIElement) Returns the UIRole used by this element or an element higher up the parent chain.
Public Property Value Gets or sets the value that will be rendered by this ui element.
Public Property WrapText Specifies whether to wrap the text or not.

Public Methods

Public Method AdjustableElementFromPoint (Inherited from Infragistics.Win.UIElement)Overloaded.  Returns an element reference if the passed in point is over the AdjustableArea of this element (or any of its child elements)
Public Method Contains (Inherited from Infragistics.Win.UIElement)Overloaded.  Checks if the point is over the element. This may be overridden in derived classes for specialized hit test logic.
Public Method CreateObjRef (Inherited from System.MarshalByRefObject)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Public Method DirtyChildElements (Inherited from Infragistics.Win.UIElement)Overloaded.  Sets the dirty flag so that the next time the element is drawn it will reposition its child elements
Public Method Dispose (Inherited from Infragistics.Shared.DisposableObject) 
Public Method DrawElement (Inherited from Infragistics.Win.UIElement) Renders the element into the graphics object of the specified defaultDrawParams. This method will recursively invoke itself for rendering the descendant elements.
Public Method ElementFromPoint (Inherited from Infragistics.Win.UIElement)Overloaded.  Returns the lowest level element that contains the passed in point
Public Method GetAdjustableCursor (Inherited from Infragistics.Win.UIElement) 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 Method GetAdjustmentRange (Inherited from Infragistics.Win.UIElement) 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 Method GetAncestor (Inherited from Infragistics.Win.UIElement) 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 Method GetBorderWidths (Inherited from Infragistics.Win.UIElement) Returns the widths of all four borders
Public Method GetContext (Inherited from Infragistics.Win.UIElement)Overloaded.  Returns the primary context object.
Public Method GetDescendant (Inherited from Infragistics.Win.UIElement)Overloaded.  Returns an element of the requested type or null.
Public Method GetLifetimeService (Inherited from System.MarshalByRefObject)Retrieves the current lifetime service object that controls the lifetime policy for this instance.
Public Method HasAncestor (Inherited from Infragistics.Win.UIElement) Returns true if the passed in element is in this elment's parent chain
Public Method HasContext (Inherited from Infragistics.Win.UIElement)Overloaded.  Returns true if this element (or any of its ancestors) has this context
Public Method HitTest (Inherited from Infragistics.Win.UIElement) Retrieves the child accessible object at the specified screen coordinates.
Public Method InitializeLifetimeService (Inherited from System.MarshalByRefObject)Obtains a lifetime service object to control the lifetime policy for this instance.
Public Method Invalidate (Inherited from Infragistics.Win.UIElement)Overloaded.  Invalidates this element
Public Method IsDescendantOf (Inherited from Infragistics.Win.UIElement) Returns true if this element is the same as the specified element or if this element is a descendant of the specified element.
Public Method Navigate (Inherited from Infragistics.Win.UIElement)Overloaded.  Navigates to another accessible object
Public Method Offset (Inherited from Infragistics.Win.UIElement)Overloaded.  Offsets this element rect and all of its child elements
Public Method PointInAdjustableArea (Inherited from Infragistics.Win.UIElement) Returns true if the passed in point is over an area of this element that would require the AdjustableCursor to be displayed
Public Method PointInElement (Inherited from Infragistics.Win.UIElement)Overloaded.  Checks if the point is over the element and is not over an overlapping sibling element.
Public Method Print (Inherited from Infragistics.Win.UIElement) Draws the element into a printer dc.
Public Method VerifyChildElements (Inherited from Infragistics.Win.UIElement)Overloaded.  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 Method VerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject) 

Protected Fields

Protected Field childElementsCollection (Inherited from Infragistics.Win.UIElement) The collection of child elements
Protected Field childElementsCollectionDirty (Inherited from Infragistics.Win.UIElement) Indicates if the child elements for this element need to be repositioned/created
Protected Field parentElement (Inherited from Infragistics.Win.UIElement) The parent UIElement (will be null for the ControlUIElementBase derived classes
Protected Field rectValue (Inherited from Infragistics.Win.UIElement) The rect of this elements in client coordinates of the control

Protected Properties

Protected Property ChildElementArrayCapacity (Inherited from Infragistics.Win.UIElement) Returns the expected number of child elements for this element
Protected Property ClipChildren (Inherited from BlockUIElement) Overridden. Returns true to indicate that the children should to be clipped.
Protected Property ClipRectChildren (Inherited from Infragistics.Win.UIElement) Returns the rect inside borders as the default
Protected Property ClipSelf (Inherited from Infragistics.Win.UIElement) Returning true causes all drawing of this element to be expicitly clipped to its region
Protected Property DrawsFocusRect (Inherited from Infragistics.Win.UIElement) Returns true if this element needs to draw a focus rect. This should be overridden since the default implementation always returns false.
Protected Property GdiDrawStringFlags  
Protected Property HasCapture (Inherited from Infragistics.Win.UIElement) Indicates if the element has capture.
Protected Property InkProvider (Inherited from Infragistics.Win.UIElement) Returns the InkProvider registered for our control's container.
Protected Property PrimaryContext (Inherited from Infragistics.Win.UIElement) 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 Property SupportsHorizontalMousePanning (Inherited from Infragistics.Win.UIElement) 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 Property SupportsVerticalMousePanning (Inherited from Infragistics.Win.UIElement) 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 Property WantsMouseHoverNotification (Inherited from Infragistics.Win.UIElement) Return true if this element wants to be notified when the mouse hovers over it. This property is read-only.

Protected Methods

Protected Method ContinueDescendantSearch (Inherited from Infragistics.Win.UIElement) This method is called from UIElement.GetDescendant(Type) as an optimization to prevent searching down element paths that can't possibly contain the element that is being searched for.
Protected Method DrawBackColor (Inherited from SectionUIElement) Overridden.
Protected Method DrawBorders (Inherited from Infragistics.Win.UIElement) Default border rendering
Protected Method DrawChildElements Overridden.  Overridden.
Protected Method DrawFocus (Inherited from Infragistics.Win.UIElement) Default drawfocus method draws a focus rect inside the element's borders
Protected Method DrawForeground (Inherited from Infragistics.Win.UIElement) Default foreground rendering - does nothing
Protected Method DrawImage (Inherited from Infragistics.Win.UIElement) Default image rendering - does nothing
Protected Method DrawImageBackground (Inherited from SectionUIElement) Overridden. Does nothing.
Protected Method DrawTheme (Inherited from Infragistics.Win.UIElement) Used by an element to render using the system theme. This method will not be invoked if the themes are not supported.
Protected Method GetComponentRole (Inherited from Infragistics.Win.UIElement) Returns the component role that the element should be using to obtain its role information.
Protected Method GetUIRole (Inherited from Infragistics.Win.UIElement) Helper method for obtaining a UIRole for a particular role name.
Protected Method InitAppearance Overridden.  Overridden. Initializes the appearance.
Protected Method InitCustomAppearance This method is called to resolve custom area appearance. CustomArea parameter will be one of "Link", "ActiveLink", "HotTrackedLink" and "VisitedLink". The default implementation does nothing.
Protected Method InternalCursorFromAppearance (Inherited from Infragistics.Win.UIElement) Extracts the curosr from the appearance object this method is overridden by an element with a mousepointer set
Protected Method InternalSetElementsChanged (Inherited from Infragistics.Win.UIElement) 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 Method IntersectInvalidRect (Inherited from Infragistics.Win.UIElement) Returns the intersection of the element's rect with the invalid rect for the current draw operation.
Protected Method MemberwiseClone (Inherited from System.MarshalByRefObject)Overloaded. Creates a shallow copy of the current MarshalByRefObject object.
Protected Method OnAfterDraw Overridden.  A virtual method that gets called after the element draw operation finishes.
Protected Method OnBeforeDraw (Inherited from Infragistics.Win.UIElement) A virtual method that gets called before the element draw process starts.
Protected Method OnCaptureAborted (Inherited from Infragistics.Win.UIElement) Called when mouse capture has been aborted, for example, when the 'escape' key is pressed during a drag operation.
Protected Method OnClick Overridden.  Overridden.
Protected Method OnDispose (Inherited from Infragistics.Win.UIElement) Called when element is disposed of.
Protected Method OnDoubleClick Overridden.  Overridden.Called when the mouse is double clicked on this element. The default implementatiun just walks up the parent element chain.
Protected Method OnLinkClicked Called when a link is clicked. This method will not be called if AreLinksSupported method returns false. You can override this method to handle link using custom logic.
Protected Method OnMouseDown Overridden.  Called when the mouse down message is received over the element.
Protected Method OnMouseEnter (Inherited from Infragistics.Win.UIElement) Called when the mouse enters this element
Protected Method OnMouseHover (Inherited from Infragistics.Win.UIElement) Called when the mouse hovers over an element.
Protected Method OnMouseLeave Overridden.  Called when the mouse leaves this element
Protected Method OnMouseMove Overridden.  Overridden. Called on a mouse move message
Protected Method OnMousePanHorizontal (Inherited from Infragistics.Win.UIElement) Virtual method that is called each time the mouse pans horizontally Derived classes should override this method
Protected Method OnMousePanVertical (Inherited from Infragistics.Win.UIElement) Virtual method that is called each time the mouse pans vertically Derived classes should override this method
Protected Method OnMouseUp Overridden.  Called when the mouse down message is received over the element.
Protected Method PositionChildElements Overridden.  Overridden. Creates and positions the child elements.
Protected Method SetParent (Inherited from Infragistics.Win.UIElement) Sets the parent element
Protected Method WantsInputNotification (Inherited from Infragistics.Win.UIElement) Returns true if this ui element is interested in getting notificaions of type inputType at the specified location. Default implementation always returns true.

See Also

FormattedTextUIElement Class  | Infragistics.Win.FormattedLinkLabel Namespace

E-mail your feedback on this topic.

Opinion about our help? Take our survey.

Copyright © 1996-2007 Infragistics, Inc. All rights reserved.

Build Version: 7.2.20072.1063