ITransformProvider2 ITransformProvider2 ITransformProvider2 Interface

Extends the ITransformProvider interface to enable Microsoft UI Automation providers to expose API to support the viewport zooming functionality of a control.

Syntax

Declaration

public interface ITransformProvider2public interface ITransformProvider2Public Interface ITransformProvider2

Inheritance Hierarchy

Remarks

This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see Transform Control Pattern.

Use the TransformPattern2Identifiers class if you want to reference the ITransformProvider2 pattern properties from control code when you call RaisePropertyChangedEvent(AutomationProperty, Object, Object).

Properties summary

Gets a value that indicates whether the control supports zooming of its viewport.

Gets the maximum zoom level of the element.

Gets the minimum zoom level of the element.

Gets the zoom level of the control's viewport.

Methods summary

Zooms the viewport of the control.

Zooms the viewport of the control by the specified logical unit.

Properties

  • CanZoom
    CanZoom
    CanZoom
    CanZoom

    Gets a value that indicates whether the control supports zooming of its viewport.

    public bool CanZoom { get; }public bool CanZoom { get; }Public ReadOnly Property CanZoom As boolpublic bool CanZoom { get; }

    Property Value

    • bool
      bool
      bool

      true if the viewport can be zoomed; otherwise, false.

  • MaxZoom
    MaxZoom
    MaxZoom
    MaxZoom

    Gets the maximum zoom level of the element.

    public double MaxZoom { get; }public double MaxZoom { get; }Public ReadOnly Property MaxZoom As doublepublic double MaxZoom { get; }

    Property Value

    • double
      double
      double

      The maximum zoom level, as a percentage.

  • MinZoom
    MinZoom
    MinZoom
    MinZoom

    Gets the minimum zoom level of the element.

    public double MinZoom { get; }public double MinZoom { get; }Public ReadOnly Property MinZoom As doublepublic double MinZoom { get; }

    Property Value

    • double
      double
      double

      The minimum zoom level, as a percentage.

  • ZoomLevel
    ZoomLevel
    ZoomLevel
    ZoomLevel

    Gets the zoom level of the control's viewport.

    public double ZoomLevel { get; }public double ZoomLevel { get; }Public ReadOnly Property ZoomLevel As doublepublic double ZoomLevel { get; }

    Property Value

    • double
      double
      double

      The zoom level, specified as a percentage. The provider should zoom the viewport to the nearest supported value.

Methods

  • Zoom(Double)
    Zoom(Double)
    Zoom(Double)
    Zoom(Double)

    Zooms the viewport of the control.

    public void Zoom(Double zoom)public void Zoom(Double zoom)Public Function Zoom(zoom As Double) As voidpublic void Zoom(Double zoom)

    Parameters

    • zoom
      System.Double
      System.Double
      System.Double

      The amount to zoom the viewport, specified as a percentage. The provider should zoom the viewport to the nearest supported value.

  • ZoomByUnit(ZoomUnit)
    ZoomByUnit(ZoomUnit)
    ZoomByUnit(ZoomUnit)
    ZoomByUnit(ZoomUnit)

    Zooms the viewport of the control by the specified logical unit.

    public void ZoomByUnit(ZoomUnit zoomUnit)public void ZoomByUnit(ZoomUnit zoomUnit)Public Function ZoomByUnit(zoomUnit As ZoomUnit) As voidpublic void ZoomByUnit(ZoomUnit zoomUnit)

    Parameters

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.GuidAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.Automation.Provider.dll