FrameworkElement.GetLayoutClip(Size) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
protected:
override System::Windows::Media::Geometry ^ GetLayoutClip(System::Windows::Size layoutSlotSize);
protected override System.Windows.Media.Geometry GetLayoutClip (System.Windows.Size layoutSlotSize);
override this.GetLayoutClip : System.Windows.Size -> System.Windows.Media.Geometry
Protected Overrides Function GetLayoutClip (layoutSlotSize As Size) As Geometry
Parameters
- layoutSlotSize
- Size
The size of the part of the element that does visual presentation.
Returns
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.