InsetClip Class

Definition

Clips a portion of a visual. The visible portion of the visual is a rectangle defined as inset values from the edges of the visual. The portion of the visual outside the rectangle is clipped.

InsetClips are defined using offsets from the bottom, left, right and top of the Visual to be clipped in pixels. It is possible to fully clip the entire Visual. Negative values are allowed. InsetClips support all the same transforms as Visuals except the 4x4 matrix. Unlike Visuals, InsetClips are 2D and are defined, instead, with a 3x2 matrix. InsetClip properties are fully animatable.

public ref class InsetClip sealed : CompositionClip
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.LiftedContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class InsetClip final : CompositionClip
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.LiftedContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public sealed class InsetClip : CompositionClip
Public NotInheritable Class InsetClip
Inherits CompositionClip
Inheritance
Attributes
Windows.Foundation.Metadata.ContractVersionAttribute Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.WebHostHiddenAttribute

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

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)
DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
LeftInset

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

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

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)
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)

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)

Applies to

See also