FrameworkElement::GetLayoutClip Method (Size)

.NET Framework (current version)

Returns a geometry for a clipping mask. The mask applies if the layout system attempts to arrange an element that is larger than the available display space.

Namespace: System.Windows
Assembly: PresentationFramework (in PresentationFramework.dll)

Syntax

C++

protected:
virtual Geometry^ GetLayoutClip(
	Size layoutSlotSize
) override

Parameters

layoutSlotSize: Type: System.Windows::Size
The size of the part of the element that does visual presentation.

Return Value

Type: System.Windows.Media::Geometry^

The clipping geometry.

Remarks

Margins will be subtracted from the layoutSlotSize as part of layout system behavior.

A returned null reference indicates that no clipping will occur. The default implementation always returns null when ClipToBounds is false. This method overrides UIElement::GetLayoutClip. The FrameworkElement implementation uses MaxHeight and MaxWidth in its calculations. Several subclasses of FrameworkElement override this method again. Adorner::GetLayoutClip, overrides to always return null because adorners are often deliberately outside the ordinary bounds. Canvas::GetLayoutClip and InkPresenter::GetLayoutClip return null if ClipToBounds is false.

Notes to Inheritors:

The default implementation always returns null when ClipToBounds is false. Overrides are generally expected to preserve this behavior, although there are exceptions, depending on the relationship and purpose of the derived class and its layout logic as opposed to the base class.

Version Information

.NET Framework
Available since 3.0