MultipleViewPattern.GetViewName(Int32) Méthode

Définition

Espace de noms:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Récupère le nom d'un affichage spécifique au contrôle.

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

public string GetViewName (int viewId);

member this.GetViewName : int -> string

Public Function GetViewName (viewId As Integer) As String

Paramètres

viewId

Int32

Identificateur d'affichage spécifique au contrôle.

Retours

String

Chaîne localisée représentant le nom de l'affichage spécifique au contrôle.

Exceptions

ArgumentException

viewId n’est pas un membre de la collection d’affichages prise en charge.

Exemples

Dans l’exemple suivant, le nom spécifique au contrôle de la vue actuelle est récupéré à partir d’un contrôle qui prend en charge 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

Remarques

Les identificateurs d’affichage peuvent être récupérés à l’aide de GetSupportedViews.

La collection d’identificateurs d’affichage spécifique au contrôle est identique d’une instance à l’autre.

Les noms d’affichage peuvent être utilisés dans la synthèse vocale, le braille et d’autres applications accessibles.