Class RadElement

Represents the fundamental building block of the Telerik Presentation Framework (TPF), serving as the base class for all visual and logical elements that compose Telerik controls.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
LayoutPanel
MentionBoxPicker
AlertWindowCaptionElement
PivotRowElement
RadApplicationMenuContentElement
RadApplicationMenuDropDownElement
RadCanvasViewport
TransparentColorBoxElement
RadDropDownMenuElement
RadGripElement
RadPageViewContentElement
StepItemsContainer
TextBoxControlCaret
BaseVirtualKeyboardLayout
VisualElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls
Assembly: Telerik.WinControls.dll

Syntax

public class RadElement : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode
Remarks

RadElement is the cornerstone of the TPF architecture, providing the foundation for all user interface elements in Telerik WinControls. Every Telerik control is built as a hierarchical tree of RadElement objects, with the RootElement at the top and various child elements forming the visual and logical structure.

Elements participate in a comprehensive property system with inheritance, event routing through the tree, layout participation with measure/arrange phases, and integration with themes and styling. The framework supports primitive elements for rendering (text, borders, fills) and layout panels for arranging children.

All RadElement property changes trigger the OnPropertyChanged(RadPropertyChangedEventArgs) method, enabling reactive behavior and coordinated updates throughout the element hierarchy. This forms the foundation for VisualElement (visual properties), RadItem (interaction), and primitive elements.

Constructors

RadElement()

Declaration
public RadElement()

Fields

AlignmentProperty

Declaration
public static RadProperty AlignmentProperty
Field Value
RadProperty

AngleTransformProperty

Declaration
public static RadProperty AngleTransformProperty
Field Value
RadProperty

AutoSizeModeProperty

Declaration
public static RadProperty AutoSizeModeProperty
Field Value
RadProperty

AutoSizeProperty

Declaration
public static RadProperty AutoSizeProperty
Field Value
RadProperty

BackgroundShapePaintModeProperty

Declaration
public static RadProperty BackgroundShapePaintModeProperty
Field Value
RadProperty

BackgroundShapeProperty

Declaration
public static RadProperty BackgroundShapeProperty
Field Value
RadProperty

BorderThicknessProperty

Declaration
public static RadProperty BorderThicknessProperty
Field Value
RadProperty

BoundsChangedEvent

Tunnels when bounds changed in order to notify any children that should take special actions in this case - like RadHostItem.

Declaration
public static RoutedEvent BoundsChangedEvent
Field Value
RoutedEvent

BoundsProperty

Declaration
public static RadProperty BoundsProperty
Field Value
RadProperty

CanFocusProperty

Declaration
public static RadProperty CanFocusProperty
Field Value
RadProperty

ChildElementAddedEvent

Routed event key for ChildElementAdded event. Bubbles when element is added

Declaration
public static RoutedEvent ChildElementAddedEvent
Field Value
RoutedEvent

ClassProperty

Declaration
public static RadProperty ClassProperty
Field Value
RadProperty

ClickModeProperty

Declaration
public static RadProperty ClickModeProperty
Field Value
RadProperty

ClipDrawingProperty

Declaration
public static RadProperty ClipDrawingProperty
Field Value
RadProperty

ContainsFocusProperty

Declaration
public static RadProperty ContainsFocusProperty
Field Value
RadProperty

ContainsMouseProperty

Declaration
public static RadProperty ContainsMouseProperty
Field Value
RadProperty

ControlChangedEvent

Tunnels when the winforms control has been changed.

Declaration
public static RoutedEvent ControlChangedEvent
Field Value
RoutedEvent

EnabledChangedEvent

Tunnels when the Enabled property changes in order to notify any children that should take special actions.

Declaration
public static RoutedEvent EnabledChangedEvent
Field Value
RoutedEvent

EnabledProperty

Declaration
public static RadProperty EnabledProperty
Field Value
RadProperty

FitToSizeModeProperty

Declaration
public static RadProperty FitToSizeModeProperty
Field Value
RadProperty

GetPropertyValueCommand

Declaration
public static readonly GetPropertyValueCommand GetPropertyValueCommand
Field Value
GetPropertyValueCommand

IsEditedInSpyProperty

Used by RadControlSpy to display certain hidden properties in the Property Grid.

Declaration
public static RadProperty IsEditedInSpyProperty
Field Value
RadProperty

IsFocusedProperty

Declaration
public static RadProperty IsFocusedProperty
Field Value
RadProperty

IsItemFocusedProperty

Declaration
public static RadProperty IsItemFocusedProperty
Field Value
RadProperty

IsMouseDownProperty

Declaration
public static RadProperty IsMouseDownProperty
Field Value
RadProperty

IsMouseOverElementProperty

Declaration
public static RadProperty IsMouseOverElementProperty
Field Value
RadProperty

IsMouseOverProperty

Declaration
public static RadProperty IsMouseOverProperty
Field Value
RadProperty

MarginProperty

Declaration
public static RadProperty MarginProperty
Field Value
RadProperty

MaxSizeProperty

Get or sets the maximum size to apply on an element when layout is calculated.

Declaration
public static RadProperty MaxSizeProperty
Field Value
RadProperty

MinSizeProperty

Declaration
public static RadProperty MinSizeProperty
Field Value
RadProperty

MouseClickedEvent

Tunnels and bubbles on MouseClick on current element

Declaration
public static RoutedEvent MouseClickedEvent
Field Value
RoutedEvent

MouseDoubleClickedEvent

Tunnels and bubbles on MouseDoubleClick on current element

Declaration
public static RoutedEvent MouseDoubleClickedEvent
Field Value
RoutedEvent

MouseDownEvent

Tunnels and bubbles on MouseDown on current element

Declaration
public static RoutedEvent MouseDownEvent
Field Value
RoutedEvent

MouseUpEvent

Tunnels and bubbles on MouseUp on current element

Declaration
public static RoutedEvent MouseUpEvent
Field Value
RoutedEvent

MouseWheelEvent

Tunnels and bubbles on MouseWheel on current element

Declaration
public static RoutedEvent MouseWheelEvent
Field Value
RoutedEvent

NameProperty

Declaration
public static RadProperty NameProperty
Field Value
RadProperty

PaddingProperty

Declaration
public static RadProperty PaddingProperty
Field Value
RadProperty

paintSystemSkin

Declaration
protected bool? paintSystemSkin
Field Value
System.Nullable<System.Boolean>

ParentChangedEvent

Routed event key for ParentChanged event. Tunnels when element parent changes

Declaration
public static RoutedEvent ParentChangedEvent
Field Value
RoutedEvent

PositionOffsetProperty

Declaration
public static RadProperty PositionOffsetProperty
Field Value
RadProperty

RadElementLastStateKey

This constant is used internally.

Declaration
protected const long RadElementLastStateKey = 68719476736L
Field Value
System.Int64

RightToLeftProperty

Declaration
public static RadProperty RightToLeftProperty
Field Value
RadProperty

ScaleTransformProperty

Declaration
public static RadProperty ScaleTransformProperty
Field Value
RadProperty

SetPropertyValueCommand

Declaration
public static readonly SetPropertyValueCommand SetPropertyValueCommand
Field Value
SetPropertyValueCommand

ShapeProperty

Declaration
public static RadProperty ShapeProperty
Field Value
RadProperty

ShouldPaintProperty

Declaration
public static readonly RadProperty ShouldPaintProperty
Field Value
RadProperty

StretchHorizontallyProperty

Declaration
public static readonly RadProperty StretchHorizontallyProperty
Field Value
RadProperty

StretchVerticallyProperty

Declaration
public static readonly RadProperty StretchVerticallyProperty
Field Value
RadProperty

StyleProperty

Declaration
public static RadProperty StyleProperty
Field Value
RadProperty

styleVersion

Declaration
protected int styleVersion
Field Value
System.Int32

TagProperty

Declaration
public static readonly RadProperty TagProperty
Field Value
RadProperty

TraceInvalidation

This field is used internally.

Declaration
public static bool TraceInvalidation
Field Value
System.Boolean

UseCompatibleTextRenderingProperty

Declaration
public static RadProperty UseCompatibleTextRenderingProperty
Field Value
RadProperty

VisibilityChangingEvent

Tunnels and bubbles when changes the current element

Declaration
public static RoutedEvent VisibilityChangingEvent
Field Value
RoutedEvent

VisibilityProperty

Declaration
public static RadProperty VisibilityProperty
Field Value
RadProperty

ZIndexProperty

Property key of the ZIndex Property.

Declaration
public static RadProperty ZIndexProperty
Field Value
RadProperty

Properties

Alignment

Gets or sets the preferred location of the element if its size is less than its parent size.

Declaration
[RadPropertyDefaultValue("Alignment", typeof(RadElement))]
public virtual ContentAlignment Alignment { get; set; }
Property Value
System.Drawing.ContentAlignment

AngleTransform

Gets or sets the rotation transform angle used when painting the element and its children.

Declaration
[RadPropertyDefaultValue("AngleTransform", typeof(RadElement))]
public virtual float AngleTransform { get; set; }
Property Value
System.Single

ArrangeInProgress

This property is used internally!

Declaration
public bool ArrangeInProgress { get; set; }
Property Value
System.Boolean

ArrangeIsDirty

This property is used internally!

Declaration
public bool ArrangeIsDirty { get; set; }
Property Value
System.Boolean

AutoNumberKeyTip

Declaration
protected virtual int AutoNumberKeyTip { get; set; }
Property Value
System.Int32

AutoSize

Gets or sets a value indicating whether the element size will be calculated automatically by the layout system. Value of false indicates that the element's size will not be changed when calculating the layout.

Declaration
[RadPropertyDefaultValue("AutoSize", typeof(RadElement))]
public virtual bool AutoSize { get; set; }
Property Value
System.Boolean

AutoSizeMode

Gets or sets the way the element should calculate its Size, when the AutoSize property is set to true.

Declaration
[RadPropertyDefaultValue("AutoSizeMode", typeof(RadElement))]
public virtual RadAutoSizeMode AutoSizeMode { get; set; }
Property Value
RadAutoSizeMode

AutoToolTip

Declaration
public virtual bool AutoToolTip { get; set; }
Property Value
System.Boolean

BackgroundShape

Gets or sets the RadImageShape that describes the background of the element.

Declaration
[VsbBrowsable(true)]
public RadImageShape BackgroundShape { get; set; }
Property Value
RadImageShape

BackgroundShapePaintMode

Gets or sets a value indiicating when to paint the BackgroundShape.

Declaration
[VsbBrowsable(true)]
public BackgroundShapePaintMode BackgroundShapePaintMode { get; set; }
Property Value
BackgroundShapePaintMode

BorderThickness

Gets or sets the border thickness of the element. This thickness is included into the element's bounding rectangle.

Declaration
[RadPropertyDefaultValue("BorderThickness", typeof(RadElement))]
public virtual Padding BorderThickness { get; set; }
Property Value
System.Windows.Forms.Padding

BoundingRectangle

Represents the rectangle which surrounds the element bounds after the rotation caused by setting the AngleTransform property to some degree. The rectangle is in parent element's coordinates.

Declaration
public virtual Rectangle BoundingRectangle { get; }
Property Value
System.Drawing.Rectangle

Bounds

Gets or sets a value corresponding to the bounding rectangle of the element. Location and/or Size portions of the bounds may be calculated automatically based on the current AutoSize and AutoSizeMode settings.

Declaration
[RadPropertyDefaultValue("Bounds", typeof(RadElement))]
public virtual Rectangle Bounds { get; set; }
Property Value
System.Drawing.Rectangle

BypassLayoutPolicies

Declaration
public bool BypassLayoutPolicies { get; set; }
Property Value
System.Boolean

CanFocus

Gets or sets a value indicating whether the element can receive input focus.

Declaration
[RadPropertyDefaultValue("CanFocus", typeof(RadElement))]
public virtual bool CanFocus { get; set; }
Property Value
System.Boolean

CanHaveOwnStyle

Gets a value indicating whether the element can have its own style with style conditions.

Declaration
public virtual bool CanHaveOwnStyle { get; }
Property Value
System.Boolean

Capture

Declaration
public bool Capture { get; set; }
Property Value
System.Boolean

CaptureOnMouseDown

Determines whether mouse will be captured upon MouseDown event.

Declaration
public bool CaptureOnMouseDown { get; set; }
Property Value
System.Boolean

Children

Gets the collection of elements that are child elements in the element tree.

Declaration
public virtual RadElementCollection Children { get; }
Property Value
RadElementCollection

ChildrenHierarchy

Enumerates entire subtree of elements (using depth-first approach), starting from this one as a root.

Declaration
public IEnumerable<RadElement> ChildrenHierarchy { get; }
Property Value
System.Collections.Generic.IEnumerable<RadElement>

Class

Gets or sets a string value indicating the element visual class name. It's used when a stylesheet has been applied to this element.

Declaration
[RadPropertyDefaultValue("Class", typeof(RadElement))]
[StyleBuilderReadOnly]
public string Class { get; set; }
Property Value
System.String

Remarks

Style sheets contain groups of property settings categorized by element type and/or class, thus element "class" is used to determine whether certain style rule would be applied over an element. Generally this property is assigned by the control developer but it can be changed design time or runtime if certain element is decided to have different style class.

ClickMode

Specifies when the Click event should fire.

Declaration
[RadPropertyDefaultValue("ClickMode", typeof(RadElement))]
public ClickMode ClickMode { get; set; }
Property Value
ClickMode

ClipDrawing

Indicates whether the painting of the element and its children should be restricted to its bounds.

Declaration
[RadPropertyDefaultValue("ClipDrawing", typeof(RadElement))]
public bool ClipDrawing { get; set; }
Property Value
System.Boolean

ContainsFocus

Determines whether the element or one of its descendants currently contains the keyboard focus.

Declaration
public bool ContainsFocus { get; }
Property Value
System.Boolean

ContainsMouse

Determines whether the element or one of its descendants currently contains the mouse.

Declaration
public bool ContainsMouse { get; set; }
Property Value
System.Boolean

ControlBoundingRectangle

Represents the rectangle which surrounds the element bounds after the rotation caused by setting the AngleTransform property to some degree. The rectangle is in control coordinates.

Declaration
public virtual Rectangle ControlBoundingRectangle { get; }
Property Value
System.Drawing.Rectangle

DesiredSize

Gets the element desired size.

Declaration
public SizeF DesiredSize { get; }
Property Value
System.Drawing.SizeF

DoubleClickEnabled

Gets or sets a value indicating whether the DoubleClick event will fire for this item.

Declaration
public virtual bool DoubleClickEnabled { get; set; }
Property Value
System.Boolean

DpiScaleFactor

Gets or sets the DPI scale factor for the element.

Declaration
public SizeF DpiScaleFactor { get; protected set; }
Property Value
System.Drawing.SizeF

ElementState

Gets the current state of the element.

Declaration
public ElementState ElementState { get; }
Property Value
ElementState

ElementTree

Gets a reference to the tree object, that contains information about the scene where the element is currently visualized.

Declaration
public virtual ComponentThemableElementTree ElementTree { get; }
Property Value
ComponentThemableElementTree

Enabled

Gets or sets a value indicating whether the element can respond to user interaction.

Declaration
[RadPropertyDefaultValue("Enabled", typeof(RadElement))]
public virtual bool Enabled { get; set; }
Property Value
System.Boolean

Remarks

By default, if element is currently selected when Enabled set to false, next element would be selected. Values inherits from Parent.Enabled. When a scrollable control is disabled, the scroll bars are also disabled. For example, a disabled multiline textbox is unable to scroll to display all the lines of text.

FitToSizeMode

Gets or sets a value indicating the way element will fill its available size when parent element is calculating element size and location.

Declaration
[RadPropertyDefaultValue("FitToSizeMode", typeof(RadElement))]
public virtual RadFitToSizeMode FitToSizeMode { get; set; }
Property Value
RadFitToSizeMode

HideFromElementHierarchyEditor

This property is used internally!

Declaration
public bool HideFromElementHierarchyEditor { get; set; }
Property Value
System.Boolean

InvalidateChildrenOnChildChanged

Provide for use within TelerikLayoutEngine.

Declaration
public virtual bool InvalidateChildrenOnChildChanged { get; set; }
Property Value
System.Boolean

InvalidateMeasureOnRemove

This property is used internally!

Declaration
public bool InvalidateMeasureOnRemove { get; set; }
Property Value
System.Boolean

IsAbleToRespondToMouseEvents

Gets a value indicating whether the element can respond to mouse input and has input focus.

Declaration
protected bool IsAbleToRespondToMouseEvents { get; }
Property Value
System.Boolean

IsArrangeValid

Declaration
public bool IsArrangeValid { get; }
Property Value
System.Boolean

IsElementVisible

Gets a value indicating if the element is visible.

Declaration
public virtual bool IsElementVisible { get; }
Property Value
System.Boolean

IsFocusable

This property is used internally!

Declaration
public virtual bool IsFocusable { get; set; }
Property Value
System.Boolean

IsFocused

Gets a value indicating whether the element has input focus.

Declaration
public bool IsFocused { get; }
Property Value
System.Boolean

IsItemHovered

Declaration
protected virtual bool IsItemHovered { get; }
Property Value
System.Boolean

IsLayoutSuspended

Gets a value indicating whether the layout is suspended or not.

Declaration
public bool IsLayoutSuspended { get; }
Property Value
System.Boolean

IsMeasureValid

Declaration
public bool IsMeasureValid { get; }
Property Value
System.Boolean

IsMouseDown

Gets or sets a value indicating whether the mouse button has been pressed when inside the bounds of the element.

Declaration
public bool IsMouseDown { get; set; }
Property Value
System.Boolean

IsMouseOver

Gets or sets a value indicating whether the mouse has entered the bounds of the element or any of its sibling elements in the parent RadItem.

Declaration
public bool IsMouseOver { get; set; }
Property Value
System.Boolean

IsMouseOverElement

Gets or sets a value indicating whether the mouse has entered the bounds of the element.

Declaration
public bool IsMouseOverElement { get; set; }
Property Value
System.Boolean

IsThemeApplied

Gets a value indicating if theme finished applying

Declaration
public bool IsThemeApplied { get; }
Property Value
System.Boolean

LayoutableChildrenCount

Gets the count of all elements, which visibility is not Collapsed.

Declaration
public int LayoutableChildrenCount { get; }
Property Value
System.Int32

LayoutManager

Gets the layout manager of the element. Will be null until the element is loaded on a visual scene.

Declaration
public ILayoutManager LayoutManager { get; }
Property Value
ILayoutManager

Location

Gets or sets the location of the element based on the element parent rectangle. Corresponds to Bounds.Location

Declaration
public virtual Point Location { get; set; }
Property Value
System.Drawing.Point

Margin

Gets or sets a value corresponding to the margins of the element. Margins are not included into the element's bounding rectangle.

Declaration
[RadPropertyDefaultValue("Margin", typeof(RadElement))]
public virtual Padding Margin { get; set; }
Property Value
System.Windows.Forms.Padding

MaxSize

Get or sets the maximum size to apply on an element when layout is calculated.

Declaration
[RadPropertyDefaultValue("MaxSize", typeof(RadElement))]
public virtual Size MaxSize { get; set; }
Property Value
System.Drawing.Size

MeasureInProgress

This property is used internally!

Declaration
public bool MeasureInProgress { get; set; }
Property Value
System.Boolean

MeasureIsDirty

This property is used internally!

Declaration
public bool MeasureIsDirty { get; set; }
Property Value
System.Boolean

MinSize

Get or sets the minimum size to apply on an element when layout is calculated.

Declaration
[RadPropertyDefaultValue("MinSize", typeof(RadElement))]
public virtual Size MinSize { get; set; }
Property Value
System.Drawing.Size

Name

Represents the element unique name.

Declaration
[RadPropertyDefaultValue("Name", typeof(RadElement))]
[StyleBuilderReadOnly]
public virtual string Name { get; set; }
Property Value
System.String

NeverArranged

This property is used internally!

Declaration
public bool NeverArranged { get; set; }
Property Value
System.Boolean

NeverMeasured

This property is used internally!

Declaration
public bool NeverMeasured { get; set; }
Property Value
System.Boolean

NotifyParentOnMouseInput

Gets or sets a value indicating whether the element should pass the handled mouse event to the first parent element which has the ShouldHandleMouseInput property set to true.

Declaration
public virtual bool NotifyParentOnMouseInput { get; set; }
Property Value
System.Boolean

Padding

Gets or sets the padding sizes of the element. The paddings are included into the element's bounding rectangle.

Declaration
[RadPropertyDefaultValue("Padding", typeof(RadElement))]
public virtual Padding Padding { get; set; }
Property Value
System.Windows.Forms.Padding

Parent

Gets a reference to the parent element in the visual element tree.

Declaration
public RadElement Parent { get; }
Property Value
RadElement

PositionOffset

Gets or sets the offset of the origin of the coordinate system used when painting the element and its children.

Declaration
[RadPropertyDefaultValue("PositionOffset", typeof(RadElement))]
public virtual SizeF PositionOffset { get; set; }
Property Value
System.Drawing.SizeF

Remarks

TrnslateTransform of the graphics is used prior to painting the element and after painting element children, to reset the transformation

PreviousArrangeRect

This property is used internally.

Declaration
public RectangleF PreviousArrangeRect { get; }
Property Value
System.Drawing.RectangleF

PreviousConstraint

Declaration
public SizeF PreviousConstraint { get; }
Property Value
System.Drawing.SizeF

PropagateStyleToChildren

Defines whether stylesheet rules should be applied for this element and its children, or only for this element

Declaration
public virtual bool PropagateStyleToChildren { get; }
Property Value
System.Boolean

RenderingMaxFramerate

Gets or sets a value indicating maximum rendered frames per second.

Declaration
public static int RenderingMaxFramerate { get; set; }
Property Value
System.Int32

RightToLeft

Gets or sets the direction of flow of the elements and whether elements are aligned to support locales using right-to-left fonts.

Declaration
[RadPropertyDefaultValue("RightToLeft", typeof(RadElement))]
public virtual bool RightToLeft { get; set; }
Property Value
System.Boolean

RoutedEventBehaviors

Gets the routed event behaviors collection for this element.

Declaration
public RoutedEventBehaviorCollection RoutedEventBehaviors { get; }
Property Value
RoutedEventBehaviorCollection

ScaleTransform

Gets or sets a value indicating the scale transform factors, when painting the element and its children.

Declaration
[RadPropertyDefaultValue("ScaleTransform", typeof(RadElement))]
public virtual SizeF ScaleTransform { get; set; }
Property Value
System.Drawing.SizeF

ScreenTip

Declaration
public virtual RadScreenTipElement ScreenTip { get; set; }
Property Value
RadScreenTipElement

SerializeChildren

Gets or sets whether the children of this element should be serialized

Declaration
public virtual bool SerializeChildren { get; set; }
Property Value
System.Boolean

SerializeElement

Gets or sets whether the element should be serialized in designer

Declaration
public virtual bool SerializeElement { get; set; }
Property Value
System.Boolean

SerializeProperties

Gets or sets whether the properties of this element should be serialized

Declaration
public virtual bool SerializeProperties { get; set; }
Property Value
System.Boolean

Shape

Gets or sets an instance of the Shape object of an element. The shape of the element is both responsible for clipping the element's children and for providing its' border(s) with custom shape.

Declaration
[RadPropertyDefaultValue("Shape", typeof(RadElement))]
public virtual ElementShape Shape { get; set; }
Property Value
ElementShape

Remarks

Value of null (or Nothing in VisualBasic.Net) indicates that element has rectangular (or no) shape. Shape is an object that defines the bounding graphics path of an element. Graphics clip is always applied when an element has shape. Shape is considered when painting the border element, and when hit-testing an element. Some predefined shapes are available, like RoundRectShape or EllipseShape. CustomShape offers a way to specify element's shape with a sequence of points and curves using code or the design time ElementShapeEditor System.Drawing.Design.UITypeEditor.

ShouldApplyTheme

Gets a value indicating if a theme should be applied

Declaration
public virtual bool ShouldApplyTheme { get; set; }
Property Value
System.Boolean

ShouldHandleMouseInput

Specifies whether the Item should handle MouseOver, MouseMove and related mouse events.

Declaration
public virtual bool ShouldHandleMouseInput { get; set; }
Property Value
System.Boolean

Remarks

By default only elements that inherit RadItem can process mouse input.

ShouldPaint

Gets or sets a value indicating whether the element should be painted.

Declaration
[RadPropertyDefaultValue("ShouldPaint", typeof(RadElement))]
public virtual bool ShouldPaint { get; set; }
Property Value
System.Boolean

Remarks

Children visibility is not be affected.

ShouldPaintChildren

This property is used internally!

Declaration
public bool ShouldPaintChildren { get; set; }
Property Value
System.Boolean

ShouldPaintUsingParentShape

Declaration
protected virtual bool ShouldPaintUsingParentShape { get; }
Property Value
System.Boolean

Size

Gets or sets the size of the element which is the height and width of the visual rectangle that would contain the graphics of the element. Size corresponds to element's Bounds.Size. When the AutoSize property is set to true setting the Size property to some value has no effect.

Declaration
public virtual Size Size { get; set; }
Property Value
System.Drawing.Size

StretchHorizontally

Declaration
[RadPropertyDefaultValue("StretchHorizontally", typeof(RadElement))]
public virtual bool StretchHorizontally { get; set; }
Property Value
System.Boolean

StretchVertically

Declaration
[RadPropertyDefaultValue("StretchVertically", typeof(RadElement))]
public virtual bool StretchVertically { get; set; }
Property Value
System.Boolean

Style

Gets or sets the stylesheet associated with the element.

Declaration
public StyleSheet Style { get; set; }
Property Value
StyleSheet

Implements
Remarks

Stylesheets provide dynamic property settings for elements' RadProperties organized into groups, each regarding a certain state of the element. State means a property has certain value. Style of an element can affect also element children. Generally element style is set through control theme, which is a holder for various styles for many controls.

Tag

Declaration
public object Tag { get; set; }
Property Value
System.Object

ThemeEffectiveType

Declaration
protected virtual Type ThemeEffectiveType { get; }
Property Value
System.Type

ToolTipText

Declaration
public virtual string ToolTipText { get; set; }
Property Value
System.String

TotalTransform

Declaration
public RadMatrix TotalTransform { get; }
Property Value
RadMatrix

Transform

Declaration
public RadMatrix Transform { get; }
Property Value
RadMatrix

TreeLevel

Gets the level of this element in the ElementTree it currently resides.

Declaration
public byte TreeLevel { get; }
Property Value
System.Byte

UseCenteredAngleTransform

Gets a value indicating whether the AngleTransform should use the center of the object as origin for the transformation.

Declaration
public bool UseCenteredAngleTransform { get; set; }
Property Value
System.Boolean

UseCompatibleTextRendering

Determines whether to use compatible text rendering engine (GDI+) or not (GDI).

Declaration
[RadPropertyDefaultValue("UseCompatibleTextRendering", typeof(RadElement))]
public virtual bool UseCompatibleTextRendering { get; set; }
Property Value
System.Boolean

UseSystemSkin

Gets or sets the mode that describes the usage of system skinning (if available).

Declaration
public virtual UseSystemSkinMode UseSystemSkin { get; set; }
Property Value
UseSystemSkinMode

Implements

Visibility

Gets or sets a value indicating element visibility.

Declaration
[RadPropertyDefaultValue("Visibility", typeof(RadElement))]
public virtual ElementVisibility Visibility { get; set; }
Property Value
ElementVisibility

Remarks

Setting this property affects also the children of the element. Collapsed means the element and its children would not be painted and would not be calculated in the layout. This property has no effect in design-time on objects.

VsbVisible

Determines whether the element may be added associated with metadata in the Visual Style Builder.

Declaration
public virtual bool VsbVisible { get; }
Property Value
System.Boolean

ZIndex

Gets of sets the order of painting an element compared to its sibling elements. Greater ZIndex means an element would be painted on top of other elements amongst its siblings. ZIndex changes the order of the elements in the list returned by GetChildren(ChildrenListOptions).

Declaration
[RadPropertyDefaultValue("ZIndex", typeof(RadElement))]
public virtual int ZIndex { get; set; }
Property Value
System.Int32

Methods

AddBehavior(PropertyChangeBehavior)

Adds a property change behavior to the list of behaviors of the element.

Declaration
public void AddBehavior(PropertyChangeBehavior behavior)
Parameters
PropertyChangeBehavior behavior

behavior instance - should not be null (or Nothing in VB.NET)
Remarks

Behaviors can be used to specify how an element should respond when a certain element property changes. Behaviors are used internally by stylesheets when applying to an hierarchy of elements.

AddRangeBehavior(PropertyChangeBehaviorCollection)

AddBehavior(PropertyChangeBehavior)
Declaration
public void AddRangeBehavior(PropertyChangeBehaviorCollection behaviors)
Parameters
PropertyChangeBehaviorCollection behaviors

list of behaviors

AddStylePropertySetting(IPropertySetting)

Declaration
protected override ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)
Parameters
IPropertySetting setting

Returns
ValueUpdateResult

Overrides

Arrange(RectangleF)

Positions and sizes the element within the specified rectangular area.

Declaration
public void Arrange(RectangleF finalRect)
Parameters
System.Drawing.RectangleF finalRect

The final rectangular area allocated for this element by its parent.
Remarks

Arrange is a core method in the two-pass layout system (Measure/Arrange). It is called by parent elements to position and size child elements after the Measure pass has determined the desired sizes.

This method handles layout suspension, visibility checks, arranges children through their layout panels, and ensures that layout operations are properly coordinated through the layout manager. It automatically triggers Measure if the element hasn't been measured or if measure data is invalid.

The method validates the finalRect for infinity and NaN values and respects element visibility settings. Collapsed elements skip arrangement but still record their final rectangle for reference.

Exceptions
System.InvalidOperationException

Thrown when finalRect contains infinity or NaN values.

ArrangeCore(RectangleF)

Performs the core arrangement logic for the element within the specified final rectangle.

Declaration
protected virtual void ArrangeCore(RectangleF finalRect)
Parameters
System.Drawing.RectangleF finalRect

The final rectangular area allocated for this element.

ArrangeOverride(SizeF)

Arranges the RadElement to its final location. The element must call the Arrange method of each of its children.

Declaration
protected virtual SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The size that is available for element.
Returns
System.Drawing.SizeF

The rectangle occupied by the element. Usually finalSize. Should you return different size, the Layout system will restart measuring and rearranging the items. That could lead to infinite recursion.
Remarks

In this method call to the Arrange method of each child must be made.

BringToFront()

Sends this element at the end of its parent's z-ordered collection.

Declaration
public void BringToFront()

CalcLayoutOffset(PointF)

Calculates the layout offset for the element based on the start point.

Declaration
protected virtual PointF CalcLayoutOffset(PointF startPoint)
Parameters
System.Drawing.PointF startPoint

The starting point for the layout calculation.
Returns
System.Drawing.PointF

The calculated layout offset.

CallCreateChildElements()

Creates the child elements and sets their locally applied values as Default

Declaration
protected virtual void CallCreateChildElements()

CallDoClick(EventArgs)

This method is not relevant for this class.

Declaration
public void CallDoClick(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

CallDoDoubleClick(EventArgs)

This method is not relevant for this class.

Declaration
public void CallDoDoubleClick(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

CallDoMouseDown(MouseEventArgs)

This method is not relevant for this class.

Declaration
public void CallDoMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.

CallDoMouseEnter(EventArgs)

This method is not relevant for this class.

Declaration
public void CallDoMouseEnter(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

CallDoMouseHover(EventArgs)

This method is not relevant for this class.

Declaration
public void CallDoMouseHover(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

CallDoMouseLeave(EventArgs)

This method is not relevant for this class.

Declaration
public void CallDoMouseLeave(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

CallDoMouseMove(MouseEventArgs)

This method is not relevant for this class.

Declaration
public void CallDoMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.

CallDoMouseUp(MouseEventArgs)

This method is not relevant for this class.

Declaration
public void CallDoMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.

CallDoMouseWheel(MouseEventArgs)

This method is not relevant for this class.

Declaration
public void CallDoMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.

CallOnLoad(Boolean)

This method is not relevant for this class.

Declaration
public void CallOnLoad(bool recursive)
Parameters
System.Boolean recursive

True to notify entire subtree for the load process, false otherwise.

CallOnRenderSizeChanged(SizeChangedInfo)

This method is not relevant for this class.

Declaration
public void CallOnRenderSizeChanged(SizeChangedInfo info)
Parameters
SizeChangedInfo info

The size change information.

CanExecuteLayoutOperation()

Determines whether the element can perform layout operation.

Declaration
protected virtual bool CanExecuteLayoutOperation()
Returns
System.Boolean

True if layout operations can be performed, false otherwise.

CanRaisePropertyChangeNotifications(RadPropertyValue)

Declaration
protected override bool CanRaisePropertyChangeNotifications(RadPropertyValue propVal)
Parameters
RadPropertyValue propVal

Returns
System.Boolean

Overrides

ChangeCollection(RadElement, ItemsChangeOperation)

This method is not relevant for this class.

Declaration
public void ChangeCollection(RadElement child, ItemsChangeOperation changeOperation)
Parameters
RadElement child

The element associated with the change.
ItemsChangeOperation changeOperation

The type of change operation performed.

ClearBehaviors()

Declaration
public void ClearBehaviors()

ComposeShouldPaintSystemSkin()

Composes a value which determines whether the element should use system skins when painting. This method will traverse the element and control tree and will end with the global UseSystemSkin property.

Declaration
protected virtual bool ComposeShouldPaintSystemSkin()
Returns
System.Boolean

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected virtual void CreateChildElements()

DisposeChildren()

Declaration
public void DisposeChildren()

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

DoClick(EventArgs)

Declaration
protected virtual void DoClick(EventArgs e)
Parameters
System.EventArgs e

DoDoubleClick(EventArgs)

Declaration
protected virtual void DoDoubleClick(EventArgs e)
Parameters
System.EventArgs e

DoMouseDown(MouseEventArgs)

Called when the mouse button is pressed down over this element.

Declaration
protected virtual void DoMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.

DoMouseEnter(EventArgs)

Called when the mouse enters this element.

Declaration
protected virtual void DoMouseEnter(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

DoMouseHover(EventArgs)

Called when the mouse hovers over this element.

Declaration
protected virtual void DoMouseHover(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

DoMouseLeave(EventArgs)

Called when the mouse leaves this element.

Declaration
protected virtual void DoMouseLeave(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

DoMouseMove(MouseEventArgs)

Called when the mouse is moved over this element.

Declaration
protected virtual void DoMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.

DoMouseUp(MouseEventArgs)

Called when the mouse button is released over this element.

Declaration
protected virtual void DoMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.

DoMouseWheel(MouseEventArgs)

Declaration
protected virtual void DoMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

DpiScaleChanged(SizeF)

Called when the DPI scale factor changes. Updates the scale factor and notifies child elements.

Declaration
public virtual void DpiScaleChanged(SizeF scaleFactor)
Parameters
System.Drawing.SizeF scaleFactor

The new DPI scale factor.

EnumDescendants(Predicate<RadElement>, TreeTraversalMode)

Provides flexible routine for traversing all descendants of this instance that match the provided predicate.

Declaration
public IEnumerable<RadElement> EnumDescendants(Predicate<RadElement> predicate, TreeTraversalMode traverseMode)
Parameters
System.Predicate<RadElement> predicate

The filter that defines the match criteria.
TreeTraversalMode traverseMode

The mode used to traverse the subtree.
Returns
System.Collections.Generic.IEnumerable<RadElement>

An enumerable collection of descendant elements matching the predicate.

EnumDescendants(Filter, TreeTraversalMode)

Provides flexible routine for traversing all descendants of this instance that match the provided filter.

Declaration
public IEnumerable<RadElement> EnumDescendants(Filter filter, TreeTraversalMode traverseMode)
Parameters
Filter filter

The filter that defines the match criteria.
TreeTraversalMode traverseMode

The mode used to traverse the subtree.
Returns
System.Collections.Generic.IEnumerable<RadElement>

An enumerable collection of descendant elements matching the filter.

EnumDescendants(TreeTraversalMode)

Provides flexible routine for traversing all descendants of this instance that match the provided predicate.

Declaration
public IEnumerable<RadElement> EnumDescendants(TreeTraversalMode traverseMode)
Parameters
TreeTraversalMode traverseMode

The mode used to traverse the subtree.
Returns
System.Collections.Generic.IEnumerable<RadElement>

An enumerable collection of descendant elements.

FindAncestor<T>()

Searches up the parent chain and returns the first parent of type T.

Declaration
public T FindAncestor<T>()
    where T : RadElement
Returns
T

The first parent element of the specified type; otherwise, null.
Type Parameters
T

The type of parent element to search for.

FindAncestorByThemeEffectiveType(Type)

Searches up the parent chain and returns the first parent with the provided ThemeEffectiveType.

Declaration
public RadElement FindAncestorByThemeEffectiveType(Type themeEffectiveType)
Parameters
System.Type themeEffectiveType

The theme effective type to search for.
Returns
RadElement

The first parent element with the specified theme effective type; otherwise, null.

FindDescendant(Predicate<RadElement>)

Searches down the subtree of elements, using breadth-first approach, and returns the first descendant that matches the provided predicate.

Declaration
public RadElement FindDescendant(Predicate<RadElement> criteria)
Parameters
System.Predicate<RadElement> criteria

The predicate used to filter elements.
Returns
RadElement

The first descendant element matching the criteria; otherwise, null.

FindDescendant(Type)

Searches down the subtree of elements, using breadth-first approach, and returns the first descendant of the specified Type.

Declaration
public RadElement FindDescendant(Type descendantType)
Parameters
System.Type descendantType

The type of descendant element to search for.
Returns
RadElement

The first descendant element of the specified type; otherwise, null.

FindDescendant<T>()

Searches down the subtree of elements, using breadth-first approach, and returns the first descendant of type T.

Declaration
public T FindDescendant<T>()
    where T : RadElement
Returns
T

The first descendant element of the specified type; otherwise, null.
Type Parameters
T

The type of descendant element to search for.

Focus()

Attempts to set the keyboard focus to the element.

Declaration
public virtual bool Focus()
Returns
System.Boolean

True if the keyboard focus is successfully set to the element; otherwise, false.

Focus(Boolean)

Attempts to set the keyboard focus to the element, optionally setting parent control focus.

Declaration
protected bool Focus(bool setParentControlFocus)
Parameters
System.Boolean setParentControlFocus

True to also set focus to the parent control; otherwise, false.
Returns
System.Boolean

True if the keyboard focus is successfully set to the element; otherwise, false.

GetAncestors(Predicate<RadElement>)

Provides a routine which enumerates all ancestors up in the parent chain of this element, which match the provided predicate.

Declaration
public IEnumerable<RadElement> GetAncestors(Predicate<RadElement> predicate)
Parameters
System.Predicate<RadElement> predicate

The predicate used to filter parents.
Returns
System.Collections.Generic.IEnumerable<RadElement>

An enumerable collection of ancestor elements matching the predicate.

GetAncestors(Filter)

Provides a routine which enumerates all ancestors up in the parent chain of this element, which match the provided Filter.

Declaration
public IEnumerable<RadElement> GetAncestors(Filter filter)
Parameters
Filter filter

The filter used to match ancestor elements.
Returns
System.Collections.Generic.IEnumerable<RadElement>

An enumerable collection of ancestor elements matching the filter.

GetArrangeRect(RectangleF)

Gets the arrange rectangle, valid for this element.

Declaration
protected virtual RectangleF GetArrangeRect(RectangleF proposed)
Parameters
System.Drawing.RectangleF proposed

The proposed rectangle.
Returns
System.Drawing.RectangleF

The arrange rectangle for this element.

GetAsBitmap(Brush, Single, SizeF)

Declaration
public Bitmap GetAsBitmap(Brush backgroundBrush, float totalAngle, SizeF totalScale)
Parameters
System.Drawing.Brush backgroundBrush

System.Single totalAngle

System.Drawing.SizeF totalScale

Returns
System.Drawing.Bitmap

GetAsBitmap(IGraphics, Brush, Single, SizeF)

Declaration
public Bitmap GetAsBitmap(IGraphics screenRadGraphics, Brush backgroundBrush, float totalAngle, SizeF totalScale)
Parameters
IGraphics screenRadGraphics

System.Drawing.Brush backgroundBrush

System.Single totalAngle

System.Drawing.SizeF totalScale

Returns
System.Drawing.Bitmap

GetAsBitmapEx(Brush, Single, SizeF)

Declaration
public Bitmap GetAsBitmapEx(Brush backgroundBrush, float totalAngle, SizeF totalScale)
Parameters
System.Drawing.Brush backgroundBrush

System.Single totalAngle

System.Drawing.SizeF totalScale

Returns
System.Drawing.Bitmap

GetAsBitmapEx(Color, Single, SizeF)

Declaration
public virtual Bitmap GetAsBitmapEx(Color backColor, float totalAngle, SizeF totalScale)
Parameters
System.Drawing.Color backColor

System.Single totalAngle

System.Drawing.SizeF totalScale

Returns
System.Drawing.Bitmap

GetAsTransformedBitmap(Brush, Single, SizeF)

Declaration
public Bitmap GetAsTransformedBitmap(Brush backgroundBrush, float totalAngle, SizeF totalScale)
Parameters
System.Drawing.Brush backgroundBrush

System.Single totalAngle

System.Drawing.SizeF totalScale

Returns
System.Drawing.Bitmap

GetAsTransformedBitmap(Rectangle, Brush, Single, SizeF)

Declaration
public Bitmap GetAsTransformedBitmap(Rectangle clippingRectangle, Brush backgroundBrush, float totalAngle, SizeF totalScale)
Parameters
System.Drawing.Rectangle clippingRectangle

System.Drawing.Brush backgroundBrush

System.Single totalAngle

System.Drawing.SizeF totalScale

Returns
System.Drawing.Bitmap

GetAsTransformedBitmap(IGraphics, Brush, Single, SizeF)

Declaration
public Bitmap GetAsTransformedBitmap(IGraphics screenRadGraphics, Brush backgroundBrush, float totalAngle, SizeF totalScale)
Parameters
IGraphics screenRadGraphics

System.Drawing.Brush backgroundBrush

System.Single totalAngle

System.Drawing.SizeF totalScale

Returns
System.Drawing.Bitmap

GetBehaviors()

Gets the property change behaviors collection for this element.

Declaration
public PropertyChangeBehaviorCollection GetBehaviors()
Returns
PropertyChangeBehaviorCollection

The collection of property change behaviors.

GetBorderThickness(BorderPrimitive)

Declaration
protected Padding GetBorderThickness(BorderPrimitive element)
Parameters
BorderPrimitive element

Returns
System.Windows.Forms.Padding

GetBoundingRectangle(Rectangle)

Gets the rectangle which surrounds the rotated element (if having AngleTransform property set).

Declaration
public Rectangle GetBoundingRectangle(Rectangle bounds)
Parameters
System.Drawing.Rectangle bounds

The bounds of the element.
Returns
System.Drawing.Rectangle

A rectangle that bounds the transformed element.

GetBoundingRectangle(Size)

Gets the rectangle which surrounds the rotated element (if having AngleTransform property set).

Declaration
public Rectangle GetBoundingRectangle(Size size)
Parameters
System.Drawing.Size size

The size of the element which is accepted as a parameter (for example when returned from GetPreferredSize).
Returns
System.Drawing.Rectangle

A rectangle that bounds the transformed element.

GetChildAt(Int32)

This method is not relevant for this class.

Declaration
public virtual RadElement GetChildAt(int index)
Parameters
System.Int32 index

The index of the child element to retrieve.
Returns
RadElement

The child element at the specified index.

GetChildren(ChildrenListOptions)

Allows enumerating of this element's children, using the specified options.

Declaration
public IEnumerable<RadElement> GetChildren(ChildrenListOptions options)
Parameters
ChildrenListOptions options

The enumeration options to use.
Returns
System.Collections.Generic.IEnumerable<RadElement>

An enumerable collection of child elements based on the specified options.

GetChildrenByBaseType(Type)

Gets a list of child elements using the base type to filter the results.

Declaration
public List<RadElement> GetChildrenByBaseType(Type type)
Parameters
System.Type type

The base type to filter child elements by.
Returns
System.Collections.Generic.List<RadElement>

A list of child elements derived from the specified base type.

GetChildrenByType(Type)

Gets a list of child elements using the type to filter the results.

Declaration
public List<RadElement> GetChildrenByType(Type type)
Parameters
System.Type type

The type to filter child elements by.
Returns
System.Collections.Generic.List<RadElement>

A list of child elements of the specified type.

GetClientRectangle(SizeF)

Declaration
protected virtual RectangleF GetClientRectangle(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.RectangleF

GetClipRect()

Declaration
protected virtual RectangleF GetClipRect()
Returns
System.Drawing.RectangleF

GetCurrentShape()

Declaration
protected ElementShape GetCurrentShape()
Returns
ElementShape

GetDescendants(Predicate<RadElement>, TreeTraversalMode)

Gets a list with all the descendants that match the provided predicate.

Declaration
public List<RadElement> GetDescendants(Predicate<RadElement> predicate, TreeTraversalMode traverseMode)
Parameters
System.Predicate<RadElement> predicate

The predicate used to filter descendant elements.
TreeTraversalMode traverseMode

The mode used to traverse the subtree.
Returns
System.Collections.Generic.List<RadElement>

A list of descendant elements matching the predicate.

GetDescendants(Filter, TreeTraversalMode)

Gets a list with all the descendants that match the provided filter.

Declaration
public List<RadElement> GetDescendants(Filter filter, TreeTraversalMode traverseMode)
Parameters
Filter filter

The filter used to match descendant elements.
TreeTraversalMode traverseMode

The mode used to traverse the subtree.
Returns
System.Collections.Generic.List<RadElement>

A list of descendant elements matching the filter.

GetDesiredSize(Boolean)

Gets the desired size of the element, optionally checking if the element is collapsed.

Declaration
public SizeF GetDesiredSize(bool checkCollapsed)
Parameters
System.Boolean checkCollapsed

True to return empty size if the element is collapsed.
Returns
System.Drawing.SizeF

The desired size of the element.

GetFocusRect()

Declaration
protected virtual Rectangle GetFocusRect()
Returns
System.Drawing.Rectangle

GetInvalidateBounds()

Returns the bounds of the area that should be invalidated when the element is invalidated.

Declaration
public virtual Rectangle GetInvalidateBounds()
Returns
System.Drawing.Rectangle

The bounds to invalidate.

GetPaintRectangle(Single, Single, SizeF)

Declaration
protected RectangleF GetPaintRectangle(float borderWidth, float angle, SizeF scale)
Parameters
System.Single borderWidth

System.Single angle

System.Drawing.SizeF scale

Returns
System.Drawing.RectangleF

GetPatchedRect(RectangleF, Single, SizeF)

Declaration
protected RectangleF GetPatchedRect(RectangleF rect, float angle, SizeF scale)
Parameters
System.Drawing.RectangleF rect

System.Single angle

System.Drawing.SizeF scale

Returns
System.Drawing.RectangleF

GetRegisterRoutedEvent(String)

Gets a registered routed event by name for this element's type.

Declaration
public RoutedEvent GetRegisterRoutedEvent(string eventName)
Parameters
System.String eventName

The name of the routed event.
Returns
RoutedEvent

The registered routed event if found; otherwise, null.

GetRegisterRoutedEvent(String, String)

Gets a registered routed event by name and class name.

Declaration
public static RoutedEvent GetRegisterRoutedEvent(string eventName, string className)
Parameters
System.String eventName

The name of the routed event.
System.String className

The name of the class that owns the routed event.
Returns
RoutedEvent

The registered routed event if found; otherwise, null.

GetRegisterRoutedEvent(String, Type)

Gets a registered routed event by name and owner type.

Declaration
public static RoutedEvent GetRegisterRoutedEvent(string eventName, Type ownerType)
Parameters
System.String eventName

The name of the routed event.
System.Type ownerType

The type that owns the routed event.
Returns
RoutedEvent

The registered routed event if found; otherwise, null.

GetScrollingOffset()

Gets the offset that is caused by scrolling. The difference between this method and PositionOffset property is that GetScrollingOffset() takes into account RightToLeft.

Declaration
public Point GetScrollingOffset()
Returns
System.Drawing.Point

The scrolling offset for this element.

GetShadowRect(ref Rectangle, Int32)

Declaration
protected virtual Rectangle GetShadowRect(ref Rectangle elementRect, int shadowDepth)
Parameters
System.Drawing.Rectangle elementRect

System.Int32 shadowDepth

Returns
System.Drawing.Rectangle

GetStylableChildren()

Declaration
protected virtual IEnumerable<RadObject> GetStylableChildren()
Returns
System.Collections.Generic.IEnumerable<RadObject>

GetStylableChildrenHierarchy()

Declaration
protected virtual IEnumerable<RadObject> GetStylableChildrenHierarchy()
Returns
System.Collections.Generic.IEnumerable<RadObject>

GetStylablePropertiesFilter()

Gets the IFilter instance that may be used to filter the properties, treated as Stylable for this element.

Declaration
public virtual Filter GetStylablePropertiesFilter()
Returns
Filter

GetSystemSkinPaintBounds()

Gets the rectangle where skin background should be painted. Defaults to BoundingRectangle.

Declaration
protected virtual Rectangle GetSystemSkinPaintBounds()
Returns
System.Drawing.Rectangle

The rectangle where skin background should be painted.

GetThemeEffectiveType()

Declaration
public Type GetThemeEffectiveType()
Returns
System.Type

GetValue(RadProperty)

Declaration
public override object GetValue(RadProperty property)
Parameters
RadProperty property

Returns
System.Object

Overrides

GetVistaVisualStyle()

Gets the VisualStyleElement instance that describes the skin appearance for the element when the current OS is Windows Vista.

Declaration
public virtual VisualStyleElement GetVistaVisualStyle()
Returns
System.Windows.Forms.VisualStyles.VisualStyleElement

The visual style element for Windows Vista.
Implements

GetXPVisualStyle()

Gets the Visual Style Element instance that describes the skin appearance for the element when the current OS is Windows XP.

Declaration
public virtual VisualStyleElement GetXPVisualStyle()
Returns
System.Windows.Forms.VisualStyles.VisualStyleElement

The visual style element for Windows XP.
Implements

HasInvisibleAncestor()

Determines whether there is an ancestor in this element tree that is not visible.

Declaration
public bool HasInvisibleAncestor()
Returns
System.Boolean

True if an invisible ancestor exists, false otherwise.

HideScreenTip()

Hides the currently displayed screen tip.

Declaration
protected virtual void HideScreenTip()

HitTest(Point)

Performs hit testing on the element to determine if the specified point lies within its bounds.

Declaration
public virtual bool HitTest(Point point)
Parameters
System.Drawing.Point point

The point to test in control coordinates.
Returns
System.Boolean

True if the point is within the element bounds, false otherwise.

InitializeFields()

Initializes member fields to their default values. This method is called prior the CreateChildItems one and allows for initialization of members on which child elements depend.

Declaration
protected virtual void InitializeFields()

InitializeSystemSkinPaint()

Performs initialization when the element is first-time painted using system skin.

Declaration
protected virtual void InitializeSystemSkinPaint()

Invalidate()

Invalidates the element and schedules it for repainting.

Declaration
public void Invalidate()

Invalidate(Boolean)

Invalidates the element and schedules it for repainting, optionally checking if layout is suspended.

Declaration
public void Invalidate(bool checkSuspended)
Parameters
System.Boolean checkSuspended

True to check if layout is suspended before invalidating.

InvalidateArrange()

Invalidates the arrangement state of the element, causing it to be re-arranged during the next layout pass.

Declaration
public void InvalidateArrange()
Remarks

This overload calls InvalidateArrange(false), invalidating only this element. Use this method when the element's position or arrangement-affecting properties have changed.

InvalidateArrange(Boolean)

Invalidates the arrangement state of the element and optionally its children, causing them to be re-arranged during the next layout pass.

Declaration
public void InvalidateArrange(bool recursive)
Parameters
System.Boolean recursive

True to invalidate this element and all its children; false for this element only.
Remarks

InvalidateArrange marks the element as needing arrangement and adds it to the layout manager's arrange queue if layout is not currently suspended. This is typically called when properties that affect the element's position or size have changed.

The method respects the element's state and layout suspension. If layout is suspended, the invalidation is recorded but the element won't be queued for arrangement until layout is resumed.

InvalidateMeasure()

Invalidates the measurement state of the element, causing it to be re-measured during the next layout pass.

Declaration
public void InvalidateMeasure()
Remarks

This overload calls InvalidateMeasure(false), invalidating only this element. Use this method when the element's content or measurement-affecting properties have changed.

InvalidateMeasure(Boolean)

Invalidates the measurement state of the element and optionally its children, causing them to be re-measured during the next layout pass.

Declaration
public void InvalidateMeasure(bool recursive)
Parameters
System.Boolean recursive

True to invalidate this element and all its children; false for this element only.
Remarks

InvalidateMeasure marks the element as needing measurement and adds it to the layout manager's measure queue if layout is not currently suspended. This is typically called when properties that affect the element's desired size have changed.

The method respects the element's state and layout suspension. If layout is suspended, the invalidation is recorded but the element won't be queued for measurement until layout is resumed.

InvalidateTransformations()

This method is used internally.

Declaration
public void InvalidateTransformations()

IsAncestorOf(RadElement)

Gets a boolean value that determines whether a given element resides in the element hierarchy of this element.

Declaration
public bool IsAncestorOf(RadElement element)
Parameters
RadElement element

An instance of the RadElement class which is checked.
Returns
System.Boolean

True if the element is a descendant of this element; otherwise, false.

IsChildOf(RadElement)

Get a value indicating whether the element is a direct or indirect child of specified parent element

Declaration
public bool IsChildOf(RadElement parent)
Parameters
RadElement parent

Parent to test
Returns
System.Boolean

true if the element is child of parent, false otherwise

IsEventInProcess(RaisedRoutedEvent)

Determines whether a specific routed event is currently being processed.

Declaration
public bool IsEventInProcess(RaisedRoutedEvent raisedEvent)
Parameters
RaisedRoutedEvent raisedEvent

The routed event to check for processing status.
Returns
System.Boolean

True if the event is currently being processed; otherwise, false.

IsInGetAsBitmap()

Declaration
protected bool IsInGetAsBitmap()
Returns
System.Boolean

IsInputKey(InputKeyEventArgs)

Determines whether a key is an input key that should be handled by the element.

Declaration
protected virtual bool IsInputKey(InputKeyEventArgs e)
Parameters
InputKeyEventArgs e

The input key event arguments.
Returns
System.Boolean

True if the key is an input key; otherwise, false.

IsInValidState(Boolean)

Determines whether the element is currently in valid state. That is having a valid ElementTree reference and being in either Constructed or Loaded state.

Declaration
public bool IsInValidState(bool checkElementTree)
Parameters
System.Boolean checkElementTree

True to check if element tree is valid, false otherwise.
Returns
System.Boolean

True if the element is in valid state, false otherwise.

IsInVisibleClipBounds(Rectangle)

Declaration
protected virtual bool IsInVisibleClipBounds(Rectangle clipRectangle)
Parameters
System.Drawing.Rectangle clipRectangle

Returns
System.Boolean

IsPropertyCancelable(RadPropertyMetadata)

Declaration
protected override bool IsPropertyCancelable(RadPropertyMetadata metadata)
Parameters
RadPropertyMetadata metadata

Returns
System.Boolean

Overrides

KillFocus()

Removes keyboard focus from the element.

Declaration
protected virtual void KillFocus()

LoadCore()

Allows inheritors to provide custom load logic.

Declaration
protected virtual void LoadCore()

LocationToControl()

Gets the location of this element in control coordinates.

Declaration
public Point LocationToControl()
Returns
System.Drawing.Point

The location in control coordinates.

LockBounds()

Locks the bounds of the element to prevent changes during critical operations.

Declaration
protected virtual void LockBounds()

MapStyleProperty(RadProperty, String)

Maps a style property to another property. This method is used to map corresponding properties of LightVisualElement instances and BasePrimitive instances.

Declaration
public virtual RadProperty MapStyleProperty(RadProperty propertyToMap, string settingType)
Parameters
RadProperty propertyToMap

An instance of the RadProperty class that represents the property to map.
System.String settingType

Returns
RadProperty

An instance of the RadProperty class which represents the mapped property. If no property is found, the method returns null

Measure(SizeF)

Calculates the desired size of the element given the specified available space.

Declaration
public void Measure(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available space that can be allocated to this element by its parent.
Remarks

Measure is the first pass of the two-pass layout system (Measure/Arrange). It determines how much space the element would like to occupy based on its content and the constraints provided by its parent.

This method handles layout suspension, validates the availableSize for NaN values, respects element visibility, and coordinates with the layout manager to ensure proper measurement sequencing. The calculated desired size becomes available through the DesiredSize property.

Collapsed elements are given zero desired size but still participate in the measurement process. The method is optimized to avoid redundant measurements when the available size hasn't changed.

Exceptions
System.InvalidOperationException

Thrown when availableSize contains NaN values.

MeasureChildren(SizeF)

Declaration
protected SizeF MeasureChildren(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

MeasureCore(SizeF)

Performs the core measurement logic for the element with the specified available size.

Declaration
protected virtual SizeF MeasureCore(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available space that can be allocated to this element.
Returns
System.Drawing.SizeF

The minimum size required by the element to be completely visible.

MeasureOverride(SizeF)

Measures the space required by the RadElement

Used by the layout system.

Declaration
protected virtual SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
System.Drawing.SizeF

The minimum size required by the element to be completely visible. Cannot be infinity.
Remarks

In this method call to the Measure method of each child must be made.

MouseEventArgsFromControl(MouseEventArgs)

Converts mouse event arguments from control coordinates to element coordinates.

Declaration
protected virtual MouseEventArgs MouseEventArgsFromControl(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments to convert.
Returns
System.Windows.Forms.MouseEventArgs

Mouse event arguments with coordinates relative to this element.

NotifyChildren(RadPropertyChangedEventArgs)

Declaration
protected virtual void NotifyChildren(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

NotifyInvalidate(RadElement)

Declaration
protected virtual void NotifyInvalidate(RadElement invalidatedChild)
Parameters
RadElement invalidatedChild

OnBeginDispose()

A callback used by the owning RadControl to notify the element for the beginning of a disposing process.

Declaration
protected virtual void OnBeginDispose()

OnBoundsChanged(RadPropertyChangedEventArgs)

Declaration
protected virtual void OnBoundsChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

OnBubbleEvent(RadElement, RoutedEventArgs)

Called when the bubble phase of a routed event occurs.

Declaration
protected virtual void OnBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The element that originally raised the event.
RoutedEventArgs args

The routed event arguments.

OnChildDesiredSizeChanged(RadElement)

Called when a child's desired size has changed.

Declaration
protected virtual void OnChildDesiredSizeChanged(RadElement child)
Parameters
RadElement child

The child element whose desired size changed.

OnChildrenChanged(RadElement, ItemsChangeOperation)

Declaration
protected virtual void OnChildrenChanged(RadElement child, ItemsChangeOperation changeOperation)
Parameters
RadElement child

ItemsChangeOperation changeOperation

OnClick(EventArgs)

Raises the Click event.

Declaration
protected virtual void OnClick(EventArgs e)
Parameters
System.EventArgs e

OnCLREventsRise(RoutedEventArgs)

Declaration
protected virtual void OnCLREventsRise(RoutedEventArgs args)
Parameters
RoutedEventArgs args

OnDisplayPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected virtual void OnDisplayPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

OnDoubleClick(EventArgs)

Raises the DoubleClick event.

Declaration
protected virtual void OnDoubleClick(EventArgs e)
Parameters
System.EventArgs e

OnElementTreeChanged(ComponentThemableElementTree)

The element gets notified for a change in its current ElementTree member.

Declaration
protected virtual void OnElementTreeChanged(ComponentThemableElementTree previousTree)
Parameters
ComponentThemableElementTree previousTree

The previous element tree instance.

OnEnabledChanged(RadPropertyChangedEventArgs)

Declaration
protected virtual void OnEnabledChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

OnLayoutPropertyChanged(RadPropertyChangedEventArgs)

Called when a layout property has changed.

Declaration
protected virtual void OnLayoutPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The property changed event arguments.

OnLoad(Boolean)

A callback used by the owning RadControl to notify the element for a first-time screen visualization.

Declaration
protected void OnLoad(bool recursive)
Parameters
System.Boolean recursive

True to notify entire subtree for the load process, false otherwise.

OnLoaded()

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration
protected virtual void OnLoaded()

OnLocationChanged(RadPropertyChangedEventArgs)

Declaration
protected virtual void OnLocationChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

OnLostMouseCapture(MouseEventArgs)

Declaration
protected virtual void OnLostMouseCapture(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseDown(MouseEventArgs)

Declaration
protected virtual void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseEnter(EventArgs)

Declaration
protected virtual void OnMouseEnter(EventArgs e)
Parameters
System.EventArgs e

OnMouseHover(EventArgs)

Declaration
protected virtual void OnMouseHover(EventArgs e)
Parameters
System.EventArgs e

OnMouseLeave(EventArgs)

Declaration
protected virtual void OnMouseLeave(EventArgs e)
Parameters
System.EventArgs e

OnMouseMove(MouseEventArgs)

Declaration
protected virtual void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseUp(MouseEventArgs)

Declaration
protected virtual void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseWheel(MouseEventArgs)

Raises the MouseWheel event.

Declaration
protected virtual void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.

OnParentChanged(RadElement)

Notifies for a change in the Parent value.

Declaration
protected virtual void OnParentChanged(RadElement previousParent)
Parameters
RadElement previousParent

The previous parent element (if any)

OnParentEnabledChanged(RadPropertyChangedEventArgs)

Declaration
protected virtual void OnParentEnabledChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

OnParentPropertyChanged(RadPropertyChangedEventArgs)

The object gets notified for a parent property change.

Declaration
protected virtual void OnParentPropertyChanged(RadPropertyChangedEventArgs args)
Parameters
RadPropertyChangedEventArgs args

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnRenderSizeChanged(SizeChangedInfo)

Called when the render size of the element has changed.

Declaration
protected virtual void OnRenderSizeChanged(SizeChangedInfo info)
Parameters
SizeChangedInfo info

The size change information.

OnShowScreenTip(ComponentInputBehavior)

Shows a screen tip.

Declaration
protected virtual bool OnShowScreenTip(ComponentInputBehavior inputBehavior)
Parameters
ComponentInputBehavior inputBehavior

The input behavior.
Returns
System.Boolean

A value indicating whether a screen tip is shown.

OnStyleChanged(RadPropertyChangedEventArgs)

Declaration
protected virtual void OnStyleChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

OnTransformationInvalidated()

This method is executed when a property which affects the absolute position of the element has been changed.

Declaration
protected virtual void OnTransformationInvalidated()

OnTunnelEvent(RadElement, RoutedEventArgs)

Called when the tunnel phase of a routed event occurs.

Declaration
protected virtual void OnTunnelEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The element that originally raised the event.
RoutedEventArgs args

The routed event arguments.

OnUnload(ComponentThemableElementTree, Boolean)

Unloads the element if it was previously loaded on an element tree.

Declaration
protected void OnUnload(ComponentThemableElementTree oldTree, bool recursive)
Parameters
ComponentThemableElementTree oldTree

Reference to the element tree from which we are in a process of unload.
System.Boolean recursive

True to unload children recursively, false otherwise.

OnUnloaded(ComponentThemableElementTree)

Notifies that the element has been successfully unloaded from an element tree. Allows inheritors to provide custom logic at this stage.

Declaration
protected virtual void OnUnloaded(ComponentThemableElementTree oldTree)
Parameters
ComponentThemableElementTree oldTree

Reference to the element tree from which the element has been unloaded.

OnUseSystemSkinChanged(EventArgs)

The element gets notified for a change in the UseSystemSkin property. This method will recursively notify all descendants for the change.

Declaration
protected virtual void OnUseSystemSkinChanged(EventArgs e)
Parameters
System.EventArgs e

Paint(IGraphics, Rectangle, Single, SizeF, Boolean)

This method is used internally.

Declaration
public void Paint(IGraphics graphics, Rectangle clipRectangle, float angle, SizeF scale, bool useRelativeTransformation)
Parameters
IGraphics graphics

System.Drawing.Rectangle clipRectangle

System.Single angle

System.Drawing.SizeF scale

System.Boolean useRelativeTransformation

PaintBackgroundShape(IGraphics)

Declaration
protected virtual void PaintBackgroundShape(IGraphics graphics)
Parameters
IGraphics graphics

PaintChild(RadElement, IGraphics, Rectangle, Single, SizeF, Boolean)

Declaration
protected virtual void PaintChild(RadElement child, IGraphics graphics, Rectangle clipRectange, float angle, SizeF scale, bool useRelativeTransformation)
Parameters
RadElement child

IGraphics graphics

System.Drawing.Rectangle clipRectange

System.Single angle

System.Drawing.SizeF scale

System.Boolean useRelativeTransformation

PaintChildren(IGraphics, Rectangle, Single, SizeF, Boolean)

Declaration
protected virtual void PaintChildren(IGraphics graphics, Rectangle clipRectange, float angle, SizeF scale, bool useRelativeTransformation)
Parameters
IGraphics graphics

System.Drawing.Rectangle clipRectange

System.Single angle

System.Drawing.SizeF scale

System.Boolean useRelativeTransformation

PaintElement(IGraphics, Single, SizeF)

Declaration
protected virtual void PaintElement(IGraphics graphics, float angle, SizeF scale)
Parameters
IGraphics graphics

System.Single angle

System.Drawing.SizeF scale

PaintElementSkin(IGraphics)

Provides a routine to paint element's content when system skin appearance is desired.

Declaration
protected virtual void PaintElementSkin(IGraphics graphics)
Parameters
IGraphics graphics

PaintFocusCues(IGraphics, Rectangle)

Declaration
protected virtual void PaintFocusCues(IGraphics graphics, Rectangle clipRectange)
Parameters
IGraphics graphics

System.Drawing.Rectangle clipRectange

PaintOverride(IGraphics, Rectangle, Single, SizeF, Boolean)

Virtual layer between PaintChildren() and Paint(). Can be overridden to fully customize element hierarchy paint. Used for painting disabled items.

Declaration
protected virtual void PaintOverride(IGraphics graphics, Rectangle clipRectangle, float angle, SizeF scale, bool useRelativeTransformation)
Parameters
IGraphics graphics

The graphics object.
System.Drawing.Rectangle clipRectangle

The rectangle which has been invalidated.
System.Single angle

The angle (in degrees) to which the current element is rotated. This angle is a sum of all AngleTransform properties of this element's parents.
System.Drawing.SizeF scale

System.Boolean useRelativeTransformation

PaintShadow(RadElement, IGraphics)

Declaration
protected virtual void PaintShadow(RadElement child, IGraphics graphics)
Parameters
RadElement child

IGraphics graphics

PaintShadowCore(Graphics, Rectangle, RadItem)

Declaration
protected virtual void PaintShadowCore(Graphics graphics, Rectangle bounds, RadItem child)
Parameters
System.Drawing.Graphics graphics

System.Drawing.Rectangle bounds

RadItem child

PerformClick()

Triggers the Click event for the element.

Declaration
public virtual void PerformClick()

PerformDispose(Boolean)

Declaration
protected override void PerformDispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

PerformLayoutTransformation(ref RadMatrix)

Declaration
protected virtual bool PerformLayoutTransformation(ref RadMatrix matrix)
Parameters
RadMatrix matrix

Returns
System.Boolean

PerformPaintTransformation(ref RadMatrix)

Declaration
protected virtual bool PerformPaintTransformation(ref RadMatrix matrix)
Parameters
RadMatrix matrix

Returns
System.Boolean

PointFromControl(Point)

Retrieves a point in control coordinates taking as a parameter a point which is in element coordinates. The method takes into consideration the AngleTransform property applied on the element and rotates back the transformation. This means that the top left corner of the element is with coordinates (0, 0) no matter what is AngleTransform value.

Declaration
public Point PointFromControl(Point point)
Parameters
System.Drawing.Point point

The point in control coordinates to convert.
Returns
System.Drawing.Point

The point in element coordinates.

PointFromScreen(Point)

Retrieves a point in control coordinates taking as a parameter a point which is in screen coordinates.

Declaration
public Point PointFromScreen(Point point)
Parameters
System.Drawing.Point point

The point in screen coordinates to convert.
Returns
System.Drawing.Point

The point in element coordinates.

PointToControl(Point)

Retrieves a point in control coordinates taking as a parameter a point which is in element coordinates. The method does not take into consideration the AngleTransform property applied on the element.

Declaration
public Point PointToControl(Point point)
Parameters
System.Drawing.Point point

The point in element coordinates to convert.
Returns
System.Drawing.Point

The point in control coordinates.

PointToScreen(Point)

Retrieves a point in screen coordinates taking as a parameter a point which is in element coordinates (this means that the top left corner of the element is with coordinates 0, 0).

Declaration
public Point PointToScreen(Point point)
Parameters
System.Drawing.Point point

The point in element coordinates to convert.
Returns
System.Drawing.Point

The point in screen coordinates.

PostPaintChildren(IGraphics, Rectangle, Single, SizeF)

Declaration
protected virtual void PostPaintChildren(IGraphics graphics, Rectangle clipRectange, float angle, SizeF scale)
Parameters
IGraphics graphics

System.Drawing.Rectangle clipRectange

System.Single angle

System.Drawing.SizeF scale

PostPaintElement(IGraphics)

Declaration
protected virtual void PostPaintElement(IGraphics graphics)
Parameters
IGraphics graphics

PrePaintElement(IGraphics)

Declaration
protected virtual void PrePaintElement(IGraphics graphics)
Parameters
IGraphics graphics

ProcessBehaviors(RadPropertyChangedEventArgs)

Declaration
protected virtual void ProcessBehaviors(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

RaiseBubbleEvent(RadElement, RoutedEventArgs)

Raises the bubble phase of a routed event, traveling up from the target element to the root.

Declaration
public virtual void RaiseBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The element that originally raised the event.
RoutedEventArgs args

The routed event arguments.

RaiseClick(EventArgs)

Declaration
protected virtual void RaiseClick(EventArgs e)
Parameters
System.EventArgs e

RaiseDoubleClick(EventArgs)

Declaration
protected virtual void RaiseDoubleClick(EventArgs e)
Parameters
System.EventArgs e

RaiseMouseWheel(MouseEventArgs)

Declaration
protected virtual void RaiseMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

RaiseRoutedEvent(RadElement, RoutedEventArgs)

Raises a routed event on the element, first tunneling down the element tree then bubbling back up.

Declaration
public virtual void RaiseRoutedEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The element that originally raised the event.
RoutedEventArgs args

The routed event arguments.

RaiseTunnelEvent(RadElement, RoutedEventArgs)

Raises the tunnel phase of a routed event, traveling down from the root to the target element.

Declaration
public virtual void RaiseTunnelEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The element that originally raised the event.
RoutedEventArgs args

The routed event arguments.

RectangleToScreen(Rectangle)

Retrieves a rectangle in screen coordinates taking as a parameter a rectangle which is in element coordinates (this means that the top left corner of the element is with coordinates 0, 0).

Declaration
public Rectangle RectangleToScreen(Rectangle rect)
Parameters
System.Drawing.Rectangle rect

The rectangle in element coordinates to convert.
Returns
System.Drawing.Rectangle

The rectangle in screen coordinates.

RegisterRoutedEvent(String, Type)

Registers a new routed event with the specified name and owner type.

Declaration
public static RoutedEvent RegisterRoutedEvent(string eventName, Type ownerType)
Parameters
System.String eventName

The name of the routed event.
System.Type ownerType

The type that owns the routed event.
Returns
RoutedEvent

The registered routed event.

RemoveBehavior(PropertyChangeBehavior)

Declaration
public void RemoveBehavior(PropertyChangeBehavior behavior)
Parameters
PropertyChangeBehavior behavior

RemoveBehaviors(PropertyChangeBehavior)

Declaration
public virtual void RemoveBehaviors(PropertyChangeBehavior behavior)
Parameters
PropertyChangeBehavior behavior

RemoveRangeBehaviors(PropertyChangeBehaviorCollection)

Declaration
public virtual void RemoveRangeBehaviors(PropertyChangeBehaviorCollection propertyChangeBehaviorCollection)
Parameters
PropertyChangeBehaviorCollection propertyChangeBehaviorCollection

RemoveRangeRoutedEventBehaviors(RoutedEventBehaviorCollection)

Declaration
public virtual void RemoveRangeRoutedEventBehaviors(RoutedEventBehaviorCollection routedEventBehaviorCollection)
Parameters
RoutedEventBehaviorCollection routedEventBehaviorCollection

ReplaceDefaultDescriptors(PropertyDescriptorCollection)

Add the ElementTree property if we are in the context of RadControlSpy.

Declaration
protected override PropertyDescriptorCollection ReplaceDefaultDescriptors(PropertyDescriptorCollection props)
Parameters
System.ComponentModel.PropertyDescriptorCollection props

Returns
System.ComponentModel.PropertyDescriptorCollection

Overrides

ResetLayout(Boolean)

Resets all layout related fields and puts the element in its initial layout state.

Declaration
public void ResetLayout(bool recursive)
Parameters
System.Boolean recursive

True to reset children recursively, false otherwise.

ResetLayoutCore()

Resets the core layout properties and removes this element from layout queues.

Declaration
protected virtual void ResetLayoutCore()

ResetStyleSettings(Boolean)

Resets the Style modifier of each registered property.

Declaration
public void ResetStyleSettings(bool recursive)
Parameters
System.Boolean recursive

ResetStyleSettings(Boolean, RadProperty)

Resets the Style modifier for the specified property. Will reset all properties if null is passed.

Declaration
public virtual void ResetStyleSettings(bool recursive, RadProperty property)
Parameters
System.Boolean recursive

RadProperty property

ResetStyleVersion()

Declaration
protected void ResetStyleVersion()

ResetUseCompatibleTextRendering()

Declaration
public void ResetUseCompatibleTextRendering()

ResumeLayout(Boolean)

Resumes layout logic for the element with an option to force immediate layout.

Declaration
public void ResumeLayout(bool performLayout)
Parameters
System.Boolean performLayout

True to execute pending layout requests immediately; false to simply resume layout operations.
Remarks

This overload calls ResumeLayout(false, performLayout), resuming layout for this element only. Use this method after calling SuspendLayout to re-enable layout calculations.

ResumeLayout(Boolean, Boolean)

Resumes layout logic for the element and optionally for its children, with an option to force immediate layout.

Declaration
public virtual void ResumeLayout(bool recursive, bool performLayout)
Parameters
System.Boolean recursive

True to resume layout for this element and all its children; false for this element only.
System.Boolean performLayout

True to execute pending layout requests immediately; false to simply resume layout operations.
Remarks

Layout operations are reference-counted, so each call to SuspendLayout must be matched with a corresponding call to ResumeLayout. When the suspend count reaches zero and the element is loaded, pending layout operations will be executed if performLayout is true. This method is essential for maintaining element tree layout consistency.

ResumeReferenceUpdate()

Resumes the previously suspended UpdateReferences(ComponentThemableElementTree, Boolean, Boolean) method execution. Each call to SuspendReferenceUpdate() must be paired with a corresponding call to this method.

Declaration
public void ResumeReferenceUpdate()

ResumeThemeRefresh()

This method is used internally.

Declaration
public void ResumeThemeRefresh()

SendToBack()

Sends this element to the beginning of its parent's z-ordered collection.

Declaration
public void SendToBack()

SetAllLocalValuesAsDefault(Boolean)

This method is not relevant for this class.

Declaration
public virtual void SetAllLocalValuesAsDefault(bool recursive)
Parameters
System.Boolean recursive

True to apply recursively to all descendants, false for this element only.

SetBounds(Rectangle)

Sets the bounds of the element to the specified rectangle (locating and size).

Declaration
public void SetBounds(Rectangle bounds)
Parameters
System.Drawing.Rectangle bounds

The rectangle that represents the new location and size.

SetBounds(Int32, Int32, Int32, Int32)

Sets the bounds of the element to the specified rectangle (X, Y, width and height).

Declaration
public void SetBounds(int x, int y, int width, int height)
Parameters
System.Int32 x

The new X coordinate for the upper-left corner of the element.
System.Int32 y

The new Y coordinate for the upper-left corner of the element.
System.Int32 width

The new width of the element.
System.Int32 height

The new height of the element.

SetBoundsCore(Rectangle)

Sets the bounds of the element to the specified rectangle.

Declaration
protected virtual void SetBoundsCore(Rectangle bounds)
Parameters
System.Drawing.Rectangle bounds

The rectangle to set as bounds.

SetClipping(Graphics)

Declaration
protected virtual void SetClipping(Graphics rawGraphics)
Parameters
System.Drawing.Graphics rawGraphics

SetElementFocused(Boolean)

This method is not relevant for this class.

Declaration
public void SetElementFocused(bool isFocused)
Parameters
System.Boolean isFocused

The new focused state.

SetFocus()

This method is not relevant for this class.

Declaration
public virtual void SetFocus()

SetFocusPropertySafe(Boolean)

Sets the focused state of an element safely without recursion.

Declaration
protected void SetFocusPropertySafe(bool isFocused)
Parameters
System.Boolean isFocused

The new focused state.

SetIsDesignMode(Boolean, Boolean)

This method is not relevant for this class.

Declaration
public void SetIsDesignMode(bool value, bool recursive)
Parameters
System.Boolean value

True to set design mode, false otherwise.
System.Boolean recursive

True to apply to children recursively, false otherwise.

SetParent(RadElement)

Applies the specified RadElement instance as parent of the current instance.

Declaration
protected void SetParent(RadElement parent)
Parameters
RadElement parent

The parent element to set.

SetThemeApplied(Boolean)

Used internally to support RadControl infrastructure. This method is not intended for use directly from your code.

Declaration
protected void SetThemeApplied(bool newValue)
Parameters
System.Boolean newValue

SetValueCore(RadPropertyValue, Object, Object, ValueSource)

Declaration
protected override ValueUpdateResult SetValueCore(RadPropertyValue propVal, object propModifier, object newValue, ValueSource source)
Parameters
RadPropertyValue propVal

System.Object propModifier

System.Object newValue

ValueSource source

Returns
ValueUpdateResult

Overrides

ShouldArrangeChild(RadElement)

Gets a value indicating whether a child will be arranged during the ArrangeOverride(SizeF).

Declaration
protected virtual bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

The child element to check.
Returns
System.Boolean

Whether the child will be arranged in ArrangeOverride.

ShouldMeasureChild(RadElement)

Gets a value indicating, whether a child will be measured during the MeasureOverride.

Declaration
protected virtual bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

The child.
Returns
System.Boolean

Whether the child will be measured in MeasureOverride.

ShouldPaintChild(RadElement)

Declaration
protected virtual bool ShouldPaintChild(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

ShouldPaintSystemSkin()

Determines whether we should paint system skin.

Declaration
protected virtual bool ShouldPaintSystemSkin()
Returns
System.Boolean

ShouldSerializeUseCompatibleTextRendering()

Declaration
public bool ShouldSerializeUseCompatibleTextRendering()
Returns
System.Boolean

ShowScreenTip(ScreenTipNeededEventArgs)

Shows a screen tip for this element.

Declaration
protected virtual void ShowScreenTip(ScreenTipNeededEventArgs args)
Parameters
ScreenTipNeededEventArgs args

The screen tip event arguments.

SuspendLayout()

Temporarily suspends layout operations upon this element.

Declaration
public void SuspendLayout()

SuspendLayout(Boolean)

Temporarily suspends layout operations upon this element.

Declaration
public virtual void SuspendLayout(bool recursive)
Parameters
System.Boolean recursive

True to suspend children also, false otherwise.

SuspendReferenceUpdate()

Temporarily suspends the UpdateReferences(ComponentThemableElementTree, Boolean, Boolean) method execution. This is useful when modifying the element tree structure without triggering immediate reference updates.

Declaration
public void SuspendReferenceUpdate()

SuspendThemeRefresh()

This method is not relevant for this class.

Declaration
public void SuspendThemeRefresh()

ToString()

Declaration
public override string ToString()
Returns
System.String

Overrides
System.Object.ToString()

UnapplyStyle()

Declaration
protected virtual void UnapplyStyle()

UnitializeSystemSkinPaint()

Performs cleanup when system skin painting is no longer used.

Declaration
protected virtual void UnitializeSystemSkinPaint()

UnloadCore(ComponentThemableElementTree)

Executes the core unload logic. Allows inheritors to perform additional action while the element is unloading itself.

Declaration
protected virtual void UnloadCore(ComponentThemableElementTree oldTree)
Parameters
ComponentThemableElementTree oldTree

Reference to the element tree from which we are in a process of unload.

UnlockBounds()

Unlocks the bounds of the element after critical operations are complete.

Declaration
protected virtual void UnlockBounds()

UpdateContainsFocus(Boolean)

Updates the ContainsFocus property. The notification may be received from a child whose IsFocused property has changed.

Declaration
protected virtual void UpdateContainsFocus(bool isFocused)
Parameters
System.Boolean isFocused

The current focused state.

UpdateContainsMouse()

Updates the ContainsMouse property. The notification may be received from a child whose IsMouseOver property has changed.

Declaration
public virtual void UpdateContainsMouse()

UpdateLayout()

Forces the element to update its layout by processing any pending measure and arrange operations.

Declaration
public void UpdateLayout()

UpdateReferences(ComponentThemableElementTree, Boolean, Boolean)

Updates the local references using the provided element tree.

Declaration
protected virtual void UpdateReferences(ComponentThemableElementTree tree, bool updateInheritance, bool recursive)
Parameters
ComponentThemableElementTree tree

The element tree to use for updating references.
System.Boolean updateInheritance

True to update inheritance chain, false otherwise.
System.Boolean recursive

True to update children also, false otherwise.

Events

ChildrenChanged

Occurs when the children collection of the element is changed.

Declaration
public event ChildrenChangedEventHandler ChildrenChanged
Event Type
ChildrenChangedEventHandler

Click

Occurs when the element is clicked.

Declaration
public event EventHandler Click
Event Type
System.EventHandler

DoubleClick

Occurs when the element is double-clicked.

Declaration
public virtual event EventHandler DoubleClick
Event Type
System.EventHandler

ElementPainted

This event occurs after printing the element. It is used internally.

Declaration
public event PaintEventHandler ElementPainted
Event Type
System.Windows.Forms.PaintEventHandler

EnabledChanged

Occurs when the enabled state of the element has changed.

Declaration
public event EventHandler EnabledChanged
Event Type
System.EventHandler

LayoutUpdated

Declaration
public event EventHandler LayoutUpdated
Event Type
System.EventHandler

LostMouseCapture

Declaration
public event MouseEventHandler LostMouseCapture
Event Type
System.Windows.Forms.MouseEventHandler

MouseDown

Occurs when the mouse pointer is over the element and a mouse button is pressed.

Declaration
public event MouseEventHandler MouseDown
Event Type
System.Windows.Forms.MouseEventHandler

MouseEnter

Occurs when the mouse pointer enters the element.

Declaration
public event EventHandler MouseEnter
Event Type
System.EventHandler

MouseHover

Occurs when the mouse pointer rests on the element.

Declaration
public event EventHandler MouseHover
Event Type
System.EventHandler

MouseLeave

Occurs when the mouse pointer leaves the element.

Declaration
public event EventHandler MouseLeave
Event Type
System.EventHandler

MouseMove

Occurs when the mouse pointer is moved over the element.

Declaration
public event MouseEventHandler MouseMove
Event Type
System.Windows.Forms.MouseEventHandler

MouseUp

Occurs when the mouse pointer is over the element and a mouse button is released.

Declaration
public event MouseEventHandler MouseUp
Event Type
System.Windows.Forms.MouseEventHandler

MouseWheel

Occurs when the RadItem has focus and the user scrolls up or down the mouse wheel

Declaration
public event MouseEventHandler MouseWheel
Event Type
System.Windows.Forms.MouseEventHandler

Explicit Interface Implementations

IStylableNode.ApplySettings(PropertySettingGroup)

Declaration
void IStylableNode.ApplySettings(PropertySettingGroup group)
Parameters
PropertySettingGroup group

Implements

IStylableNode.Children

Declaration
IEnumerable<RadObject> IStylableNode.Children { get; }
Returns
System.Collections.Generic.IEnumerable<RadObject>

Implements

IStylableNode.ChildrenHierarchy

Declaration
IEnumerable<RadObject> IStylableNode.ChildrenHierarchy { get; }
Returns
System.Collections.Generic.IEnumerable<RadObject>

Implements

IStylableNode.Class

Declaration
string IStylableNode.Class { get; }
Returns
System.String

Implements

IStylableNode.GetThemeEffectiveType()

Declaration
Type IStylableNode.GetThemeEffectiveType()
Returns
System.Type

Implements

IStylableNode.Parent

Declaration
IStylableNode IStylableNode.Parent { get; }
Returns
IStylableNode

Implements

Extension Methods