PowerStatus Class (System.Windows.Forms)

Switch View :
ScriptFree
.NET Framework Class Library
PowerStatus Class

Indicates current system power status information.

Inheritance Hierarchy

System.Object
  System.Windows.Forms.PowerStatus

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

Visual Basic
Public Class PowerStatus
C#
public class PowerStatus
Visual C++
public ref class PowerStatus
F#
type PowerStatus =  class end

The PowerStatus type exposes the following members.

Properties

  Name Description
Public property BatteryChargeStatus Gets the current battery charge status.
Public property BatteryFullLifetime Gets the reported full charge lifetime of the primary battery power source in seconds.
Public property BatteryLifePercent Gets the approximate amount of full battery charge remaining.
Public property BatteryLifeRemaining Gets the approximate number of seconds of battery time remaining.
Public property PowerLineStatus Gets the current system power status.
Top
Methods

  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

The PowerStatus class represents information about the current AC line power status, battery charging status, and battery charge status.

This class is used by the PowerStatus property of the SystemInformation class to indicate current system power information.

Examples

The following example lists all properties of the PowerStatus class in a ListBox control and displays the current value of the associated property in a TextBox control when a list item selected.

Visual Basic

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections
Imports System.ComponentModel
Imports System.Drawing
Imports System.Reflection
Imports System.Windows.Forms

Public Class PowerStatusBrowserForm
    Inherits System.Windows.Forms.Form
    Private listBox1 As System.Windows.Forms.ListBox
    Private textBox1 As System.Windows.Forms.TextBox  

    Public Sub New()
        Me.SuspendLayout()
        InitForm()

        'Add each property of the PowerStatus class to the list box.
        Dim t As Type = GetType(System.Windows.Forms.PowerStatus)
        Dim pi As PropertyInfo() = t.GetProperties()
        Dim i As Integer
        For i = 0 To pi.Length - 1
            listBox1.Items.Add(pi(i).Name)
        Next i
        textBox1.Text = "The PowerStatus class has " + pi.Length.ToString() + " properties." + ControlChars.CrLf

        ' Configure the list item selected handler for the list box to invoke a 
        ' method that displays the value of each property.           
        AddHandler listBox1.SelectedIndexChanged, AddressOf listBox1_SelectedIndexChanged
        Me.ResumeLayout(False)
    End Sub

    Private Sub listBox1_SelectedIndexChanged(sender As Object, e As EventArgs)
        ' Return if no item is selected.
        If listBox1.SelectedIndex = - 1 Then
            Return
        End If 
        ' Get the property name from the list item
        Dim propname As String = listBox1.Text

        ' Display the value of the selected property of the PowerStatus type.
        Dim t As Type = GetType(System.Windows.Forms.PowerStatus)
        Dim pi As PropertyInfo() = t.GetProperties()
        Dim prop As PropertyInfo = Nothing
        Dim i As Integer
        For i = 0 To pi.Length - 1
            If pi(i).Name = propname Then
                prop = pi(i)
                Exit For
            End If
        Next i 
        Dim propval As Object = prop.GetValue(SystemInformation.PowerStatus, Nothing)
        textBox1.Text += ControlChars.CrLf + "The value of the " + propname + " property is: " + propval.ToString()
    End Sub

    Private Sub InitForm()
        ' Initialize the form settings
        Me.listBox1 = New System.Windows.Forms.ListBox()
        Me.textBox1 = New System.Windows.Forms.TextBox()
        Me.listBox1.Anchor = CType(System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Bottom Or System.Windows.Forms.AnchorStyles.Left Or System.Windows.Forms.AnchorStyles.Right, System.Windows.Forms.AnchorStyles)
        Me.listBox1.Location = New System.Drawing.Point(8, 16)
        Me.listBox1.Size = New System.Drawing.Size(172, 496)
        Me.listBox1.TabIndex = 0
        Me.textBox1.Anchor = CType(System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Bottom Or System.Windows.Forms.AnchorStyles.Right, System.Windows.Forms.AnchorStyles)
        Me.textBox1.Location = New System.Drawing.Point(188, 16)
        Me.textBox1.Multiline = True
        Me.textBox1.ScrollBars = System.Windows.Forms.ScrollBars.Vertical
        Me.textBox1.Size = New System.Drawing.Size(420, 496)
        Me.textBox1.TabIndex = 1
        Me.ClientSize = New System.Drawing.Size(616, 525)
        Me.Controls.Add(Me.textBox1)
        Me.Controls.Add(Me.listBox1)
        Me.Text = "Select a PowerStatus property to get the value of"
    End Sub    

    <STAThread()>  _
    Shared Sub Main()
        Application.Run(New PowerStatusBrowserForm())
    End Sub

End Class


C#

using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing;
using System.Reflection;
using System.Windows.Forms;

namespace PowerStatusBrowser
{
    public class PowerStatusBrowserForm : System.Windows.Forms.Form
    {
        private System.Windows.Forms.ListBox listBox1;
        private System.Windows.Forms.TextBox textBox1;        

        public PowerStatusBrowserForm()
        {
            this.SuspendLayout();
            InitForm();

            //Add each property of the PowerStatus class to the list box.
            Type t = typeof(System.Windows.Forms.PowerStatus);            
            PropertyInfo[] pi = t.GetProperties();            
            for( int i=0; i<pi.Length; i++ )
                listBox1.Items.Add( pi[i].Name );            
            textBox1.Text = "The PowerStatus class has "+pi.Length.ToString()+" properties.\r\n";

            // Configure the list item selected handler for the list box to invoke a 
            // method that displays the value of each property.           
            listBox1.SelectedIndexChanged += new EventHandler(listBox1_SelectedIndexChanged);
            this.ResumeLayout(false);
        }
		
        private void listBox1_SelectedIndexChanged(object sender, EventArgs e)
        {
            // Return if no item is selected.
            if( listBox1.SelectedIndex == -1 ) return;
            // Get the property name from the list item
            string propname = listBox1.Text;

            // Display the value of the selected property of the PowerStatus type.
            Type t = typeof(System.Windows.Forms.PowerStatus);
            PropertyInfo[] pi = t.GetProperties();            
            PropertyInfo prop = null;
            for( int i=0; i<pi.Length; i++ )
                if( pi[i].Name == propname )
                {
                    prop = pi[i];
                    break;           
                }

            object propval = prop.GetValue(SystemInformation.PowerStatus, null);            
            textBox1.Text += "\r\nThe value of the "+propname+" property is: "+propval.ToString();
        }

        private void InitForm()
        {
            // Initialize the form settings
            this.listBox1 = new System.Windows.Forms.ListBox();
            this.textBox1 = new System.Windows.Forms.TextBox();            
            this.listBox1.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) 
                | System.Windows.Forms.AnchorStyles.Left) | System.Windows.Forms.AnchorStyles.Right)));
            this.listBox1.Location = new System.Drawing.Point(8, 16);
            this.listBox1.Size = new System.Drawing.Size(172, 496);
            this.listBox1.TabIndex = 0;            
            this.textBox1.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) 
                | System.Windows.Forms.AnchorStyles.Right)));
            this.textBox1.Location = new System.Drawing.Point(188, 16);
            this.textBox1.Multiline = true;
            this.textBox1.ScrollBars = System.Windows.Forms.ScrollBars.Vertical;           
            this.textBox1.Size = new System.Drawing.Size(420, 496);
            this.textBox1.TabIndex = 1;            
            this.ClientSize = new System.Drawing.Size(616, 525);            
            this.Controls.Add(this.textBox1);
            this.Controls.Add(this.listBox1);            
            this.Text = "Select a PowerStatus property to get the value of";                   
        }

        [STAThread]
        static void Main() 
        {
            Application.Run(new PowerStatusBrowserForm());
        }
    }
}


Visual C++

#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
#using <System.dll>

using namespace System;
using namespace System::Collections;
using namespace System::ComponentModel;
using namespace System::Drawing;
using namespace System::Reflection;
using namespace System::Windows::Forms;

public ref class PowerStatusBrowserForm: public System::Windows::Forms::Form
{
private:
   System::Windows::Forms::ListBox^ listBox1;
   System::Windows::Forms::TextBox^ textBox1;

public:
   PowerStatusBrowserForm()
   {
      this->SuspendLayout();
      InitForm();

      //Add each property of the PowerStatus class to the list box.
      Type^ t = System::Windows::Forms::PowerStatus::typeid;
      array<PropertyInfo^>^pi = t->GetProperties();
      for ( int i = 0; i < pi->Length; i++ )
         listBox1->Items->Add( pi[ i ]->Name );
      textBox1->Text = String::Format( "The PowerStatus class has {0} properties.\r\n", pi->Length );

      // Configure the list item selected handler for the list box to invoke a 
      // method that displays the value of each property.           
      listBox1->SelectedIndexChanged += gcnew EventHandler( this, &PowerStatusBrowserForm::listBox1_SelectedIndexChanged );
      this->ResumeLayout( false );
   }

private:
   void listBox1_SelectedIndexChanged( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      // Return if no item is selected.
      if ( listBox1->SelectedIndex == -1 )
            return;

      // Get the property name from the list item
      String^ propname = listBox1->Text;

      // Display the value of the selected property of the PowerStatus type.
      Type^ t = System::Windows::Forms::PowerStatus::typeid;
      array<PropertyInfo^>^pi = t->GetProperties();
      PropertyInfo^ prop = nullptr;
      for ( int i = 0; i < pi->Length; i++ )
         if ( pi[ i ]->Name == propname )
         {
            prop = pi[ i ];
            break;
         }

      Object^ propval = prop->GetValue( SystemInformation::PowerStatus, nullptr );
      textBox1->Text = String::Format( "{0}\r\nThe value of the {1} property is: {2}", textBox1->Text, propname, propval );
   }

   void InitForm()
   {
      // Initialize the form settings
      this->listBox1 = gcnew System::Windows::Forms::ListBox;
      this->textBox1 = gcnew System::Windows::Forms::TextBox;
      this->listBox1->Anchor = (System::Windows::Forms::AnchorStyles)(System::Windows::Forms::AnchorStyles::Top | System::Windows::Forms::AnchorStyles::Bottom | System::Windows::Forms::AnchorStyles::Left | System::Windows::Forms::AnchorStyles::Right);
      this->listBox1->Location = System::Drawing::Point( 8, 16 );
      this->listBox1->Size = System::Drawing::Size( 172, 496 );
      this->listBox1->TabIndex = 0;
      this->textBox1->Anchor = (System::Windows::Forms::AnchorStyles)(System::Windows::Forms::AnchorStyles::Top | System::Windows::Forms::AnchorStyles::Bottom | System::Windows::Forms::AnchorStyles::Right);
      this->textBox1->Location = System::Drawing::Point( 188, 16 );
      this->textBox1->Multiline = true;
      this->textBox1->ScrollBars = System::Windows::Forms::ScrollBars::Vertical;
      this->textBox1->Size = System::Drawing::Size( 420, 496 );
      this->textBox1->TabIndex = 1;
      this->ClientSize = System::Drawing::Size( 616, 525 );
      this->Controls->Add( this->textBox1 );
      this->Controls->Add( this->listBox1 );
      this->Text = "Select a PowerStatus property to get the value of";
   }
};

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


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference