MultipleViewPattern.GetViewName(Int32) Méthode

Définition

Récupère le nom d’une vue 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

Chaîne localisée représentant le nom d’affichage spécifique au contrôle.

Exceptions

viewId n’est pas membre de la collection de vues prises 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 GetSupportedViewsde .

La collection spécifique au contrôle d’identificateurs d’affichage est identique entre les instances.

Les noms d’affichage sont adaptés à une utilisation dans Synthèse vocale, braille et d’autres applications accessibles.

S’applique à