MultipleViewPattern.GetViewName(Int32) Methode

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Ruft den Namen einer steuerelementspezifischen Ansicht ab.

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

public string GetViewName (int viewId);

member this.GetViewName : int -> string

Public Function GetViewName (viewId As Integer) As String

Parameter

viewId

Int32

Der steuerelementspezifische Ansichtsbezeichner.

Gibt zurück

String

Eine lokalisierte Zeichenfolge, die den steuerelementspezifischen Ansichtsnamen darstellt.

Ausnahmen

ArgumentException

viewId ist kein Member der unterstützten Ansichtsauflistung.

Beispiele

Im folgenden Beispiel wird der steuerelementspezifische Name der aktuellen Ansicht aus einem Steuerelement abgerufen, das unterstützt 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

Hinweise

Ansichtsbezeichner können mithilfe GetSupportedViewsvon abgerufen werden.

Die steuerelementspezifische Auflistung von Ansichtsbezeichnern ist instanzübergreifend identisch.

Ansichtsnamen eignen sich für die Verwendung in Sprachsynthese, Braille und anderen barrierefreien Anwendungen.