LayoutEngine.Layout(Object, LayoutEventArgs) メソッド

定義

名前空間:

System.Windows.Forms.Layout

アセンブリ:

System.Windows.Forms.dll

レイアウト エンジンにレイアウト操作の実行を要求します。

public:
 virtual bool Layout(System::Object ^ container, System::Windows::Forms::LayoutEventArgs ^ layoutEventArgs);

public virtual bool Layout (object container, System.Windows.Forms.LayoutEventArgs layoutEventArgs);

abstract member Layout : obj * System.Windows.Forms.LayoutEventArgs -> bool
override this.Layout : obj * System.Windows.Forms.LayoutEventArgs -> bool

Public Overridable Function Layout (container As Object, layoutEventArgs As LayoutEventArgs) As Boolean

パラメーター

container

Object

レイアウト エンジンが操作を行うコンテナー。

layoutEventArgs

LayoutEventArgs

Layout イベントからのイベント引数。

戻り値

Boolean

container の親で再度レイアウト操作を実行する必要がある場合は true。それ以外の場合は false。

例外

NotSupportedException

container は、LayoutEngine がレイアウトを実行できる型ではありません。

例

次のコード例では、 メソッドを使用してカスタム レイアウト動作 Layout を実装する方法を示します。 このコード例は、LayoutEngine クラスのために提供されている大規模な例の一部です。

public:
    virtual bool Layout(Object^ container,
        LayoutEventArgs^ layoutEventArgs) override
    {
        Control^ parent = nullptr;
        try
        {
            parent = (Control ^) container;
        }
        catch (InvalidCastException^ ex)
        {
            throw gcnew ArgumentException(
                "The parameter 'container' must be a control", "container", ex);
        }
        // Use DisplayRectangle so that parent.Padding is honored.
        Rectangle parentDisplayRectangle = parent->DisplayRectangle;
        Point nextControlLocation = parentDisplayRectangle.Location;

        for each (Control^ currentControl in parent->Controls)
        {
            // Only apply layout to visible controls.
            if (!currentControl->Visible)
            {
                continue;
            }

            // Respect the margin of the control:
            // shift over the left and the top.
            nextControlLocation.Offset(currentControl->Margin.Left,
                currentControl->Margin.Top);

            // Set the location of the control.
            currentControl->Location = nextControlLocation;

            // Set the autosized controls to their
            // autosized heights.
            if (currentControl->AutoSize)
            {
                currentControl->Size = currentControl->GetPreferredSize(
                    parentDisplayRectangle.Size);
            }

            // Move X back to the display rectangle origin.
            nextControlLocation.X = parentDisplayRectangle.X;

            // Increment Y by the height of the control
            // and the bottom margin.
            nextControlLocation.Y += currentControl->Height +
                currentControl->Margin.Bottom;
        }

        // Optional: Return whether or not the container's
        // parent should perform layout as a result of this
        // layout. Some layout engines return the value of
        // the container's AutoSize property.

        return false;
    }

public override bool Layout(
    object container,
    LayoutEventArgs layoutEventArgs)
{
    Control parent = container as Control;

    // Use DisplayRectangle so that parent.Padding is honored.
    Rectangle parentDisplayRectangle = parent.DisplayRectangle;
    Point nextControlLocation = parentDisplayRectangle.Location;

    foreach (Control c in parent.Controls)
    {
        // Only apply layout to visible controls.
        if (!c.Visible)
        {
            continue;
        }

        // Respect the margin of the control:
        // shift over the left and the top.
        nextControlLocation.Offset(c.Margin.Left, c.Margin.Top);

        // Set the location of the control.
        c.Location = nextControlLocation;

        // Set the autosized controls to their 
        // autosized heights.
        if (c.AutoSize)
        {
            c.Size = c.GetPreferredSize(parentDisplayRectangle.Size);
        }

        // Move X back to the display rectangle origin.
        nextControlLocation.X = parentDisplayRectangle.X;

        // Increment Y by the height of the control 
        // and the bottom margin.
        nextControlLocation.Y += c.Height + c.Margin.Bottom;
    }

    // Optional: Return whether or not the container's 
    // parent should perform layout as a result of this 
    // layout. Some layout engines return the value of 
    // the container's AutoSize property.

    return false;
}

Public Overrides Function Layout( _
ByVal container As Object, _
ByVal layoutEventArgs As LayoutEventArgs) As Boolean

    Dim parent As Control = container

    ' Use DisplayRectangle so that parent.Padding is honored.
    Dim parentDisplayRectangle As Rectangle = parent.DisplayRectangle
    Dim nextControlLocation As Point = parentDisplayRectangle.Location

    Dim c As Control
    For Each c In parent.Controls

        ' Only apply layout to visible controls.
        If c.Visible <> True Then
            Continue For
        End If

        ' Respect the margin of the control:
        ' shift over the left and the top.
        nextControlLocation.Offset(c.Margin.Left, c.Margin.Top)

        ' Set the location of the control.
        c.Location = nextControlLocation

        ' Set the autosized controls to their 
        ' autosized heights.
        If c.AutoSize Then
            c.Size = c.GetPreferredSize(parentDisplayRectangle.Size)
        End If

        ' Move X back to the display rectangle origin.
        nextControlLocation.X = parentDisplayRectangle.X

        ' Increment Y by the height of the control 
        ' and the bottom margin.
        nextControlLocation.Y += c.Height + c.Margin.Bottom
    Next c

    ' Optional: Return whether or not the container's 
    ' parent should perform layout as a result of this 
    ' layout. Some layout engines return the value of 
    ' the container's AutoSize property.
    Return False

End Function

注釈

このメソッドは、レイアウト エンジンが パラメーターに対してレイアウト操作を実行する場合に container 呼び出されます。 、、および の各プロパティlayoutEventArgsの値をAffectedPropertyAffectedComponentチェックして、AffectedControlレイアウト操作が必要かどうかを判断できます。

注意 (継承者)

カスタム レイアウトの Layout(Object, LayoutEventArgs) 動作を提供するには、 メソッドをオーバーライドします。

パラメーターのcontainer内容をレイアウトするときは、各子コントロールの プロパティをVisibleチェックしてください。

レイアウト エンジン ロジックで、コンテナーの親によってレイアウトを再度実行する必要があると判断された場合は、 を返 true します。 これは、たとえば、レイアウト エンジンが子コントロールのサイズを変更し、新しいレイアウトに合わせてコンテナーのサイズを大きくする必要があると判断した場合などに発生する可能性があります。

こちらもご覧ください

• LayoutEventArgs
• 方法: カスタム レイアウト エンジンを実装する