InlineUIContainer Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Documents

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.

Edit

Provides an inline content element that enables UIElement types to be embedded in the content of a RichTextBlock.

public ref class InlineUIContainer sealed : Inline

/// [Microsoft.UI.Xaml.Markup.ContentProperty(Name="Child")]
/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class InlineUIContainer final : Inline

[Microsoft.UI.Xaml.Markup.ContentProperty(Name="Child")]
[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class InlineUIContainer : Inline

Public NotInheritable Class InlineUIContainer
Inherits Inline

<InlineUIContainer .../>
-or-
<InlineUIContainer ...>
  singleChild
</InlineUIContainer>

Inheritance: Object Platform::Object IInspectable DependencyObject TextElement Inline InlineUIContainer

Attributes: ContentPropertyAttribute ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

The following code example shows how you can insert an image into a RichTextBlock by using InlineUIContainer.

<RichTextBlock>
    <Paragraph>
        <Italic>This is an inline image.</Italic>

        <InlineUIContainer>
            <Image Source="Assets/SmallLogo.png" Height="30" Width="30"/>
        </InlineUIContainer>

        Mauris auctor tincidunt auctor.
    </Paragraph>
</RichTextBlock>

Remarks

The most common scenario for using an InlineUIContainer object is to introduce an image into text content. Use a new Image object for the image, as the child content for an InlineUIContainer. Set Height and Width on the image if you don't want it to scale to the natural image size.

If you want more than one element inlined in the same position, consider using a panel as the single InlineUIContainer child and then placing the multiple elements within that panel.

If placed within an InlineUIContainer, a control that can be focused still appears in the top-level tab sequence.

If you want interactive text, consider using a Hyperlink element (a type of Inline) rather than using InlineUIContainer with a Button or similar within it. See Guidelines for links.

InlineUIContainer inherits properties from the TextElement class. However, most of these properties don't have any visible effect. It's most common to declare a InlineUIContainer object element in XAML without there being any attributes set (except possibly x:Name attribute) with the single child element that you're inlining as content of the InlineUIContainer object element.

Setting properties on InlineUIContainer that otherwise affect the character line height of a text element (such as FontSize, FontFamily) has no effect on the rendering and appearance. The content dictates its size and the InlineUIContainer sizes to fit it.

If there's further text within the child content (like TextBlock.Text or other text elements within a nested RichTextBlock) the text element properties of the InlineUIContainer parent won't inherit into the content, they're ignored.

Constructors

InlineUIContainer()

Initializes a new instance of the InlineUIContainer class.

Properties

AccessKey	Gets or sets the access key for this element. (Inherited from TextElement)
AccessKeyScopeOwner	Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element. (Inherited from TextElement)
AllowFocusOnInteraction	Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it. (Inherited from TextElement)
CharacterSpacing	Gets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from TextElement)
Child	Gets or sets the UIElement hosted by the InlineUIContainer.
ContentEnd	Gets a TextPointer that represents the end of the content in the element. (Inherited from TextElement)
ContentStart	Gets a TextPointer that represents the start of content in the element. (Inherited from TextElement)
Dispatcher	Always returns `null` in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the `DispatcherQueue` that this object is associated with. The `DispatcherQueue` represents a facility that can access the `DependencyObject` on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)
ElementEnd	Gets a TextPointer that represents the position just after the end of the element. (Inherited from TextElement)
ElementStart	Gets a TextPointer that represents the position just before the start of the element. (Inherited from TextElement)
ExitDisplayModeOnAccessKeyInvoked	Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked. (Inherited from TextElement)
FontFamily	Gets or sets the preferred top-level font family for the content of the element. (Inherited from TextElement)
FontSize	Gets or sets the font size for the content of the element. (Inherited from TextElement)
FontStretch	Gets or sets the glyph width of the font in a family to select. (Inherited from TextElement)
FontStyle	Gets or sets the font style for the content in this element. (Inherited from TextElement)
FontWeight	Gets or sets the top-level font weight to select from the font family for the content in this element. (Inherited from TextElement)
Foreground	Gets or sets the Brush to apply to the content in this element. (Inherited from TextElement)
IsAccessKeyScope	Gets or sets a value that indicates whether an element defines its own access key scope. (Inherited from TextElement)
IsTextScaleFactorEnabled	Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled. (Inherited from TextElement)
KeyTipHorizontalOffset	Gets or sets a value that indicates how far left or right the keytip is placed in relation to the text element. (Inherited from TextElement)
KeyTipPlacementMode	Gets or sets a value that indicates where the KeyTip is placed in relation to the text element. (Inherited from TextElement)
KeyTipVerticalOffset	Gets or sets a value that indicates how far up or down the keytip is placed in relation to the text element. (Inherited from TextElement)
Language	Gets or sets localization/globalization language information that applies to a TextElement. (Inherited from TextElement)
Name	Gets or sets a unique identification for the object. Name can only be set from initial parsing of XAML. (Inherited from TextElement)
TextDecorations	Gets or sets a value that indicates what decorations are applied to the text. (Inherited from TextElement)
XamlRoot	Gets or sets the XamlRoot in which this element is being viewed. (Inherited from TextElement)

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
FindName(String)	Retrieves an object in the object model / runtime object graph by referencing the object's x:Name or Name attribute value. (Inherited from TextElement)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
OnDisconnectVisualChildren()	Override this method to implement how layout and logic should behave when items are removed from a class-specific content or child property. (Inherited from TextElement)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Events

AccessKeyDisplayDismissed	Occurs when the access key sequence is complete to notify controls that they should hide access key visuals. (Inherited from TextElement)
AccessKeyDisplayRequested	Occurs when the access key sequence is started to notify controls that they should show access key visuals. (Inherited from TextElement)
AccessKeyInvoked	Occurs when a user completes an access key sequence to notify the element that the access key action should be invoked. (Inherited from TextElement)

Applies to

Share via