InsetClip Class

Definition

Namespace:

Windows.UI.Composition

Represents a rectangle that clips a portion of a visual. The portion of the visual inside the rectangle is visible; the portion of the visual outside the rectangle is clipped.

public ref class InsetClip sealed : CompositionClip

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
class InsetClip final : CompositionClip

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
public sealed class InsetClip : CompositionClip

Public NotInheritable Class InsetClip
Inherits CompositionClip

Inheritance

Object Platform::Object IInspectable CompositionObject CompositionClip InsetClip

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

InsetClip is functionally similar to RectangleClip, but RectangleClip allows you to round the corners of the clipping rectangle.

An InsetClip is defined using offsets in pixels from the bottom, left, right, and top of the Visual to be clipped.

To clip a Visual, you assign the InsetClip to the Clip property of the Visual.

It is possible to fully clip the entire Visual. Negative values are allowed. InsetClip supports all the same transforms as Visual except the 4x4 matrix. Unlike Visual, InsetClip is 2D and is defined, instead, with a 3x2 matrix. InsetClip properties are fully animatable.

Properties

AnchorPoint	The point on the clip to be positioned at the clip's offset. Value is normalized with respect to the size of the clip. (Inherited from CompositionClip)
BottomInset	Gets or sets the offset from the bottom of the visual. The portion of the visual below the BottomtInset will be clipped. Animatable.
CenterPoint	The point about which rotation or scaling occurs. (Inherited from CompositionClip)
Comment	A string to associate with the CompositionObject. (Inherited from CompositionObject)
Compositor	The Compositor used to create this CompositionObject. (Inherited from CompositionObject)
Dispatcher	The dispatcher for the CompositionObject. (Inherited from CompositionObject)
DispatcherQueue	Gets the DispatcherQueue for the CompostionObject. (Inherited from CompositionObject)
ImplicitAnimations	The collection of implicit animations attached to this object. (Inherited from CompositionObject)
LeftInset	Gets or sets the offset from the left of the visual. The portion of the visual to the left of the LeftInset will be clipped. Animatable.
Offset	The offset of the clip relative to the visual on which the clip is applied. (Inherited from CompositionClip)
Properties	The collection of properties associated with the CompositionObject. (Inherited from CompositionObject)
RightInset	Gets or sets the offset from the right of the visual. The portion of the visual to the right of the RightInset will be clipped. Animatable.
RotationAngle	The angle of rotation applied to the clip, in radians. (Inherited from CompositionClip)
RotationAngleInDegrees	The angle of rotation applied to the clip, in degrees. (Inherited from CompositionClip)
Scale	The scale to apply to the clip. (Inherited from CompositionClip)
TopInset	Gets or sets the offset from the top of the visual. The portion of the visual above the TopInset will be clipped. Animatable.
TransformMatrix	The 3x2 transformation matrix to apply to the clip. (Inherited from CompositionClip)

Methods

Close()	Closes the CompositionObject and releases system resources. (Inherited from CompositionObject)
ConnectAnimation(String, CompositionAnimation)	Connects and animation. (Inherited from CompositionObject)
DisconnectAnimation(String)	Disconnects an animation. (Inherited from CompositionObject)
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	Starts an animation group. The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object. (Inherited from CompositionObject)
StopAnimation(String)	Disconnects an animation from the specified property and stops the animation. (Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Stops an animation group. (Inherited from CompositionObject)
TryGetAnimationController(String)	Returns an AnimationController for the animation running on the specified property. (Inherited from CompositionObject)

See also

• Clip
• CompositionClip
• IClosable