MultipleViewPattern.GetViewName(Int32) Método

Definición

Espacio de nombres:

System.Windows.Automation

Ensamblado:

UIAutomationClient.dll

Recupera el nombre de una vista específica del control.

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

public string GetViewName(int viewId);

member this.GetViewName : int -> string

Public Function GetViewName (viewId As Integer) As String

Parámetros

viewId

Int32

Identificador de vista específico del control.

Devoluciones

String

Cadena localizada que representa el nombre de vista específico del control.

Excepciones

ArgumentException

viewId no es miembro de la colección de vistas admitidas.

Ejemplos

En el ejemplo siguiente, el nombre específico del control de la vista actual se recupera de un control que admite 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

Comentarios

Los identificadores de vista se pueden recuperar mediante GetSupportedViews.

La colección específica del control de identificadores de vista es idéntica en todas las instancias.

Los nombres de vista son adecuados para su uso en Texto a voz, Braille y otras aplicaciones accesibles.