MultipleViewPattern.GetViewName(Int32) Metoda

Definice

Obor názvů:

System.Windows.Automation

Sestavení:

UIAutomationClient.dll

Načte název zobrazení specifického pro ovládací prvek.

public:
 System::String ^ GetViewName(int viewId);

public string GetViewName (int viewId);

member this.GetViewName : int -> string

Public Function GetViewName (viewId As Integer) As String

Parametry

viewId

Int32

Identifikátor zobrazení specifického pro ovládací prvek.

Návraty

String

Lokalizovaný řetězec představující název zobrazení specifické pro ovládací prvek.

Výjimky

ArgumentException

viewId není členem kolekce podporovaných zobrazení.

Příklady

V následujícím příkladu je název aktuálního zobrazení specifický pro ovládací prvek načten z ovládacího prvku, který podporuje MultipleViewPattern.

///--------------------------------------------------------------------
/// <summary>
/// Gets the name of the current view of a target.
/// </summary>
/// <param name="multipleViewControl">
/// The current multiple view control.
/// </param>
/// <returns>
/// The current view name.
/// </returns>
///--------------------------------------------------------------------
private string ViewName(AutomationElement multipleViewControl)
{
    if (multipleViewControl == null)
    {
        throw new ArgumentNullException(
            "AutomationElement parameter must not be null.");
    }

    // Get a MultipleViewPattern from the current control.
    MultipleViewPattern multipleViewPattern =
        GetMultipleViewPattern(multipleViewControl);

    if (multipleViewControl != null)
    {
        try
        {
            int viewID = 
                (int)multipleViewControl.GetCurrentPropertyValue(
                MultipleViewPattern.CurrentViewProperty);
            return multipleViewPattern.GetViewName(viewID);
        }
        catch (ArgumentException)
        {
            // TO DO: error handling
        }
    }
    return null;
}

'/--------------------------------------------------------------------
'/ <summary>
'/ Gets the name of the current view of a target.
'/ </summary>
'/ <param name="multipleViewControl">
'/ The current multiple view control.
'/ </param>
'/ <returns>
'/ The current view name.
'/ </returns>
'/--------------------------------------------------------------------
Private Function ViewName( _
ByVal multipleViewControl As AutomationElement) As String
    If multipleViewControl Is Nothing Then
        Throw New ArgumentNullException( _
        "AutomationElement parameter must not be null.")
    End If

    If Not (multipleViewControl Is Nothing) Then
        Try
            ' Get a MultipleViewPattern from the current control.
            Dim multipleViewPattern As MultipleViewPattern = _
            GetMultipleViewPattern(multipleViewControl)
            Dim viewID As Integer = _
            DirectCast(multipleViewControl.GetCurrentPropertyValue( _
            multipleViewPattern.CurrentViewProperty), Integer)
            Return multipleViewPattern.GetViewName(viewID)
        Catch exc As ArgumentException
            ' TO DO: error handling
        End Try
    End If
    Return Nothing
End Function 'ViewName

Poznámky

Identifikátory zobrazení lze načíst pomocí .GetSupportedViews

Kolekce identifikátorů zobrazení specifická pro ovládací prvky je identická napříč instancemi.

Názvy zobrazení jsou vhodné pro použití v aplikacích převodu textu na řeč, Braillově písmu a dalších aplikacích s podporou přístupnosti.