Share via


IXRScaleTransform::GetScaleY (Compact 2013)

3/28/2014

This method retrieves the factor by which to scale the UI object along the y-axis.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetScaleY(
    float* pScaleY
) = 0;

Parameters

  • pScaleY
    [out] Pointer to a float value that indicates the scale factor along the y-axis.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

The default value is 1, which indicates no scaling along the y-axis. When pScaleY is between 0 and 1, it decreases the length of the scaled object. When pScaleY is greater than 1, it increases the length of the scaled object.

When pScaleY is a negative value, it flips the scaled object vertically. When pScaleY is between 0 and -1, it flips the scaled object and decreases its length. When pScaleY is less than -1, it flips the object and increases its length. A value of -1 flips the scaled object but does not change its vertical size.

You can offset the local origin point (0,0) for a UI element on an IXRCanvas container object by setting the attached properties Canvas.Left and Canvas.Top. However, this is not considered a transformation; the UI object keeps its own local origin point for transformation purposes.

.NET Framework Equivalent

System.Windows.Media.ScaleTransform.ScaleY

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRScaleTransform
IXRScaleTransform::SetScaleY