Share via


IXRScrollbar::GetViewportSize (Compact 2013)

3/28/2014

This method retrieves the amount of scrollable content is currently visible.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetViewportSize(
    __out float* pViewportSize
) = 0;

Parameters

  • pViewportSize
    Pointer to a float value that indicates the amount of scrollable content is currently visible.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

The units that are used for pViewportSize are the same units that are used to describe the length of the content. Some examples include lines of text, or pages of text.

The value in pViewportSize is used to calculate the size of the IXRThumb control that is displayed as the sliding value indicator in an IXRScrollBar control. The IXRThumb control has a minimum size that is defined by the operating system. The size of an IXRThumb control becomes larger as more content is visible. For example, if 25 percent of a thumb control's content is visible, the control occupies 25 percent of the track in which it moves.

.NET Framework Equivalent

System.Windows.Controls.Primitives.ScrollBar.ViewportSize

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRScrollBar
IXRScrollBar::SetViewportSize