IUIElement Interface

public interface IUIElement : ILogicalTreeNode, IDpiAwareElement, IDisposable

int ActualHeight { get; }

Property Value

int:

The actual height of the element.

Remarks

This is determined by the layout system after Arrange(Rectangle) has completed. This is only valid if IsArrangeValid is true.

int ActualWidth { get; }

Property Value

int:

The actual width of the element.

Remarks

This is determined by the layout system after Arrange(Rectangle) has completed. This is only valid if IsArrangeValid is true.

Rectangle Bounds { get; }

Property Value

Rectangle:

A Rectangle specifying the bounds of the element.

Rectangle ClipBounds { get; }

Property Value

Rectangle:

A Rectangle specifying the clip bounds when drawing the element.

Size DesiredSize { get; }

Property Value

Size:

The desired size of the element as computed by Measure(Graphics, Size).

Remarks

This is only valid if IsMeasureValid is true.

bool IsArrangeValid { get; }

Property Value

bool:

true if the value of the DesiredSize property and position of child elements is valid; otherwise, false.

Remarks

A developer can force arrangement to be invalidated by calling InvalidateArrange(). IsArrangeValid and IsMeasureValid are related, in that arrangement cannot be valid without measurement first being valid.

bool IsMeasureValid { get; }

Property Value

bool:

true if the value of the DesiredSize property is valid; otherwise, false.

Remarks

A developer can force arrangement to be invalidated by calling InvalidateMeasure(). IsArrangeValid and IsMeasureValid are related, in that arrangement cannot be valid without measurement first being valid.

bool IsRightToLeft { get; }

Property Value

bool:

true if the element is using a right-to-left layout; otherwise, false.

Size Size { get; }

Property Value

Size:

The actual size of the element.

Remarks

This is determined by the layout system after Arrange(Rectangle) has completed. This is only valid if IsArrangeValid is true.

Visibility Visibility { get; set; }

Property Value

Visibility:

The Visibility of the element.

Point VisualOffset { get; }

Property Value

Point:

The X/Y offset of the element relative to its parent element's coordinate system.

Remarks

This is determined by the layout system after Arrange(Rectangle) has completed. This is only valid if IsArrangeValid is true.

void Arrange(Rectangle newBounds)

Parameter	Type	Description
newBounds	Rectangle	The final bounds of the element.

bool ContainsLocation(Point location)

Parameter	Type	Description
location	Point	The Point location to examine.

Returns

bool:

true if this element's bounds contains the specified location; otherwise, false.

Remarks

Override this method to prevent certain portions of the element's bounds from being included in hit-testing.

Graphics CreateGraphics()

Returns

Graphics:

The Graphics object for the object.

UIElementDrawState GetDrawState()

Returns

UIElementDrawState:

The UIElementDrawState for the element.

Remarks

The default implementation of this method returns UIElementDrawState.None.

PointHitTestResult HitTest(PointHitTestParameters hitTestParams)

Parameter	Type	Description
hitTestParams	PointHitTestParameters	A PointHitTestParameters containing hit test parameters.

Returns

PointHitTestResult:

A PointHitTestResult containing the hit test result.

PointHitTestResult HitTest(PointHitTestParameters hitTestParams, Func<IUIElement, PointHitTestParameters, bool> filter)

Parameter	Type	Description
hitTestParams	PointHitTestParameters	A PointHitTestParameters containing hit test parameters.
filter	Func<IUIElement, PointHitTestParameters, bool>	Optionally defines a filter which must return true for an element to match the hit test.

Returns

PointHitTestResult:

A PointHitTestResult containing the hit test result.

PointHitTestResult HitTestRecursive(PointHitTestParameters hitTestParams)

Parameter	Type	Description
hitTestParams	PointHitTestParameters	A PointHitTestParameters containing hit test parameters.

Returns

PointHitTestResult:

A PointHitTestResult containing the hit test result.

PointHitTestResult HitTestRecursive(PointHitTestParameters hitTestParams, Func<IUIElement, PointHitTestParameters, bool> filter)

Parameter	Type	Description
hitTestParams	PointHitTestParameters	A PointHitTestParameters containing hit test parameters.
filter	Func<IUIElement, PointHitTestParameters, bool>	Optionally defines a filter which must return true for an element to match the hit test.

Returns

PointHitTestResult:

A PointHitTestResult containing the hit test result.

void Invalidate(InvalidationLevels levels, InvalidationTypes types)

Parameter	Type	Description
levels	InvalidationLevels	The hierarchy levels at which to invalidate.
types	InvalidationTypes	The types of invalidation to perform.

void InvalidateArrange()

void InvalidateMeasure()

void Measure(Graphics g, Size availableSize)

Parameter	Type	Description
g	Graphics	The Graphics object to use for measurement.
availableSize	Size	The available size that parent can give to the child. The child can return bigger in hopes that the parent will become scrollable. The value may also be infinity to indicate that the desired measurements of the element are wanted.

Remarks

The Measure(Graphics, Size) method should be called by parents on their children. Internally, Measure(Graphics, Size) calls the MeasureCore override on the same object, giving it opportunity to compute its DesiredSize. This method will return immediately if the child's measurements are valid, previously measured and availableSize is the same as cached. This method also resets the IsMeasureValid bit on the child.

void NotifyChildDesiredSizeChanged()

void NotifyMouseLeaveEvent()

Remarks

This enables the object to cancel hot state tracking.

void Render(PaintEventArgs e)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.

GeneralTransform TransformToAncestor(IUIElement ancestor)

Parameter	Type	Description
ancestor	IUIElement	The ancestor IUIElement.

Returns

GeneralTransform:

A GeneralTransform from this element to a ancestor element.

GeneralTransform TransformToDescendant(IUIElement descendant)

Parameter	Type	Description
descendant	IUIElement	The descendant IUIElement.

Returns

GeneralTransform:

A GeneralTransform from this element to a descendant element.