ContainerVisual Class

Definition

Namespace:

Microsoft.UI.Composition

A node in the visual tree that can have children.

[WebHostHidden]
public ref class ContainerVisual : Visual

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
[WebHostHidden]
class ContainerVisual : Visual

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public class ContainerVisual : Visual

Public Class ContainerVisual
Inherits Visual

Inheritance

Object Platform::Object IInspectable CompositionObject Visual ContainerVisual

Derived

Microsoft.UI.Composition.LayerVisual

Microsoft.UI.Composition.RedirectVisual

Microsoft.UI.Composition.Scenes.SceneVisual

Microsoft.UI.Composition.ShapeVisual

Microsoft.UI.Composition.SpriteVisual

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

//
// Set up Windows.UI.Composition Compositor, root ContainerVisual, and associate with
// the CoreWindow.
//

_compositor = new Compositor();

_root = _compositor.CreateContainerVisual();
_view.CompositionRootVisual = _root;

//
// Create a simple scene.
//

var child = _compositor.CreateSpriteVisual();
child.Brush = _compositor.CreateColorBrush(Color.FromArgb(0xFF, 0x00, 0xCC, 0x00));
child.Offset = new Vector2(50.0f, 50.0f);
child.Size = new Vector2(200, 200);

_root.Children.InsertAtTop(child);

// App.cpp
struct SampleApp : implements<SampleApp, IFrameworkViewSource, IFrameworkView>
{
    ...
    void SetWindow(CoreWindow const& /* window */)
    {
        // Set up Composition.
        m_compositor = Compositor{};
        m_target = m_compositor.CreateTargetForCurrentView();
        m_root = m_compositor.CreateContainerVisual();
        m_target.Root(m_root);

        // Create a simple scene.
        auto child{ m_compositor.CreateSpriteVisual() };
        child.Brush(m_compositor.CreateColorBrush(ColorHelper::FromArgb(0xFF, 0x00, 0xCC, 0x00)));
        child.Offset({ 50.f, 50.f, 0.f });
        child.Size({ 200.f, 200.f });

        m_root.Children().InsertAtTop(child);
    }

private:
    Compositor m_compositor{ nullptr };
    CompositionTarget m_target{ nullptr };
    ContainerVisual m_root{nullptr};
};

ref class MyClass
{
    Compositor ^ _compositor;
    CompositionTarget ^ _target;
    ContainerVisual ^ _root;

    void Initialize()
    {
        //
        // Set up Composition.
        //

        _compositor = ref new Compositor();
        _target = _compositor->CreateTargetForCurrentView();
        _root = _compositor->CreateContainerVisual();
        _target->Root = _root;

        //
        // Create a simple scene.
        //

        auto child = _compositor->CreateSpriteVisual();
        child->Brush = _compositor.CreateColorBrush(ColorHelper::FromArgb(0xFF, 0x00, 0xCC, 0x00));
        child->Offset = float2(50.0f, 50.0f);
        child->Size = float2(200, 200);

        _root->Children->InsertAtTop(child);
    }
}

Properties

AnchorPoint	The point on the visual to be positioned at the visual's offset. Value is normalized with respect to the size of the visual. Animatable. (Inherited from Visual)
BackfaceVisibility	Specifies whether the back face of the visual should be visible during a 3D transform. (Inherited from Visual)
BorderMode	Specifies how to compose the edges of bitmaps and clips associated with a visual, or with all visuals in the subtree rooted at this visual. Setting BorderMode at a parent Visual will affect all children visuals in the subtree and can be selectively turned off at each child visual. (Inherited from Visual)
CenterPoint	The point about which rotation or scaling occurs. Animatable (Inherited from Visual)
Children	The children of the ContainerVisual.
Clip	Specifies the clipping region for the visual. When a visual is rendered, only the portion of the visual that falls inside the clipping region is displayed, while any content that extends outside the clipping region is clipped (that is, not displayed). (Inherited from Visual)
Comment	A string to associate with the CompositionObject. (Inherited from CompositionObject)
CompositeMode	Specifies how a visual's bitmap is blended with the screen. (Inherited from Visual)
Compositor	The Compositor used to create this CompositionObject. (Inherited from CompositionObject)
DispatcherQueue	Gets the DispatcherQueue for the CompositionObject. (Inherited from CompositionObject)
ImplicitAnimations	The collection of implicit animations attached to this object. (Inherited from CompositionObject)
IsHitTestVisible	Gets or sets a value that indicates whether the visual sub-tree rooted at this visual participates in hit testing. (Inherited from Visual)
IsPixelSnappingEnabled	Gets or sets a value that indicates whether the composition engine aligns the rendered visual with a pixel boundary. (Inherited from Visual)
IsVisible	Indicates whether the visual and its entire subtree of child visuals is visible. (Inherited from Visual)
Offset	The offset of the visual relative to its parent or for a root visual the offset relative to the upper-left corner of the windows that hosts the visual. Animatable. (Inherited from Visual)
Opacity	The opacity of the visual. Animatable. The opacity property determines the transparency, if any, of the Visual and is a value from 0 to 1. 0 is fully transparent and 1 is full opaque. A Visual with an Opacity property of 0 is still present in the tree. Like other properties on the Visual, Opacity can be animated using the Windows,UI.Composition animation system. (Inherited from Visual)
Orientation	A quaternion describing an orientation and rotation in 3D space that will be applied to the visual. Animatable. (Inherited from Visual)
Parent	The parent of the visual. (Inherited from Visual)
ParentForTransform	Visual specifying the coordinate system in which this visual is composed. (Inherited from Visual)
Properties	The collection of properties associated with the CompositionObject. (Inherited from CompositionObject)
RelativeOffsetAdjustment	Specifies the offset of the visual with respect to the size of its parent visual. (Inherited from Visual)
RelativeSizeAdjustment	Gets or sets the size of the visual with respect to the size of its parent visual. (Inherited from Visual)
RotationAngle	The rotation angle in radians of the visual. Animatable. (Inherited from Visual)
RotationAngleInDegrees	The rotation angle of the visual in degrees. Animatable. (Inherited from Visual)
RotationAxis	The axis to rotate the visual around. Animatable. (Inherited from Visual)
Scale	The scale to apply to the visual. (Inherited from Visual)
Size	The width and height of the visual. Animatable. (Inherited from Visual)
TransformMatrix	The transformation matrix to apply to the visual. Animatable. (Inherited from Visual)

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

• Visual
• IClosable
• Composition visual without framework sample (Windows 10)