Contains メソッド (DockableGroupPane)

指定されたペインがグループの子であるかどうかを判定します。

シンタックス

Visual Basic

'宣言
 
Public Function Contains( _
   ByVal pane As DockablePaneBase, _
   ByVal recursive As Boolean _
) As Boolean

C#

public bool Contains( 
   DockablePaneBase pane,
   bool recursive
)

パラメータ

pane

検索する Pane オブジェクト。

recursive

ネストされた子孫をチェックすべき場合は True。

戻り値の型

recursive が False の時、ペインがグループの直接の子の場合にはこのメソッドは True を返します。そうでない場合は False を返します。recursive が True の時、ペインがグループの直接の子またはグループの子孫ペインのいずれかの子である場合にはこのメソッドは True を返します。ペインがグループ内の任意の場所に配置されていない場合には、False を返します。

解説

特定のペインがグループ内の任意の場所に配置されている場合には、このメソッドを使用します。このメソッドは指定されたペインとの一致を探すグループのペインで繰り返します。ネストされたペインを見つけ出すためにこのメソッドが繰り返し検索すべきか、または検索時に最上位のペインを検証するだけかを指定できます。

使用例

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinDock

Private Sub btnVisibleIndex_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnVisibleIndex.Click

    Dim group As DockableGroupPane = Me.ultraDockManager1.DockAreas(0)
    Dim pane As DockableControlPane

    For Each pane In Me.ultraDockManager1.ControlPanes
        Debug.WriteLine("Control Pane:" + pane.ToString())
        Debug.Indent()

        ' The 'Contains' methods checks the 'Panes' of the
        ' group. the second argument indicates whether to
        ' check the children of any contained group pane.
        ' therefore passing in false will indicate whether
        ' the pane is directly contained in the panes collection
        If group.Contains(pane, False) Then
            Debug.WriteLine("Is contained directly by the first dock area")

            If pane.IsVisible Then
                Debug.WriteLine("Its visible position is " & group.Panes.GetVisiblePosition(pane))
            End If
        ElseIf group.Contains(pane, True) Then
            ' While the pane is not in the Panes collection
            ' of the group, it is contained within the
            ' dock area at a deeper level
            Debug.WriteLine("Is a descendant of the first dock area")

            ' The nest depth indicates how many levels
            ' deep the pane is from the dock area
            Debug.WriteLine("The pane's current nest depth is:" & pane.NestDepth)
        Else
            Debug.WriteLine("Is not contained within the first dock area")

            Debug.WriteLine(String.Format("The pane is currently at index {0} of the pane {1}", pane.Index, pane.Parent))
        End If

        Debug.Unindent()
    Next

End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinDock;
using System.Diagnostics;

private void btnVisibleIndex_Click(object sender, System.EventArgs e)
{

  DockableGroupPane group = this.ultraDockManager1.DockAreas[0];

	foreach(DockableControlPane pane in this.ultraDockManager1.ControlPanes )
	{
		Debug.WriteLine("Control Pane:" + pane.ToString());
		Debug.Indent();

		// The 'Contains' methods checks the 'Panes' of the
		// group. the second argument indicates whether to
		// check the children of any contained group pane.
		// therefore passing in false will indicate whether
		// the pane is directly contained in the panes collection
		if (group.Contains(pane, false))
		{
			Debug.WriteLine("Is contained directly by the first dock area");

			if (pane.IsVisible)
				Debug.WriteLine("Its visible position is " + group.Panes.GetVisiblePosition(pane));
		}
		else if (group.Contains(pane, true))
		{
			// While the pane is not in the Panes collection
			// of the group, it is contained within the
			// dock area at a deeper level
			Debug.WriteLine("Is a descendant of the first dock area");

			// The nest depth indicates how many levels
			// deep the pane is from the dock area
			Debug.WriteLine("The pane's current nest depth is:" + pane.NestDepth);
		}
		else
		{
			Debug.WriteLine("Is not contained within the first dock area");

			Debug.WriteLine(string.Format("The pane is currently at index {0} of the pane {1}", pane.Index, pane.Parent));
		}

		Debug.Unindent();
	}

}