AutomationInteropProvider.RaiseStructureChangedEvent メソッド

定義

名前空間:

System.Windows.Automation.Provider

アセンブリ:

UIAutomationProvider.dll

UI オートメーション ツリーが変更されたときにイベントを発生させます。

public:
 static void RaiseStructureChangedEvent(System::Windows::Automation::Provider::IRawElementProviderSimple ^ provider, System::Windows::Automation::StructureChangedEventArgs ^ e);

public static void RaiseStructureChangedEvent (System.Windows.Automation.Provider.IRawElementProviderSimple provider, System.Windows.Automation.StructureChangedEventArgs e);

static member RaiseStructureChangedEvent : System.Windows.Automation.Provider.IRawElementProviderSimple * System.Windows.Automation.StructureChangedEventArgs -> unit

Public Shared Sub RaiseStructureChangedEvent (provider As IRawElementProviderSimple, e As StructureChangedEventArgs)

パラメーター

provider

IRawElementProviderSimple

イベントに関連付けられた要素。

e

StructureChangedEventArgs

イベントに関する情報。

例

次の例は、子がカスタム リスト ボックスに追加または削除されたときにイベントを発生させる方法を示しています。

/// <summary>
/// Responds to an addition to the UI Automation tree structure by raising an event.
/// </summary>
/// <param name="list">
/// The list to which the item was added.
/// </param>
/// <remarks>
/// For the runtime Id of the item, pass 0 because the provider cannot know
/// what its actual runtime Id is.
/// </remarks>
public static void OnStructureChangeAdd(CustomListControl list)
{
    if (AutomationInteropProvider.ClientsAreListening)
    {
        int[] fakeRuntimeId = { 0 };
        StructureChangedEventArgs args =
            new StructureChangedEventArgs(StructureChangeType.ChildrenBulkAdded, 
            fakeRuntimeId);
        AutomationInteropProvider.RaiseStructureChangedEvent(
            (IRawElementProviderSimple)list.Provider, args);
    }
}

/// <summary>
/// Responds to a removal from the UI Automation tree structure 
/// by raising an event.
/// </summary>
/// <param name="list">
/// The list from which the item was removed.
/// </param>
/// <remarks>
/// For the runtime Id of the list, pass 0 because the provider cannot know
/// what its actual runtime ID is.
/// </remarks>
public static void OnStructureChangeRemove(CustomListControl list)
{
    if (AutomationInteropProvider.ClientsAreListening)
    {
        int[] fakeRuntimeId = { 0 };
        StructureChangedEventArgs args =
            new StructureChangedEventArgs(StructureChangeType.ChildrenBulkRemoved, 
            fakeRuntimeId);
        AutomationInteropProvider.RaiseStructureChangedEvent(
            (IRawElementProviderSimple)list.Provider, args);
    }
}

''' <summary>
''' Responds to an addition to the UI Automation tree structure by raising an event.
''' </summary>
''' <param name="list">
''' The list to which the item was added.
''' </param>
''' <remarks>
''' For the runtime Id of the item, pass 0 because the provider cannot know
''' what its actual runtime Id is.
''' </remarks>
Public Shared Sub OnStructureChangeAdd(ByVal list As CustomListControl)
    If AutomationInteropProvider.ClientsAreListening Then
        Dim fakeRuntimeId(1) As Integer
        fakeRuntimeId(0) = 0
        Dim args As New StructureChangedEventArgs( _
            StructureChangeType.ChildrenBulkAdded, fakeRuntimeId)
        AutomationInteropProvider.RaiseStructureChangedEvent( _
            CType(list.Provider, IRawElementProviderSimple), args)
    End If

End Sub


''' <summary>
''' Responds to a removal from the UI Automation tree structure by raising an event.
''' </summary>
''' <param name="list">
''' The list from which the item was removed.
''' </param>
''' <remarks>
''' For the runtime Id of the list, pass 0 because the provider cannot know
''' what its actual runtime ID is.
''' </remarks>
Public Shared Sub OnStructureChangeRemove(ByVal list As CustomListControl)
    If AutomationInteropProvider.ClientsAreListening Then
        Dim fakeRuntimeId(1) As Integer
        fakeRuntimeId(0) = 0
        Dim args As New StructureChangedEventArgs( _
            StructureChangeType.ChildrenBulkRemoved, fakeRuntimeId)
        AutomationInteropProvider.RaiseStructureChangedEvent( _
            CType(list.Provider, IRawElementProviderSimple), args)
    End If

End Sub

注釈

ツリー構造の変更の例として、リスト ボックスに対して子要素が追加または削除されたり、ツリー ビューで展開または折りたたまれたりする場合があります。

子要素が削除されると、要素またはそのコンテナーのランタイム識別子がコンストラクターに StructureChangedEventArgs 渡されます。 ただし、現在のバージョンの UI オートメーションでは、プロバイダーのインスタンスがランタイム識別子を簡単に検出する方法はありません。 メソッドは GetRuntimeId 通常、 を含む AppendRuntimeId配列を返します。これは、コントロールのすべてのインスタンスに対して一意の識別子を作成するように UI オートメーション システムに指示するマジック番号です。 によって GetRuntimeId 提供される生の値は、クライアントにとって意味がなく、特定のインスタンスを識別するために使用できないため、イベントでは使用しないでください。

この制限のため、 型 ChildAdded と ChildRemoved のイベントはあまり役に立ちません。 代わりに、 と を常に使用 ChildrenBulkAdded し ChildrenBulkRemoved、ランタイム identifer として 0 を渡します。 を使用 nullすることはできません。これにより例外が発生します。 クライアントは、追加または削除された子の具体的な通知なしに、コンテナー内で変更が行われた (に渡されたStructureChangedEventHandlerパラメーターでsender識別されます) ことが通知されます。

こちらもご覧ください

• StructureChangedEventArgs(StructureChangeType, Int32[])
• UI オートメーション イベントの概要
• UI オートメーション プロバイダーからのイベントの発生