Export (0) Print
Expand All

Control::PerformLayout Method

Forces the control to apply layout logic to all its child controls.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public:
void PerformLayout()

If the SuspendLayout method was called before calling the PerformLayout method, the Layout event is suppressed.

The AffectedControl and AffectedProperty properties of the LayoutEventArgs created are set to nullptr if no values were provided when the PerformLayout method was called.

The following code example demonstrates how to use the PerformLayout method. It also demonstrates ways in which the Layout event is raised. In this example, the Click event handler for Button1 explicitly calls PerformLayout. The Click event handler for Button2 implicitly calls PerformLayout. PerformLayout is also called when the form is loaded. Button3 returns the control to the state it was in when loaded. In each case, the Layout event is raised.

This is a complete example. To run the example, paste the following code in a blank form.


using namespace System;
using namespace System::Windows::Forms;
using namespace System::Drawing;

// This custom control has the Layout event implented so that when 
// PerformLayout(AffectedControl, AffectedProperty) is called 
// on the control, where AffectedProperty equals "Bounds" the 
// textbox is centered on the control.
public ref class LayoutControl: public System::Windows::Forms::UserControl
{
public private:
   System::Windows::Forms::TextBox^ TextBox1;

public:
   LayoutControl()
      : UserControl()
   {
      InitializeComponent();
   }


private:
   void InitializeComponent()
   {
      this->TextBox1 = gcnew System::Windows::Forms::TextBox;
      this->SuspendLayout();
      this->TextBox1->BorderStyle = System::Windows::Forms::BorderStyle::FixedSingle;
      this->TextBox1->Name = "TextBox1";
      this->TextBox1->TabIndex = 0;
      this->BackColor = System::Drawing::SystemColors::ControlDark;
      this->Controls->Add( this->TextBox1 );
      this->Name = "LayoutControl";
      this->ResumeLayout( false );
      this->Layout += gcnew LayoutEventHandler( this, &LayoutControl::LayoutControl_Layout );
   }


   // This method is called when the Layout event is fired. 
   // This happens by during the initial load, by calling PerformLayout
   // or by resizing, adding or removing controls or other actions that 
   // affect how the control is laid out. This method checks the 
   // value of e.AffectedProperty and changes the look of the 
   // control accordingly. 
   void LayoutControl_Layout( Object^ /*sender*/, System::Windows::Forms::LayoutEventArgs^ e )
   {
      if ( e->AffectedProperty != nullptr )
      {
         if ( e->AffectedProperty->Equals( "Bounds" ) )
         {
            TextBox1->Left = (this->Width - TextBox1->Width) / 2;
            TextBox1->Top = (this->Height - TextBox1->Height) / 2;
         }
      }
      else
      {
         this->Size = System::Drawing::Size( 150, 160 );
         TextBox1->Location = System::Drawing::Point( 16, 24 );
      }

      TextBox1->Text = String::Format( "Left = {0} Top = {1}", TextBox1->Left, TextBox1->Top );
   }

};

public ref class LayoutForm: public System::Windows::Forms::Form
{
public:
   LayoutForm()
      : Form()
   {
      InitializeComponent();
   }


public private:
   System::Windows::Forms::Button^ Button1;
   System::Windows::Forms::Button^ Button2;
   LayoutControl^ LayoutControl1;
   System::Windows::Forms::Button^ Button3;

private:
   void InitializeComponent()
   {
      this->Button1 = gcnew System::Windows::Forms::Button;
      this->Button2 = gcnew System::Windows::Forms::Button;
      this->Button3 = gcnew System::Windows::Forms::Button;
      this->LayoutControl1 = gcnew LayoutControl;
      this->SuspendLayout();
      this->Button1->Location = System::Drawing::Point( 16, 16 );
      this->Button1->Name = "Button1";
      this->Button1->Size = System::Drawing::Size( 120, 32 );
      this->Button1->TabIndex = 0;
      this->Button1->Text = "Center textbox on control";
      this->Button2->Location = System::Drawing::Point( 152, 16 );
      this->Button2->Name = "Button2";
      this->Button2->Size = System::Drawing::Size( 104, 32 );
      this->Button2->TabIndex = 3;
      this->Button2->Text = "Shrink user control";
      this->Button3->Location = System::Drawing::Point( 96, 232 );
      this->Button3->Name = "Button3";
      this->Button3->TabIndex = 5;
      this->Button3->Text = "Reset";
      this->LayoutControl1->BackColor = System::Drawing::SystemColors::ControlDark;
      this->LayoutControl1->Location = System::Drawing::Point( 72, 64 );
      this->LayoutControl1->Name = "LayoutControl1";
      this->LayoutControl1->Size = System::Drawing::Size( 150, 160 );
      this->LayoutControl1->TabIndex = 6;
      this->ClientSize = System::Drawing::Size( 292, 266 );
      this->Controls->Add( this->Button3 );
      this->Controls->Add( this->Button2 );
      this->Controls->Add( this->Button1 );
      this->Controls->Add( this->LayoutControl1 );
      this->Name = "Form1";
      this->Text = "Form1";
      this->ResumeLayout( false );
      this->Button1->Click += gcnew System::EventHandler( this,&LayoutForm::Button1_Click );
      this->Button2->Click += gcnew System::EventHandler( this,&LayoutForm::Button2_Click );
      this->Button3->Click += gcnew System::EventHandler( this,&LayoutForm::Button3_Click );
   }


   // This method explicitly calls raises the layout event on 
   // LayoutControl1, changing the Bounds property.
   void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      LayoutControl1->PerformLayout( LayoutControl1, "Bounds" );
   }


   // This resize of LayoutControl1 implicitly triggers the layout event. 
   //  Changing the size of the control affects its Bounds property.
   void Button2_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      LayoutControl1->Size = System::Drawing::Size( 100, 100 );
   }


   // This method explicitly calls PerformLayout with no parameters, 
   // which raises the Layout event with the LayoutEventArgs properties
   // equal to Nothing.
   void Button3_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      LayoutControl1->PerformLayout();
   }

};


[System::STAThread]
int main()
{
   Application::Run( gcnew LayoutForm );
}



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft