MultipleViewPattern.GetViewName(Int32) Metoda

Definicja

Przestrzeń nazw:

System.Windows.Automation

Zestaw:

UIAutomationClient.dll

Pobiera nazwę widoku specyficznego dla kontrolki.

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

Identyfikator widoku specyficznego dla kontrolki.

Zwraca

String

Zlokalizowany ciąg reprezentujący nazwę widoku specyficznego dla kontrolki.

Wyjątki

ArgumentException

viewId nie jest członkiem kolekcji obsługiwanych widoków.

Przykłady

W poniższym przykładzie nazwa specyficzna dla kontrolki bieżącego widoku jest pobierana z kontrolki obsługującej element 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

Uwagi

Identyfikatory widoków można pobrać przy użyciu polecenia GetSupportedViews.

Kolekcja identyfikatorów widoku specyficzna dla kontrolek jest identyczna w przypadku wystąpień.

Nazwy widoków są odpowiednie do użycia w funkcji Zamiana tekstu na mowę, Braille i inne aplikacje dostępne.