IXRFrameworkElement::GetFlowDirection (Compact 2013)

3/28/2014

This method retrieves the direction that text and other UI elements flow within any parent element that controls their layout.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetFlowDirection(
    __out XRFlowDirection* pFlowDirection
) = 0;

Parameters

  • pFlowDirection
    [out] Pointer to an XRFlowDirection enumerated value that represents the direction that text and other UI elements flow within their parent element. The default is XRFlowDirection_LeftToRight.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

The FlowDirection property is a dependency property.

This property is not automatically set as part of any application culture information, because an element might contain content that is not necessarily intended to obey the general flow direction that the culture information implies.

Some of the flow document classes such as IXRTextBlock define their own FlowDirection, and this property can also set the flow direction of the container.

.NET Framework Equivalent

System.Windows.FrameworkElement.FlowDirection

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRFrameworkElement