Class BasePopupForm

Represents a class that contains the common base form for all popup stuff.

Inheritance

System.Object

BasePopupForm

ContextPrompt

ToolTipEx

Namespace: Syncfusion.Windows.Forms.Edit.Forms.Popup

Assembly: Syncfusion.Edit.Windows.dll

Syntax

public class BasePopupForm : Form

Constructors

BasePopupForm()

Initializes a new instance of the BasePopupForm class.

Declaration

public BasePopupForm()

BasePopupForm(Control)

Initializes a new instance of the BasePopupForm class.

Declaration

public BasePopupForm(Control parent)

Parameters

Type	Name	Description
System.Windows.Forms.Control	parent	Parent control.

BasePopupForm(Control, Boolean)

Initializes a new instance of the BasePopupForm class.

Declaration

public BasePopupForm(Control parent, bool bFadeIn)

Parameters

Type	Name	Description
System.Windows.Forms.Control	parent	Parent control.
System.Boolean	bFadeIn	Indicates whether form should be faded in while shown.

BasePopupForm(Control, Boolean, Single)

Initializes a new instance of the BasePopupForm class.

Declaration

public BasePopupForm(Control parent, bool bFadeIn, float fOpacityStep)

Parameters

Type	Name	Description
System.Windows.Forms.Control	parent	Parent control.
System.Boolean	bFadeIn	Indicates whether form should be faded in while shown.
System.Single	fOpacityStep	Step of opacity incrementation while fading in.

BasePopupForm(Control, Boolean, Single, Boolean, Boolean, Boolean)

Initializes a new instance of the BasePopupForm class.

Declaration

public BasePopupForm(Control parent, bool bFadeIn, float fOpacityStep, bool bInactive, bool bCloseOnParentClick, bool bCatchParentActivation)

Parameters

Type	Name	Description
System.Windows.Forms.Control	parent	Parent control.
System.Boolean	bFadeIn	Indicates whether form should be faded in while shown.
System.Single	fOpacityStep	Step of opacity incrementation while fading in.
System.Boolean	bInactive	Indicates whether form must be inactive. True by default.
System.Boolean	bCloseOnParentClick	Indicates whether form must be closed on parent click.
System.Boolean	bCatchParentActivation	Indicates whether parent's WM_NCACTIVATE message should be caught. When set to false, the focus is returned by simple giving it back. The parent's caption is blinking in this case.

Fields

m_backgroundBrush

Brush to draw backgrounds.

Declaration

protected BrushInfo m_backgroundBrush

Field Value

Type
BrushInfo

m_borderPen

Pen to draw single border.

Declaration

protected Pen m_borderPen

Field Value

Type
System.Drawing.Pen

m_ForeColor

Gets or sets the foreground color of the form.

Declaration

protected Color m_ForeColor

Field Value

Type
System.Drawing.Color

Properties

BackgroundBrush

Gets or sets the brush that is used for drawing background of form.

Declaration

public BrushInfo BackgroundBrush { get; set; }

Property Value

Type
BrushInfo

BorderColor

Gets or sets the border color of BasePopupForm.

Declaration

public Color BorderColor { get; set; }

Property Value

Type
System.Drawing.Color

FadeIn

Gets or sets a value indicating whether the form should be faded in while showing.

Declaration

public bool FadeIn { get; set; }

Property Value

Type
System.Boolean

ForeColor

Gets or sets the foreground color of the form.

Declaration

public Color ForeColor { get; set; }

Property Value

Type
System.Drawing.Color

OpacityStep

Gets or sets the step of opacity incrementation while fading in.

Declaration

public float OpacityStep { get; set; }

Property Value

Type
System.Single

Visible

Gets or sets a value indicating whether the form is visible or not.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Methods

Dispose(Boolean)

Releases all resources used by this Controls component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	True to release both managed and unmanaged resources; false to release only unmanaged resources.

OnActivated(EventArgs)

Performs activation-related operations.

Declaration

protected override void OnActivated(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	Event arguments.

OnClosed(EventArgs)

Performs closing-related operations.

Declaration

protected override void OnClosed(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	Event arguments.

SetVisibleCore(Boolean)

Shows/hides window without focusing.

Declaration

protected override void SetVisibleCore(bool value)

Parameters

Type	Name	Description
System.Boolean	value	Indicates whether window has to be set to visible or not.

Show()

Displays the form with fading in when it is needed.

Declaration

public void Show()

WndProc(ref Message)

Prevents base form from blinking.

Declaration

protected override void WndProc(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m	The Windows Message to process.