MultipleViewPattern.GetViewName(Int32) Método

Definição

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Recupera o nome de um modo de exibição específico do controle.

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

O identificador de exibição específico a um controle.

Retornos

String

Uma cadeia de caracteres localizada que representa o nome da exibição específica a um controle.

Exceções

ArgumentException

viewId não é um membro da coleção de modos de exibição com suporte.

Exemplos

No exemplo a seguir, o nome específico do controle da exibição atual é recuperado de um controle compatível 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

Comentários

Os identificadores de exibição podem ser recuperados usando GetSupportedViews.

A coleção específica de controle de identificadores de exibição é idêntica entre instâncias.

Os nomes de exibição são adequados para uso em Texto em Fala, Braille e outros aplicativos acessíveis.