ClassRadElement
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.
Definition
Namespace:Telerik.WinControls
Assembly:Telerik.WinControls.dll
Syntax:
public class RadElement : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNodeInheritance: objectDisposableObjectRadObjectRadElement
Derived Classes:
Implements:
Inherited Members
Constructors
RadElement()
Declaration
public RadElement()Fields
AngleTransformProperty
Declaration
public static RadProperty AngleTransformPropertyField Value
AutoSizeModeProperty
Declaration
public static RadProperty AutoSizeModePropertyField Value
BackgroundShapePaintModeProperty
Declaration
public static RadProperty BackgroundShapePaintModePropertyField Value
BackgroundShapeProperty
Declaration
public static RadProperty BackgroundShapePropertyField Value
BorderThicknessProperty
Declaration
public static RadProperty BorderThicknessPropertyField Value
BoundsChangedEvent
Tunnels when bounds changed in order to notify any children that should take special actions in this case - like RadHostItem.
ChildElementAddedEvent
Routed event key for ChildElementAdded event. Bubbles when element is added
Declaration
public static RoutedEvent ChildElementAddedEventField Value
ContainsFocusProperty
Declaration
public static RadProperty ContainsFocusPropertyField Value
ContainsMouseProperty
Declaration
public static RadProperty ContainsMousePropertyField Value
ControlChangedEvent
Tunnels when the winforms control has been changed.
EnabledChangedEvent
Tunnels when the Enabled property changes in order to notify any children that should take special actions.
FitToSizeModeProperty
Declaration
public static RadProperty FitToSizeModePropertyField Value
GetPropertyValueCommand
Declaration
public static readonly GetPropertyValueCommand GetPropertyValueCommandField Value
GetPropertyValueCommand
IsItemFocusedProperty
Declaration
public static RadProperty IsItemFocusedPropertyField Value
IsMouseOverElementProperty
Declaration
public static RadProperty IsMouseOverElementPropertyField Value
MaxSizeProperty
Get or sets the maximum size to apply on an element when layout is calculated.
MouseClickedEvent
Tunnels and bubbles on MouseClick on current element
MouseDoubleClickedEvent
Tunnels and bubbles on MouseDoubleClick on current element
Declaration
public static RoutedEvent MouseDoubleClickedEventField Value
MouseDownEvent
Tunnels and bubbles on MouseDown on current element
MouseUpEvent
Tunnels and bubbles on MouseUp on current element
MouseWheelEvent
Tunnels and bubbles on MouseWheel on current element
ParentChangedEvent
Routed event key for ParentChanged event. Tunnels when element parent changes
PositionOffsetProperty
Declaration
public static RadProperty PositionOffsetPropertyField Value
ScaleTransformProperty
Declaration
public static RadProperty ScaleTransformPropertyField Value
SetPropertyValueCommand
Declaration
public static readonly SetPropertyValueCommand SetPropertyValueCommandField Value
SetPropertyValueCommand
ShouldPaintProperty
Declaration
public static readonly RadProperty ShouldPaintPropertyField Value
StretchHorizontallyProperty
Declaration
public static readonly RadProperty StretchHorizontallyPropertyField Value
StretchVerticallyProperty
Declaration
public static readonly RadProperty StretchVerticallyPropertyField Value
TagProperty
Declaration
public static readonly RadProperty TagPropertyField Value
UseCompatibleTextRenderingProperty
Declaration
public static RadProperty UseCompatibleTextRenderingPropertyField Value
VisibilityChangingEvent
Tunnels and bubbles when changes the current element
Declaration
public static RoutedEvent VisibilityChangingEventField Value
ZIndexProperty
Property key of the ZIndex Property.
Properties
Alignment
Gets or sets the preferred location of the element if its size is less than its parent size.
Declaration
public virtual ContentAlignment Alignment { get; set; }Property Value
AngleTransform
Gets or sets the rotation transform angle used when painting the element and its children.
Declaration
public virtual float AngleTransform { get; set; }Property Value
AutoNumberKeyTip
Declaration
protected virtual int AutoNumberKeyTip { get; set; }Property Value
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.
AutoSizeMode
Gets or sets the way the element should calculate its Size, when the AutoSize property is set to true.
Declaration
public virtual RadAutoSizeMode AutoSizeMode { get; set; }Property Value
BackgroundShape
Gets or sets the RadImageShape that describes the background of the element.
Declaration
[Browsable(false)]
[VsbBrowsable(true)]
public RadImageShape BackgroundShape { get; set; }Property Value
BackgroundShapePaintMode
Gets or sets a value indiicating when to paint the BackgroundShape.
Declaration
[Browsable(false)]
[VsbBrowsable(true)]
public BackgroundShapePaintMode BackgroundShapePaintMode { get; set; }Property Value
BorderThickness
Gets or sets the border thickness of the element. This thickness is included into the element's bounding rectangle.
Declaration
public virtual Padding BorderThickness { get; set; }Property Value
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
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
public virtual Rectangle Bounds { get; set; }Property Value
BypassLayoutPolicies
Declaration
[Browsable(false)]
public bool BypassLayoutPolicies { get; set; }Property Value
CanFocus
Gets or sets a value indicating whether the element can receive input focus.
CanHaveOwnStyle
Gets a value indicating whether the element can have its own style with style conditions.
Declaration
[Browsable(false)]
public virtual bool CanHaveOwnStyle { get; }Property Value
Capture
Declaration
[Browsable(false)]
public bool Capture { get; set; }Property Value
CaptureOnMouseDown
Determines whether mouse will be captured upon MouseDown event.
Declaration
[Browsable(false)]
public bool CaptureOnMouseDown { get; set; }Property Value
Children
Gets the collection of elements that are child elements in the element tree.
Declaration
[Browsable(false)]
public virtual RadElementCollection Children { get; }Property Value
ChildrenHierarchy
Enumerates entire subtree of elements (using depth-first approach), starting from this one as a root.
Declaration
[Browsable(false)]
public IEnumerable<RadElement> ChildrenHierarchy { get; }Property Value
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
[StyleBuilderReadOnly]
public string Class { get; set; }Property Value
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
[Bindable(true)]
[SettingsBindable(true)]
public ClickMode ClickMode { get; set; }Property Value
ClipDrawing
Indicates whether the painting of the element and its children should be restricted to its bounds.
ContainsFocus
Determines whether the element or one of its descendants currently contains the keyboard focus.
Declaration
[Browsable(false)]
public bool ContainsFocus { get; }Property Value
ContainsMouse
Determines whether the element or one of its descendants currently contains the mouse.
Declaration
[Browsable(false)]
public bool ContainsMouse { get; set; }Property Value
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
DesiredSize
Gets the element desired size.
DoubleClickEnabled
Gets or sets a value indicating whether the DoubleClick event will fire for this item.
Declaration
[Browsable(false)]
public virtual bool DoubleClickEnabled { get; set; }Property Value
DpiScaleFactor
Gets or sets the DPI scale factor for the element.
Declaration
public SizeF DpiScaleFactor { get; protected set; }Property Value
ElementState
Gets the current state of the element.
Declaration
[Browsable(false)]
public ElementState ElementState { get; }Property Value
ElementTree
Gets a reference to the tree object, that contains information about the scene where the element is currently visualized.
Declaration
[Browsable(false)]
public virtual ComponentThemableElementTree ElementTree { get; }Property Value
Enabled
Gets or sets a value indicating whether the element can respond to user interaction.
Declaration
public virtual bool Enabled { get; set; }Property Value
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
public virtual RadFitToSizeMode FitToSizeMode { get; set; }Property Value
InvalidateChildrenOnChildChanged
Provide for use within TelerikLayoutEngine.
Declaration
[Browsable(false)]
public virtual bool InvalidateChildrenOnChildChanged { get; set; }Property Value
IsAbleToRespondToMouseEvents
Gets a value indicating whether the element can respond to mouse input and has input focus.
Declaration
protected bool IsAbleToRespondToMouseEvents { get; }Property Value
IsArrangeValid
Declaration
[Browsable(false)]
public bool IsArrangeValid { get; }Property Value
IsElementVisible
Gets a value indicating if the element is visible.
Declaration
[Browsable(false)]
public virtual bool IsElementVisible { get; }Property Value
IsFocused
Gets a value indicating whether the element has input focus.
IsLayoutSuspended
Gets a value indicating whether the layout is suspended or not.
IsMeasureValid
Declaration
[Browsable(false)]
public bool IsMeasureValid { get; }Property Value
IsMouseDown
Gets or sets a value indicating whether the mouse button has been pressed when inside the bounds of the element.
Declaration
[Browsable(false)]
public bool IsMouseDown { get; set; }Property Value
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
[Browsable(false)]
public bool IsMouseOver { get; set; }Property Value
IsMouseOverElement
Gets or sets a value indicating whether the mouse has entered the bounds of the element.
Declaration
[Browsable(false)]
public bool IsMouseOverElement { get; set; }Property Value
IsThemeApplied
Gets a value indicating if theme finished applying
Declaration
[Browsable(false)]
public bool IsThemeApplied { get; }Property Value
LayoutableChildrenCount
Gets the count of all elements, which visibility is not Collapsed.
Declaration
[Browsable(false)]
public int LayoutableChildrenCount { get; }Property Value
Location
Gets or sets the location of the element based on the element parent rectangle. Corresponds to Bounds.Location
Declaration
[Browsable(true)]
public virtual Point Location { get; set; }Property Value
Margin
Gets or sets a value corresponding to the margins of the element. Margins are not included into the element's bounding rectangle.
MaxSize
Get or sets the maximum size to apply on an element when layout is calculated.
MinSize
Get or sets the minimum size to apply on an element when layout is calculated.
Name
Represents the element unique name.
Declaration
[Browsable(false)]
[StyleBuilderReadOnly]
public virtual string Name { get; set; }Property Value
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
[Browsable(false)]
public virtual bool NotifyParentOnMouseInput { get; set; }Property Value
Padding
Gets or sets the padding sizes of the element. The paddings are included into the element's bounding rectangle.
Parent
Gets a reference to the parent element in the visual element tree.
Declaration
[Browsable(false)]
public RadElement Parent { get; }Property Value
PositionOffset
Gets or sets the offset of the origin of the coordinate system used when painting the element and its children.
Declaration
public virtual SizeF PositionOffset { get; set; }Property Value
Remarks
TrnslateTransform of the graphics is used prior to painting the element and after painting element children, to reset the transformation
PropagateStyleToChildren
Defines whether stylesheet rules should be applied for this element and its children, or only for this element
Declaration
[Browsable(false)]
public virtual bool PropagateStyleToChildren { get; }Property Value
RenderingMaxFramerate
Gets or sets a value indicating maximum rendered frames per second.
Declaration
public static int RenderingMaxFramerate { get; set; }Property Value
RightToLeft
Gets or sets the direction of flow of the elements and whether elements are aligned to support locales using right-to-left fonts.
RoutedEventBehaviors
Gets the routed event behaviors collection for this element.
Declaration
[Browsable(false)]
public RoutedEventBehaviorCollection RoutedEventBehaviors { get; }Property Value
ScaleTransform
Gets or sets a value indicating the scale transform factors, when painting the element and its children.
Declaration
public virtual SizeF ScaleTransform { get; set; }Property Value
ScreenTip
Declaration
[TypeConverter(typeof(RadFilteredPropertiesConverter))]
public virtual RadScreenTipElement ScreenTip { get; set; }Property Value
SerializeChildren
Gets or sets whether the children of this element should be serialized
Declaration
[Browsable(true)]
public virtual bool SerializeChildren { get; set; }Property Value
SerializeElement
Gets or sets whether the element should be serialized in designer
Declaration
[Browsable(false)]
public virtual bool SerializeElement { get; set; }Property Value
SerializeProperties
Gets or sets whether the properties of this element should be serialized
Declaration
[Browsable(true)]
public virtual bool SerializeProperties { get; set; }Property Value
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
[TypeConverter(typeof(ElementShapeConverter))]
public virtual ElementShape Shape { get; set; }Property Value
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 UITypeEditor.
ShouldApplyTheme
Gets a value indicating if a theme should be applied
Declaration
[Browsable(false)]
public virtual bool ShouldApplyTheme { get; set; }Property Value
ShouldHandleMouseInput
Specifies whether the Item should handle MouseOver, MouseMove and related mouse events.
Declaration
[Browsable(false)]
public virtual bool ShouldHandleMouseInput { get; set; }Property Value
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
public virtual bool ShouldPaint { get; set; }Property Value
Remarks
Children visibility is not be affected.
ShouldPaintUsingParentShape
Declaration
protected virtual bool ShouldPaintUsingParentShape { get; }Property Value
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
[Browsable(true)]
public virtual Size Size { get; set; }Property Value
StretchHorizontally
Declaration
public virtual bool StretchHorizontally { get; set; }Property Value
StretchVertically
Declaration
public virtual bool StretchVertically { get; set; }Property Value
Style
Gets or sets the stylesheet associated with the element.
Declaration
[Browsable(false)]
[TypeConverter(typeof(ComponentConverter))]
public StyleSheet Style { get; set; }Property Value
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
[Bindable(true)]
[TypeConverter(typeof(StringConverter))]
public object Tag { get; set; }Property Value
ThemeEffectiveType
Declaration
protected virtual Type ThemeEffectiveType { get; }Property Value
TotalTransform
Declaration
[Browsable(false)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public RadMatrix TotalTransform { get; }Property Value
Transform
Declaration
[Browsable(false)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public RadMatrix Transform { get; }Property Value
TreeLevel
Gets the level of this element in the ElementTree it currently resides.
UseCenteredAngleTransform
Gets a value indicating whether the AngleTransform should use the center of the object as origin for the transformation.
Declaration
[Browsable(false)]
public bool UseCenteredAngleTransform { get; set; }Property Value
UseCompatibleTextRendering
Determines whether to use compatible text rendering engine (GDI+) or not (GDI).
Declaration
public virtual bool UseCompatibleTextRendering { get; set; }Property Value
UseSystemSkin
Gets or sets the mode that describes the usage of system skinning (if available).
Declaration
public virtual UseSystemSkinMode UseSystemSkin { get; set; }Property Value
Implements
Visibility
Gets or sets a value indicating element visibility.
Declaration
public virtual ElementVisibility Visibility { get; set; }Property Value
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.
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).
Methods
AddBehavior(PropertyChangeBehavior)
Adds a property change behavior to the list of behaviors of the element.
Declaration
public void AddBehavior(PropertyChangeBehavior behavior)Parameters
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)
Declaration
public void AddRangeBehavior(PropertyChangeBehaviorCollection behaviors)Parameters
behaviors
PropertyChangeBehaviorCollection
list of behaviors
AddStylePropertySetting(IPropertySetting)
Registers a style setting for this instance.
Declaration
protected override ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)Parameters
setting
Returns
Overrides
Arrange(RectangleF)
Positions and sizes the element within the specified rectangular area.
Declaration
public void Arrange(RectangleF finalRect)Parameters
finalRect
The final rectangular area allocated for this element by its parent.
Exceptions
Thrown when finalRect contains infinity or NaN values.
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.
ArrangeCore(RectangleF)
Performs the core arrangement logic for the element within the specified final rectangle.
Declaration
protected virtual void ArrangeCore(RectangleF finalRect)Parameters
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
finalSize
The size that is available for element.
Returns
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.
CallCreateChildElements()
Creates the child elements and sets their locally applied values as Default
Declaration
protected virtual void CallCreateChildElements()CanExecuteLayoutOperation()
Determines whether the element can perform layout operation.
Declaration
protected virtual bool CanExecuteLayoutOperation()Returns
True if layout operations can be performed, false otherwise.
CanRaisePropertyChangeNotifications(RadPropertyValue)
Determines whether the object can raise PropertyChanging and PropertyChanged notifications. Current implementation checks whether the object is disposing or is already disposed of.
Declaration
protected override bool CanRaisePropertyChangeNotifications(RadPropertyValue propVal)Parameters
propVal
Returns
Overrides
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.
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()
Releases managed resources by clearing the property store and disposing value animators to prevent memory leaks.
Declaration
protected override void DisposeManagedResources()Overrides
DoDoubleClick(EventArgs)
Declaration
protected virtual void DoDoubleClick(EventArgs e)Parameters
e
DoMouseDown(MouseEventArgs)
Called when the mouse button is pressed down over this element.
Declaration
protected virtual void DoMouseDown(MouseEventArgs e)Parameters
e
The mouse event arguments.
DoMouseEnter(EventArgs)
Called when the mouse enters this element.
Declaration
protected virtual void DoMouseEnter(EventArgs e)Parameters
e
The event arguments.
DoMouseHover(EventArgs)
Called when the mouse hovers over this element.
Declaration
protected virtual void DoMouseHover(EventArgs e)Parameters
e
The event arguments.
DoMouseLeave(EventArgs)
Called when the mouse leaves this element.
Declaration
protected virtual void DoMouseLeave(EventArgs e)Parameters
e
The event arguments.
DoMouseMove(MouseEventArgs)
Called when the mouse is moved over this element.
Declaration
protected virtual void DoMouseMove(MouseEventArgs e)Parameters
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
e
The mouse event arguments.
DoMouseWheel(MouseEventArgs)
Declaration
protected virtual void DoMouseWheel(MouseEventArgs e)Parameters
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
scaleFactor
The new DPI scale factor.
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
The filter that defines the match criteria.
traverseMode
The mode used to traverse the subtree.
Returns
IEnumerable<RadElement>
An enumerable collection of descendant elements matching the filter.
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
predicate
The filter that defines the match criteria.
traverseMode
The mode used to traverse the subtree.
Returns
IEnumerable<RadElement>
An enumerable collection of descendant elements matching the predicate.
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
traverseMode
The mode used to traverse the subtree.
Returns
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 : RadElementReturns
T
The first parent element of the specified type; otherwise, null.
FindAncestorByThemeEffectiveType(Type)
Searches up the parent chain and returns the first parent with the provided ThemeEffectiveType.
Declaration
public RadElement FindAncestorByThemeEffectiveType(Type themeEffectiveType)Parameters
themeEffectiveType
The theme effective type to search for.
Returns
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
criteria
The predicate used to filter elements.
Returns
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
descendantType
The type of descendant element to search for.
Returns
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 : RadElementReturns
T
The first descendant element of the specified type; otherwise, null.
Focus()
Attempts to set the keyboard focus to the element.
Declaration
public virtual bool Focus()Returns
True if the keyboard focus is successfully set to the element; otherwise, false.
Focus(bool)
Attempts to set the keyboard focus to the element, optionally setting parent control focus.
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
The filter used to match ancestor elements.
Returns
IEnumerable<RadElement>
An enumerable collection of ancestor elements matching the filter.
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
predicate
The predicate used to filter parents.
Returns
IEnumerable<RadElement>
An enumerable collection of ancestor elements matching the predicate.
GetArrangeRect(RectangleF)
Gets the arrange rectangle, valid for this element.
Declaration
protected virtual RectangleF GetArrangeRect(RectangleF proposed)Parameters
proposed
The proposed rectangle.
Returns
The arrange rectangle for this element.
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
element
Returns
GetBoundingRectangle(Rectangle)
Gets the rectangle which surrounds the rotated element (if having AngleTransform property set).
GetBoundingRectangle(Size)
Gets the rectangle which surrounds the rotated element (if having AngleTransform property set).
GetChildren(ChildrenListOptions)
Allows enumerating of this element's children, using the specified options.
Declaration
public IEnumerable<RadElement> GetChildren(ChildrenListOptions options)Parameters
options
The enumeration options to use.
Returns
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
type
The base type to filter child elements by.
Returns
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
type
The type to filter child elements by.
Returns
List<RadElement>
A list of child elements of the specified type.
GetClientRectangle(SizeF)
Declaration
protected virtual RectangleF GetClientRectangle(SizeF finalSize)Parameters
finalSize
Returns
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
The filter used to match descendant elements.
traverseMode
The mode used to traverse the subtree.
Returns
List<RadElement>
A list of descendant elements matching the filter.
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
predicate
The predicate used to filter descendant elements.
traverseMode
The mode used to traverse the subtree.
Returns
List<RadElement>
A list of descendant elements matching the predicate.
GetDesiredSize(bool)
Gets the desired size of the element, optionally checking if the element is collapsed.
GetInvalidateBounds()
Returns the bounds of the area that should be invalidated when the element is invalidated.
Declaration
public virtual Rectangle GetInvalidateBounds()Returns
The bounds to invalidate.
GetPaintRectangle(float, float, SizeF)
Declaration
protected RectangleF GetPaintRectangle(float borderWidth, float angle, SizeF scale)Parameters
borderWidth
angle
scale
Returns
GetPatchedRect(RectangleF, float, SizeF)
Declaration
protected RectangleF GetPatchedRect(RectangleF rect, float angle, SizeF scale)Parameters
rect
angle
scale
Returns
GetRegisterRoutedEvent(string)
Gets a registered routed event by name for this element's type.
Declaration
public RoutedEvent GetRegisterRoutedEvent(string eventName)Parameters
eventName
The name of the routed event.
Returns
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
eventName
The name of the routed event.
ownerType
The type that owns the routed event.
Returns
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
eventName
The name of the routed event.
className
The name of the class that owns the routed event.
Returns
The registered routed event if found; otherwise, null.
GetStylableChildren()
Declaration
protected virtual IEnumerable<RadObject> GetStylableChildren()Returns
IEnumerable<RadObject>
GetStylableChildrenHierarchy()
Declaration
protected virtual IEnumerable<RadObject> GetStylableChildrenHierarchy()Returns
IEnumerable<RadObject>
GetStylablePropertiesFilter()
Gets the IFilter instance that may be used to filter the properties, treated as Stylable for this element.
GetSystemSkinPaintBounds()
Gets the rectangle where skin background should be painted. Defaults to BoundingRectangle.
Declaration
protected virtual Rectangle GetSystemSkinPaintBounds()Returns
The rectangle where skin background should be painted.
GetValue(RadProperty)
Retrieves the current effective value for the specified RadProperty, resolving through the property value composition hierarchy.
Declaration
public override object GetValue(RadProperty property)Parameters
property
The RadProperty for which to retrieve the current value.
Returns
The current effective value of the property, which may come from local, style, inherited, or default value sources.
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
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
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
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.
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(bool)
Invalidates the element and schedules it for repainting, optionally checking if layout is suspended.
Declaration
public void Invalidate(bool checkSuspended)Parameters
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(bool)
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
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(bool)
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
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.
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
element
An instance of the RadElement class which is checked.
Returns
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
parent
Parent to test
Returns
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
raisedEvent
The routed event to check for processing status.
Returns
True if the event is currently being processed; otherwise, false.
IsInValidState(bool)
Determines whether the element is currently in valid state. That is having a valid ElementTree reference and being in either Constructed or Loaded state.
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
e
The input key event arguments.
Returns
True if the key is an input key; otherwise, false.
IsPropertyCancelable(RadPropertyMetadata)
Determines whether the specified property may be canceled.
Declaration
protected override bool IsPropertyCancelable(RadPropertyMetadata metadata)Parameters
metadata
The metadata associated with the property change.
Returns
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
The location in control coordinates.
LockBounds()
Locks the bounds of the element to prevent changes during critical operations.
Declaration
protected virtual void LockBounds()Measure(SizeF)
Calculates the desired size of the element given the specified available space.
Declaration
public void Measure(SizeF availableSize)Parameters
availableSize
The available space that can be allocated to this element by its parent.
Exceptions
Thrown when availableSize contains NaN values.
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.
MeasureCore(SizeF)
Performs the core measurement logic for the element with the specified available size.
MeasureOverride(SizeF)
Measures the space required by the RadElement
Used by the layout system.
Declaration
protected virtual SizeF MeasureOverride(SizeF availableSize)Parameters
availableSize
The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
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
e
The mouse event arguments to convert.
Returns
Mouse event arguments with coordinates relative to this element.
NotifyChildren(RadPropertyChangedEventArgs)
Declaration
protected virtual void NotifyChildren(RadPropertyChangedEventArgs e)Parameters
e
NotifyInvalidate(RadElement)
Declaration
protected virtual void NotifyInvalidate(RadElement invalidatedChild)Parameters
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
e
OnBubbleEvent(RadElement, RoutedEventArgs)
Called when the bubble phase of a routed event occurs.
Declaration
protected virtual void OnBubbleEvent(RadElement sender, RoutedEventArgs args)Parameters
sender
The element that originally raised the event.
args
The routed event arguments.
OnCLREventsRise(RoutedEventArgs)
Declaration
protected virtual void OnCLREventsRise(RoutedEventArgs args)Parameters
args
OnChildDesiredSizeChanged(RadElement)
Called when a child's desired size has changed.
Declaration
protected virtual void OnChildDesiredSizeChanged(RadElement child)Parameters
child
The child element whose desired size changed.
OnChildrenChanged(RadElement, ItemsChangeOperation)
Declaration
protected virtual void OnChildrenChanged(RadElement child, ItemsChangeOperation changeOperation)Parameters
child
changeOperation
OnClick(EventArgs)
Raises the Click event.
OnDisplayPropertyChanged(RadPropertyChangedEventArgs)
Declaration
protected virtual void OnDisplayPropertyChanged(RadPropertyChangedEventArgs e)Parameters
e
OnDoubleClick(EventArgs)
Raises the DoubleClick event.
Declaration
protected virtual void OnDoubleClick(EventArgs e)Parameters
e
OnElementTreeChanged(ComponentThemableElementTree)
The element gets notified for a change in its current ElementTree member.
Declaration
protected virtual void OnElementTreeChanged(ComponentThemableElementTree previousTree)Parameters
previousTree
The previous element tree instance.
OnEnabledChanged(RadPropertyChangedEventArgs)
Declaration
protected virtual void OnEnabledChanged(RadPropertyChangedEventArgs e)Parameters
e
OnLayoutPropertyChanged(RadPropertyChangedEventArgs)
Called when a layout property has changed.
Declaration
protected virtual void OnLayoutPropertyChanged(RadPropertyChangedEventArgs e)Parameters
e
The property changed event arguments.
OnLoad(bool)
A callback used by the owning RadControl to notify the element for a first-time screen visualization.
Declaration
protected void OnLoad(bool recursive)Parameters
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
e
OnLostMouseCapture(MouseEventArgs)
Declaration
protected virtual void OnLostMouseCapture(MouseEventArgs e)Parameters
e
OnMouseDown(MouseEventArgs)
Declaration
protected virtual void OnMouseDown(MouseEventArgs e)Parameters
e
OnMouseEnter(EventArgs)
Declaration
protected virtual void OnMouseEnter(EventArgs e)Parameters
e
OnMouseHover(EventArgs)
Declaration
protected virtual void OnMouseHover(EventArgs e)Parameters
e
OnMouseLeave(EventArgs)
Declaration
protected virtual void OnMouseLeave(EventArgs e)Parameters
e
OnMouseMove(MouseEventArgs)
Declaration
protected virtual void OnMouseMove(MouseEventArgs e)Parameters
e
OnMouseUp(MouseEventArgs)
Declaration
protected virtual void OnMouseUp(MouseEventArgs e)Parameters
e
OnMouseWheel(MouseEventArgs)
Raises the MouseWheel event.
Declaration
protected virtual void OnMouseWheel(MouseEventArgs e)Parameters
e
The mouse event arguments.
OnParentChanged(RadElement)
Notifies for a change in the Parent value.
Declaration
protected virtual void OnParentChanged(RadElement previousParent)Parameters
previousParent
The previous parent element (if any)
OnParentEnabledChanged(RadPropertyChangedEventArgs)
Declaration
protected virtual void OnParentEnabledChanged(RadPropertyChangedEventArgs e)Parameters
e
OnParentPropertyChanged(RadPropertyChangedEventArgs)
The object gets notified for a parent property change.
Declaration
protected virtual void OnParentPropertyChanged(RadPropertyChangedEventArgs args)Parameters
args
OnPropertyChanged(RadPropertyChangedEventArgs)
Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)Parameters
e
The RadPropertyChangedEventArgs containing information about the property change.
Overrides
OnRenderSizeChanged(SizeChangedInfo)
Called when the render size of the element has changed.
Declaration
protected virtual void OnRenderSizeChanged(SizeChangedInfo info)Parameters
info
The size change information.
OnShowScreenTip(ComponentInputBehavior)
Shows a screen tip.
Declaration
protected virtual bool OnShowScreenTip(ComponentInputBehavior inputBehavior)Parameters
inputBehavior
The input behavior.
Returns
A value indicating whether a screen tip is shown.
OnStyleChanged(RadPropertyChangedEventArgs)
Declaration
protected virtual void OnStyleChanged(RadPropertyChangedEventArgs e)Parameters
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
sender
The element that originally raised the event.
args
The routed event arguments.
OnUnload(ComponentThemableElementTree, bool)
Unloads the element if it was previously loaded on an element tree.
Declaration
protected void OnUnload(ComponentThemableElementTree oldTree, bool recursive)Parameters
oldTree
Reference to the element tree from which we are in a process of unload.
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
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
e
PaintBackgroundShape(IGraphics)
Declaration
protected virtual void PaintBackgroundShape(IGraphics graphics)Parameters
graphics
PaintChild(RadElement, IGraphics, Rectangle, float, SizeF, bool)
Declaration
protected virtual void PaintChild(RadElement child, IGraphics graphics, Rectangle clipRectange, float angle, SizeF scale, bool useRelativeTransformation)Parameters
child
graphics
clipRectange
angle
scale
useRelativeTransformation
PaintElementSkin(IGraphics)
Provides a routine to paint element's content when system skin appearance is desired.
Declaration
protected virtual void PaintElementSkin(IGraphics graphics)Parameters
graphics
PaintOverride(IGraphics, Rectangle, float, SizeF, bool)
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
graphics
The graphics object.
clipRectangle
The rectangle which has been invalidated.
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.
scale
useRelativeTransformation
PaintShadow(RadElement, IGraphics)
Declaration
protected virtual void PaintShadow(RadElement child, IGraphics graphics)Parameters
child
graphics
PerformClick()
Triggers the Click event for the element.
Declaration
public virtual void PerformClick()PerformDispose(bool)
Performs the core resources release logic.
Declaration
protected override void PerformDispose(bool disposing)Parameters
disposing
Overrides
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.
PointFromScreen(Point)
Retrieves a point in control coordinates taking as a parameter a point which is in screen 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.
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).
PostPaintElement(IGraphics)
Declaration
protected virtual void PostPaintElement(IGraphics graphics)Parameters
graphics
PrePaintElement(IGraphics)
Declaration
protected virtual void PrePaintElement(IGraphics graphics)Parameters
graphics
ProcessBehaviors(RadPropertyChangedEventArgs)
Declaration
protected virtual void ProcessBehaviors(RadPropertyChangedEventArgs e)Parameters
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
sender
The element that originally raised the event.
args
The routed event arguments.
RaiseDoubleClick(EventArgs)
Declaration
protected virtual void RaiseDoubleClick(EventArgs e)Parameters
e
RaiseMouseWheel(MouseEventArgs)
Declaration
protected virtual void RaiseMouseWheel(MouseEventArgs e)Parameters
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
sender
The element that originally raised the event.
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
sender
The element that originally raised the event.
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).
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
eventName
The name of the routed event.
ownerType
The type that owns the routed event.
Returns
The registered routed event.
RemoveBehavior(PropertyChangeBehavior)
Declaration
public void RemoveBehavior(PropertyChangeBehavior behavior)Parameters
behavior
RemoveBehaviors(PropertyChangeBehavior)
Declaration
public virtual void RemoveBehaviors(PropertyChangeBehavior behavior)Parameters
behavior
RemoveRangeBehaviors(PropertyChangeBehaviorCollection)
Declaration
public virtual void RemoveRangeBehaviors(PropertyChangeBehaviorCollection propertyChangeBehaviorCollection)Parameters
propertyChangeBehaviorCollection
RemoveRangeRoutedEventBehaviors(RoutedEventBehaviorCollection)
Declaration
public virtual void RemoveRangeRoutedEventBehaviors(RoutedEventBehaviorCollection routedEventBehaviorCollection)Parameters
routedEventBehaviorCollection
ReplaceDefaultDescriptors(PropertyDescriptorCollection)
Add the ElementTree property if we are in the context of RadControlSpy.
Declaration
protected override PropertyDescriptorCollection ReplaceDefaultDescriptors(PropertyDescriptorCollection props)Parameters
props
Returns
Overrides
ResetLayout(bool)
Resets all layout related fields and puts the element in its initial layout state.
Declaration
public void ResetLayout(bool recursive)Parameters
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(bool)
Resets the Style modifier of each registered property.
Declaration
public void ResetStyleSettings(bool recursive)Parameters
recursive
ResetStyleSettings(bool, 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
recursive
property
ResumeLayout(bool)
Resumes layout logic for the element with an option to force immediate layout.
Declaration
public void ResumeLayout(bool performLayout)Parameters
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(bool, bool)
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
recursive
True to resume layout for this element and all its children; false for this element only.
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, bool, bool) method execution. Each call to SuspendReferenceUpdate() must be paired with a corresponding call to this method.
Declaration
public void ResumeReferenceUpdate()SendToBack()
Sends this element to the beginning of its parent's z-ordered collection.
Declaration
public void SendToBack()SetBounds(Rectangle)
Sets the bounds of the element to the specified rectangle (locating and size).
Declaration
public void SetBounds(Rectangle bounds)Parameters
bounds
The rectangle that represents the new location and size.
SetBounds(int, int, int, int)
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
x
The new X coordinate for the upper-left corner of the element.
y
The new Y coordinate for the upper-left corner of the element.
width
The new width of the element.
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
bounds
The rectangle to set as bounds.
SetClipping(Graphics)
Declaration
protected virtual void SetClipping(Graphics rawGraphics)Parameters
rawGraphics
SetFocusPropertySafe(bool)
Sets the focused state of an element safely without recursion.
Declaration
protected void SetFocusPropertySafe(bool isFocused)Parameters
isFocused
The new focused state.
SetParent(RadElement)
Applies the specified RadElement instance as parent of the current instance.
Declaration
protected void SetParent(RadElement parent)Parameters
parent
The parent element to set.
SetThemeApplied(bool)
Used internally to support RadControl infrastructure. This method is not intended for use directly from your code.
Declaration
protected void SetThemeApplied(bool newValue)Parameters
newValue
SetValueCore(RadPropertyValue, object, object, ValueSource)
Performs the core logic of updating property value.
Declaration
protected override ValueUpdateResult SetValueCore(RadPropertyValue propVal, object propModifier, object newValue, ValueSource source)Parameters
propVal
The property value structure, holding property information.
propModifier
Additional modifier, like IPropertySetting
newValue
The actual new value to be set, valid for Local and DefaultValue sources.
source
Specifies the source of the provided new value.
Returns
The result of the operation.
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
child
The child element to check.
Returns
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
child
The child.
Returns
Whether the child will be measured in MeasureOverride.
ShouldPaintChild(RadElement)
Declaration
protected virtual bool ShouldPaintChild(RadElement element)Parameters
element
Returns
ShouldPaintSystemSkin()
Determines whether we should paint system skin.
ShowScreenTip(ScreenTipNeededEventArgs)
Shows a screen tip for this element.
Declaration
protected virtual void ShowScreenTip(ScreenTipNeededEventArgs args)Parameters
args
The screen tip event arguments.
SuspendLayout()
Temporarily suspends layout operations upon this element.
Declaration
public void SuspendLayout()SuspendLayout(bool)
Temporarily suspends layout operations upon this element.
Declaration
public virtual void SuspendLayout(bool recursive)Parameters
recursive
True to suspend children also, false otherwise.
SuspendReferenceUpdate()
Temporarily suspends the UpdateReferences(ComponentThemableElementTree, bool, bool) method execution. This is useful when modifying the element tree structure without triggering immediate reference updates.
Declaration
public void SuspendReferenceUpdate()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
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(bool)
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
isFocused
The current focused state.
UpdateLayout()
Forces the element to update its layout by processing any pending measure and arrange operations.
Declaration
public void UpdateLayout()UpdateReferences(ComponentThemableElementTree, bool, bool)
Updates the local references using the provided element tree.
Declaration
protected virtual void UpdateReferences(ComponentThemableElementTree tree, bool updateInheritance, bool recursive)Parameters
tree
The element tree to use for updating references.
updateInheritance
True to update inheritance chain, false otherwise.
recursive
True to update children also, false otherwise.
Events
ChildrenChanged
Occurs when the children collection of the element is changed.
Declaration
[Browsable(true)]
public event ChildrenChangedEventHandler ChildrenChangedEvent Value
Click
Occurs when the element is clicked.
Declaration
[Browsable(true)]
public event EventHandler ClickEvent Value
DoubleClick
Occurs when the element is double-clicked.
Declaration
[Browsable(true)]
public virtual event EventHandler DoubleClickEvent Value
EnabledChanged
Occurs when the enabled state of the element has changed.
LayoutUpdated
Declaration
[Browsable(false)]
public event EventHandler LayoutUpdatedEvent Value
LostMouseCapture
Declaration
public event MouseEventHandler LostMouseCaptureEvent Value
MouseDown
Occurs when the mouse pointer is over the element and a mouse button is pressed.
Declaration
[Browsable(true)]
public event MouseEventHandler MouseDownEvent Value
MouseEnter
Occurs when the mouse pointer enters the element.
Declaration
[Browsable(false)]
public event EventHandler MouseEnterEvent Value
MouseHover
Occurs when the mouse pointer rests on the element.
Declaration
[Browsable(false)]
public event EventHandler MouseHoverEvent Value
MouseLeave
Occurs when the mouse pointer leaves the element.
Declaration
[Browsable(false)]
public event EventHandler MouseLeaveEvent Value
MouseMove
Occurs when the mouse pointer is moved over the element.
Declaration
[Browsable(false)]
public event MouseEventHandler MouseMoveEvent Value
MouseUp
Occurs when the mouse pointer is over the element and a mouse button is released.
Declaration
[Browsable(false)]
public event MouseEventHandler MouseUpEvent Value
MouseWheel
Occurs when the RadItem has focus and the user scrolls up or down the mouse wheel
Declaration
[Browsable(true)]
public event MouseEventHandler MouseWheelEvent Value