Control.ClientSize-Eigenschaft

Artikel
08/20/2007

Ruft die Höhe und Breite des Clientbereichs des Steuerelements ab oder legt diese fest.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

Syntax

'Declaration
Public Property ClientSize As Size
'Usage
Dim instance As Control
Dim value As Size

value = instance.ClientSize

instance.ClientSize = value

public Size ClientSize { get; set; }

public:
property Size ClientSize {
    Size get ();
    void set (Size value);
}

/** @property */
public Size get_ClientSize ()

/** @property */
public void set_ClientSize (Size value)

public function get ClientSize () : Size

public function set ClientSize (value : Size)

Eigenschaftenwert

Ein Size, das die Abmessungen des Clientbereichs des Steuerelements darstellt.

Hinweise

Der Clientbereich eines Steuerelements entspricht den Begrenzungen des Steuerelements abzüglich der Nicht-Clientelemente, z. B. Bildlaufleisten, Rahmen, Titelleisten und Menüs. Die SetClientSizeCore-Methode wird aufgerufen, um die ClientSize-Eigenschaft festzulegen. Da die ClientSize-Eigenschaft nicht immer durch die set-Methode geändert wird, müssen Sie die SetClientSizeCore-Methode überschreiben, sodass der Code beim Festlegen der ClientSize-Eigenschaft ausgeführt wird.

Die Size.Width-Eigenschaft und die Size.Height-Eigenschaft stellen die Breite und die Höhe des Clientbereichs des Steuerelements dar. Mithilfe dieser Eigenschaft können Sie die Größe des Clientbereichs des Steuerelements für Aufgaben wie das Zeichnen auf der Oberfläche des Steuerelements abrufen.

Weitere Informationen zum Zeichnen auf Steuerelementen finden Sie unter Wiedergeben eines Windows Forms-Steuerelements.

Beispiel

Im folgenden Codebeispiel wird die Größe des angegebenen Steuerelements so geändert, dass es den formatierten Text aufnehmen kann. Der formatierte Text ist die Text-Eigenschaft, wobei der zugewiesene Font des Steuerelements auf den Text angewendet wird. Die AutoSizeControl-Methode in diesem Beispiel verfügt auch über einen textPadding-Parameter, der den Abstand darstellt, der auf alle Kanten des Steuerelements angewendet wird. Damit der Leerraum gleich angezeigt wird, richten Sie den Text mit dem ContentAlignment.MiddleCenter-Wert aus, sofern dieser vom Steuerelement unterstützt wird.

Private Sub AutoSizeControl(control As Control, textPadding As Integer)
   ' Create a Graphics object for the Control.
   Dim g As Graphics = control.CreateGraphics()
   
   ' Get the Size needed to accommodate the formatted Text.
   Dim preferredSize As Size = g.MeasureString( _
     control.Text, control.Font).ToSize()
   
   ' Pad the text and resize the control.
   control.ClientSize = New Size( _
     preferredSize.Width + textPadding * 2, _
     preferredSize.Height + textPadding * 2)
   
   ' Clean up the Graphics object.
   g.Dispose()
End Sub

private void AutoSizeControl(Control control, int textPadding)
{
   // Create a Graphics object for the Control.
   Graphics g = control.CreateGraphics();

   // Get the Size needed to accommodate the formatted Text.
   Size preferredSize = g.MeasureString(
      control.Text, control.Font).ToSize();

   // Pad the text and resize the control.
   control.ClientSize = new Size(
      preferredSize.Width + (textPadding * 2), 
      preferredSize.Height+(textPadding * 2) );

   // Clean up the Graphics object.
   g.Dispose();
}

private:
   void AutoSizeControl( Control^ control, int textPadding )
   {
      
      // Create a Graphics object for the Control.
      Graphics^ g = control->CreateGraphics();
      
      // Get the Size needed to accommodate the formatted Text.
      System::Drawing::Size preferredSize = g->MeasureString( control->Text, control->Font ).ToSize();
      
      // Pad the text and resize the control.
      control->ClientSize = System::Drawing::Size( preferredSize.Width + (textPadding * 2), preferredSize.Height + (textPadding * 2) );
      
      // Clean up the Graphics object.
      delete g;
   }

private void AutoSizeControl(Control control, int textPadding)
{
    // Create a Graphics object for the Control.
    Graphics g = control.CreateGraphics();
    // Get the Size needed to accommodate the formatted Text.
    Size preferredSize = g.MeasureString(control.get_Text(), control.
        get_Font()).ToSize();
    // Pad the text and resize the control.
    control.set_ClientSize(new Size(preferredSize.get_Width() 
        + textPadding * 2, preferredSize.get_Height() + textPadding * 2));
    // Clean up the Graphics object.
    g.Dispose();
} //AutoSizeControl

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

Control-Klasse
Control-Member
System.Windows.Forms-Namespace
Control.ClientRectangle-Eigenschaft
DrawMode

Freigeben über