InlineUIContainer InlineUIContainer InlineUIContainer InlineUIContainer Class


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

public : sealed class InlineUIContainer : Inline, IInlineUIContainer
struct winrt::Windows::UI::Xaml::Documents::InlineUIContainer : Inline, IInlineUIContainer
public sealed class InlineUIContainer : Inline, IInlineUIContainer
Public NotInheritable Class InlineUIContainer Inherits Inline Implements IInlineUIContainer
<InlineUIContainer .../>
<InlineUIContainer ...>

Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)


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

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

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

        Mauris auctor tincidunt auctor.


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.


InlineUIContainer() InlineUIContainer() InlineUIContainer() InlineUIContainer()

Initializes a new instance of the InlineUIContainer class.


AccessKey AccessKey AccessKey AccessKey

Gets or sets the access key for this element.

(Inherited from TextElement)
AccessKeyProperty AccessKeyProperty AccessKeyProperty AccessKeyProperty

Identifies the AccessKey dependency property.

(Inherited from TextElement)
AccessKeyScopeOwner AccessKeyScopeOwner AccessKeyScopeOwner 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)
AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty

Identifies the AccessKeyScopeOwner dependency property.

(Inherited from TextElement)
AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

(Inherited from TextElement)
AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty

Identifies the AllowFocusOnInteraction dependency property.

(Inherited from TextElement)
CharacterSpacing CharacterSpacing CharacterSpacing CharacterSpacing

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

(Inherited from TextElement)
CharacterSpacingProperty CharacterSpacingProperty CharacterSpacingProperty CharacterSpacingProperty

Identifies the CharacterSpacing dependency property.

(Inherited from TextElement)
Child Child Child Child

Gets or sets the UIElement hosted by the InlineUIContainer.

ContentEnd ContentEnd ContentEnd ContentEnd

Gets a TextPointer that represents the end of the content in the element.

(Inherited from TextElement)
ContentStart ContentStart ContentStart ContentStart

Gets a TextPointer that represents the start of content in the element.

(Inherited from TextElement)
Dispatcher Dispatcher Dispatcher Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher 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 ElementEnd ElementEnd ElementEnd

Gets a TextPointer that represents the position just after the end of the element.

(Inherited from TextElement)
ElementStart ElementStart ElementStart ElementStart

Gets a TextPointer that represents the position just before the start of the element.

(Inherited from TextElement)
ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

(Inherited from TextElement)
ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty

Identifies the ExitDisplayModeOnAccessKeyInvoked dependency property.

(Inherited from TextElement)
FontFamily FontFamily FontFamily FontFamily

Gets or sets the preferred top-level font family for the content of the element.

(Inherited from TextElement)
FontFamilyProperty FontFamilyProperty FontFamilyProperty FontFamilyProperty

Identifies the FontFamily dependency property.

(Inherited from TextElement)
FontSize FontSize FontSize FontSize

Gets or sets the font size for the content of the element.

(Inherited from TextElement)
FontSizeProperty FontSizeProperty FontSizeProperty FontSizeProperty

Identifies the FontSize dependency property.

(Inherited from TextElement)
FontStretch FontStretch FontStretch FontStretch

Gets or sets the glyph width of the font in a family to select.

(Inherited from TextElement)
FontStretchProperty FontStretchProperty FontStretchProperty FontStretchProperty

Identifies the FontStretch dependency property.

(Inherited from TextElement)
FontStyle FontStyle FontStyle FontStyle

Gets or sets the font style for the content in this element.

(Inherited from TextElement)
FontStyleProperty FontStyleProperty FontStyleProperty FontStyleProperty

Identifies the FontStyle dependency property.

(Inherited from TextElement)
FontWeight FontWeight FontWeight FontWeight

Gets or sets the top-level font weight to select from the font family for the content in this element.

(Inherited from TextElement)
FontWeightProperty FontWeightProperty FontWeightProperty FontWeightProperty

Identifies the FontWeight dependency property.

(Inherited from TextElement)
Foreground Foreground Foreground Foreground

Gets or sets the Brush to apply to the content in this element.

(Inherited from TextElement)
ForegroundProperty ForegroundProperty ForegroundProperty ForegroundProperty

Identifies the Foreground dependency property.

(Inherited from TextElement)
IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope

Gets or sets a value that indicates whether an element defines its own access key scope.

(Inherited from TextElement)
IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty

Identifies the IsAccessKeyScope dependency property.

(Inherited from TextElement)
IsTextScaleFactorEnabled IsTextScaleFactorEnabled IsTextScaleFactorEnabled IsTextScaleFactorEnabled

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

(Inherited from TextElement)
IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty

Identifies the IsTextScaleFactorEnabled dependency property.

(Inherited from TextElement)
KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset 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)
KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty

Identifies the KeyTipHorizontalOffset dependency property.

(Inherited from TextElement)
KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode

Gets or sets a value that indicates where the KeyTip is placed in relation to the text element.

(Inherited from TextElement)
KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty

Identifies the KeyTipPlacementMode dependency property.

(Inherited from TextElement)
KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset 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)
KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty

Identifies the KeyTipVerticalOffset dependency property.

(Inherited from TextElement)
Language Language Language Language

Gets or sets localization/globalization language information that applies to a TextElement.

(Inherited from TextElement)
LanguageProperty LanguageProperty LanguageProperty LanguageProperty

Identifies the Language dependency property.

(Inherited from TextElement)
Name Name Name Name

Gets or sets a unique identification for the object. Name can only be set from initial parsing of XAML.

(Inherited from TextElement)
TextDecorations TextDecorations TextDecorations TextDecorations

Gets or sets a value that indicates what decorations are applied to the text.

(Inherited from TextElement)
TextDecorationsProperty TextDecorationsProperty TextDecorationsProperty TextDecorationsProperty

Identifies the TextDecorations dependency property.

(Inherited from TextElement)


AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed

Occurs when the access key sequence is complete to notify controls that they should hide access key visuals.

(Inherited from TextElement)
AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested

Occurs when the access key sequence is started to notify controls that they should show access key visuals.

(Inherited from TextElement)
AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked 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)


ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)
FindName(String) FindName(String) FindName(String) 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) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) 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) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)
OnDisconnectVisualChildren OnDisconnectVisualChildren OnDisconnectVisualChildren 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) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) 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) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)

See Also