Class StatusBarAdvPanel

The StatusBarAdvPanel is used with the StatusBarAdv to show information like key states date and time.

Inheritance
System.Object
GradientPanel
StatusBarAdvPanel
Implements
System.ComponentModel.ISupportInitialize
System.Runtime.Serialization.ISerializable
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class StatusBarAdvPanel : GradientPanel, IThemeProvider, IVisualStyle, IThemedControl, INonClientPaintingSupport, ISupportInitialize, ISerializable

Constructors

StatusBarAdvPanel()

Initializes a new instance of the StatusBarAdvPanel class.

Declaration
public StatusBarAdvPanel()

StatusBarAdvPanel(SerializationInfo, StreamingContext)

Declaration
protected StatusBarAdvPanel(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info
System.Runtime.Serialization.StreamingContext context

Properties

Alignment

Gets or sets the alignment type of the text and icon of the panel.

Declaration
public HorizontalAlignment Alignment { get; set; }
Property Value
Type
System.Windows.Forms.HorizontalAlignment

AnimationDelay

Gets or sets delay for animation of marquee style.

Declaration
public int AnimationDelay { get; set; }
Property Value
Type
System.Int32

AnimationDirection

Gets or sets direction of animation for marquee style.

Declaration
public MarqueeDirection AnimationDirection { get; set; }
Property Value
Type
MarqueeDirection

AnimationSpeed

Gets or sets animation speed of marquee style.

Declaration
public int AnimationSpeed { get; set; }
Property Value
Type
System.Int32

AnimationStyle

Gets or sets style of animation for marquee style.

Declaration
public MarqueeStyle AnimationStyle { get; set; }
Property Value
Type
MarqueeStyle

BackColor

Gets or sets the backcolor of the panel.

Declaration
public Color BackColor { get; set; }
Property Value
Type
System.Drawing.Color

BeforeTouchSize

Gets/Sets Control size before touch enabled

Declaration
public Size BeforeTouchSize { get; set; }
Property Value
Type
System.Drawing.Size

CustomOFFText

Gets or sets the custom OFF text.

Declaration
public string CustomOFFText { get; set; }
Property Value
Type Description
System.String

The custom OFF text.
Remarks

This value represents the CustomOFFText of the StatusBarAdvPanel. The CustomOnText is will be set only if EnableCustomText is set to True.

CustomONText

Gets or sets the custom ON text.

Declaration
public string CustomONText { get; set; }
Property Value
Type Description
System.String

The custom on text.
Remarks

This value represents the CustomOnText of the StatusBarAdvPanel. The CustomOnText will be set only if EnableCustomText is set to True.

EnableTouchMode

Gets or sets value to enable or disable the Touchmode to the controls.

Declaration
public bool EnableTouchMode { get; set; }
Property Value
Type
System.Boolean
Remarks

Scale factor will be updated automatically if scalefactor is equal to 1

Font

Gets or sets the System.Drawing.Font value of the StatusBarAdvPanel control.

Declaration
public override Font Font { get; set; }
Property Value
Type
System.Drawing.Font

HAlign

Gets or sets the HorizontalAlignment in the FlowLayout.

Declaration
public HorzFlowAlign HAlign { get; set; }
Property Value
Type
HorzFlowAlign
Remarks

Set this property if the parent StatusBar has the Alignment property set to ChildConstraints. Otherwise this setting will not be taken into account.

Icon

Gets or sets the icon of the panel.

Declaration
public Icon Icon { get; set; }
Property Value
Type
System.Drawing.Icon
Remarks

This icon represents the icon that appears in the panel. It is a 16x16 icon.

IgnoreThemeBackground

Gets or sets a value indicating whether the control will ignore the theme's background color and draw the backcolor instead.

Declaration
public bool IgnoreThemeBackground { get; set; }
Property Value
Type
System.Boolean

IsMarquee

Gets or sets a value indicating whether control uses marquee style for displaying text.

Declaration
public bool IsMarquee { get; set; }
Property Value
Type
System.Boolean

PanelType

Gets or sets the type of the panel.

Declaration
public StatusBarAdvPanelType PanelType { get; set; }
Property Value
Type
StatusBarAdvPanelType
Remarks

Set this property if you want the panel to display a predefined text representing key states, date/time information or culture information.

PreferredSize

Gets or sets the preferred size of the panel in the FlowLayout.

Declaration
public Size PreferredSize { get; set; }
Property Value
Type
System.Drawing.Size

ShowCustomText

Declaration
public bool ShowCustomText { get; set; }
Property Value
Type
System.Boolean

SizeToContent

Gets or sets a value indicating whether the size of the panel will be automatically calculated by the size of it`s contents.

Declaration
public bool SizeToContent { get; set; }
Property Value
Type
System.Boolean

Text

Gets or sets the text of the panel.

Declaration
public string Text { get; set; }
Property Value
Type
System.String
Remarks

This property will be ignored if the PanelType property is set to a value different than Custom.

ThemesEnabled

Gets or sets a value indicating whether the background color will be set to Transparent. Indicated settings: BorderStyle:Fixed3D, Border3DStyle = Etched.

Declaration
public bool ThemesEnabled { get; set; }
Property Value
Type
System.Boolean

ToolTip

Gets or sets the tool tip of the panel.

Declaration
public string ToolTip { get; set; }
Property Value
Type
System.String

Methods

ApplyScaleToControl(Single)

Scale the control based on the scale factor passed in the argument.

Declaration
public void ApplyScaleToControl(float scaleFactor)
Parameters
Type Name Description
System.Single scaleFactor

value to scale the factor based upon.

Dispose(Boolean)

Cleans up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Booll disposing
Overrides

GetText()

Method returns text according to the KeyState.

Declaration
public string GetText()
Returns
Type Description
System.String

returns string

OnAlignChanged()

Method is called when AlignChanged Event is triggered.

Declaration
protected void OnAlignChanged()

OnAnimationDelayChanged()

Declaration
protected virtual void OnAnimationDelayChanged()

OnAnimationDirectionChanged()

Declaration
protected virtual void OnAnimationDirectionChanged()

OnAnimationSpeedChanged()

Declaration
protected virtual void OnAnimationSpeedChanged()

OnAnimationStyleChanged()

Declaration
protected virtual void OnAnimationStyleChanged()

OnConstraintsChanged()

Method is called when ConstraintsChanged Event is triggered.

Declaration
protected void OnConstraintsChanged()

OnFontChanged(EventArgs)

Font changed

Declaration
protected override void OnFontChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnHandleCreated(EventArgs)

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnIconChanged()

Method is called when IconChanged Event is triggered.

Declaration
protected void OnIconChanged()

OnIsMarqueeChanged()

Declaration
protected virtual void OnIsMarqueeChanged()

OnMinimumSizeChanged()

Method is called when MinimumSizeChanged Event is triggered.

Declaration
protected void OnMinimumSizeChanged()

OnPaint(PaintEventArgs)

Raises the paint event.

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

The System.Windows.Forms.PaintEventArgs instance containing the event data.
Overrides

OnPreferredSizeChanged()

Method is called when PreferredSizeChanged Event is triggered.

Declaration
protected void OnPreferredSizeChanged()

OnSizeChanged(EventArgs)

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnTypeChanged()

Method is called when TypeChanged Event is triggered.

Declaration
protected void OnTypeChanged()

StartAnimation()

Starts animation for marquee style.

Declaration
public void StartAnimation()

StopAnimation()

Stops animation.

Declaration
public void StopAnimation()

ThemedPaintBackground(Graphics, Rectangle, Rectangle)

Declaration
protected override void ThemedPaintBackground(Graphics graphics, Rectangle rect, Rectangle clip)
Parameters
Type Name Description
System.Drawing.Graphics graphics
System.Drawing.Rectangle rect
System.Drawing.Rectangle clip
Overrides

Events

AlignChanged

Event is thrown at any time, if the alignment of panel changes.

Declaration
public event EventHandler AlignChanged
Event Type
Type
System.EventHandler

AnimationDelayChanged

Raised when the Animation delay is changed.

Declaration
public event EventHandler AnimationDelayChanged
Event Type
Type
System.EventHandler

AnimationDirectionChanged

Raised when the Animation direction is changed.

Declaration
public event EventHandler AnimationDirectionChanged
Event Type
Type
System.EventHandler

AnimationSpeedChanged

Raised when the Animation speed is changed.

Declaration
public event EventHandler AnimationSpeedChanged
Event Type
Type
System.EventHandler

AnimationStyleChanged

Raised when the Animation style is changed.

Declaration
public event EventHandler AnimationStyleChanged
Event Type
Type
System.EventHandler

ConstraintsChanged

Event is raised if the list of constraints has changed.

Declaration
public event EventHandler ConstraintsChanged
Event Type
Type
System.EventHandler

IconChanged

Event is raised when icon of the panel changes.

Declaration
public event EventHandler IconChanged
Event Type
Type
System.EventHandler

IsMarqueeChanged

Raised when the IsMarquee property is changed.

Declaration
public event EventHandler IsMarqueeChanged
Event Type
Type
System.EventHandler

PreferredSizeChanged

Declaration
public event EventHandler PreferredSizeChanged
Event Type
Type
System.EventHandler

textChanged

Declaration
[CLSCompliant(false)]
public event StatusBarAdvPanel.PanelTextChanged textChanged
Event Type
Type
StatusBarAdvPanel.PanelTextChanged

TypeChanged

Event is triggered when PanelType changes.

Declaration
public event EventHandler TypeChanged
Event Type
Type
System.EventHandler

Explicit Interface Implementations

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Declaration
void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info
System.Runtime.Serialization.StreamingContext context

Implements

System.ComponentModel.ISupportInitialize
System.Runtime.Serialization.ISerializable