Class AdvancedToolTip

Represents a control that displays the advanced tooltip for custom control.

Inheritance

System.Object

AdvancedToolTip

Namespace: Syncfusion.GridHelperClasses

Assembly: Syncfusion.GridHelperClasses.Windows.dll

Syntax

[CLSCompliant(true)]
public class AdvancedToolTip : ToolStripDropDown

Constructors

AdvancedToolTip(Control, Control)

Initializes a new instance of the AdvancedToolTip class.

Declaration

public AdvancedToolTip(Control innerControl, Control displayControl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	innerControl	The content of the pop-up.
System.Windows.Forms.Control	displayControl	Used for visual representation

Remarks

Pop-up will be disposed immediately after the content control is disposed.

Exceptions

Type	Condition
System.ArgumentNullException	innerControl is null .

Properties

AcceptAlt

Gets or sets a value indicating whether pressing the alt key should close the pop-up.

Declaration

public bool AcceptAlt { get; set; }

Property Value

Type	Description
System.Boolean	true if pressing the alt key does not close the pop-up; otherwise, false.

AnimationDuration

Gets or sets the duration time of the animation.

Declaration

public int AnimationDuration { get; set; }

Property Value

Type
System.Int32

ArrowHeadDirection

Gets or sets the arrow head direction while showing the pop-up window.

Declaration

public ArrowHeadDirection ArrowHeadDirection { get; set; }

Property Value

Type
ArrowHeadDirection

BorderColor

Gets or sets the border color of the tooltip window.

Declaration

public Color BorderColor { get; set; }

Property Value

Type
System.Drawing.Color

Content

Gets the content control of the pop-up.

Declaration

public Control Content { get; }

Property Value

Type
System.Windows.Forms.Control

CreateParams

Gets parameters of a new window.

Declaration

protected override CreateParams CreateParams { get; }

Property Value

Type	Description
System.Windows.Forms.CreateParams	An object of type System.Windows.Forms.CreateParams used when creating a new window.

DisplayControl

Gets or sets the system control in which the desired UserControl ToolTip needed to be displayed.

Declaration

public Control DisplayControl { get; set; }

Property Value

Type
System.Windows.Forms.Control

FocusOnOpen

Gets or sets a value indicating whether the content should receive the focus after the pop-up has been opened.

Declaration

public bool FocusOnOpen { get; set; }

Property Value

Type	Description
System.Boolean	true if the content should be focused after the pop-up has been opened; otherwise, false.

Remarks

If the FocusOnOpen property is set to false, then pop-up cannot use the fade effect.

HidingAnimation

Gets or sets the tooltip animation style while hiding the pop-up window.

Declaration

public ToolTipAnimations HidingAnimation { get; set; }

Property Value

Type
ToolTipAnimations

MaximumSize

Gets or sets a maximum size of the pop-up window.

Declaration

public Size MaximumSize { get; set; }

Property Value

Type	Description
System.Drawing.Size	An ordered pair of type System.Drawing.Size representing the width and height of a rectangle.

MinimumSize

Gets or sets a minimum size of the pop-up window.

Declaration

public Size MinimumSize { get; set; }

Property Value

Type	Description
System.Drawing.Size	An ordered pair of type System.Drawing.Size representing the width and height of a rectangle.

NonInteractive

Gets or sets a value indicating whether the GridExcelFilterPopup acts like a transparent windows (so it cannot be clicked).

Declaration

public bool NonInteractive { get; set; }

Property Value

Type	Description
System.Boolean	true if the popup is non interactive; otherwise, false.

Resizable

Gets or sets a value indicating whether the GridExcelFilterPopup is resizable.

Declaration

public bool Resizable { get; set; }

Property Value

Type	Description
System.Boolean	true if resizable; otherwise, false.

ShowingAnimation

Gets or sets the tooltip animation style while showing the pop-up window.

Declaration

public ToolTipAnimations ShowingAnimation { get; set; }

Property Value

Type
ToolTipAnimations

Methods

Dispose(Boolean)

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true if managed resources should be disposed; otherwise, false.

OnClosed(ToolStripDropDownClosedEventArgs)

Raises the System.Windows.Forms.ToolStripDropDown.Closed event.

Declaration

protected override void OnClosed(ToolStripDropDownClosedEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.ToolStripDropDownClosedEventArgs	e	A System.Windows.Forms.ToolStripDropDownClosedEventArgs that contains the event data.

OnLayout(LayoutEventArgs)

Raises the System.Windows.Forms.Control.Layout event.

Declaration

protected override void OnLayout(LayoutEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.LayoutEventArgs	e	A System.Windows.Forms.LayoutEventArgs that contains the event data.

OnOpened(EventArgs)

Raises the System.Windows.Forms.ToolStripDropDown.Opened event.

Declaration

protected override void OnOpened(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgs that contains the event data.

OnOpening(CancelEventArgs)

Raises the System.Windows.Forms.ToolStripDropDown.Opening event.

Declaration

protected override void OnOpening(CancelEventArgs e)

Parameters

Type	Name	Description
System.ComponentModel.CancelEventArgs	e	A System.ComponentModel.CancelEventArgs that contains the event data.

OnSizeChanged(EventArgs)

Raises the System.Windows.Forms.Control.SizeChanged event.

Declaration

protected override void OnSizeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgs that contains the event data.

OnVisibleChanged(EventArgs)

Raises the System.Windows.Forms.ToolStripItem.VisibleChanged event.

Declaration

protected override void OnVisibleChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgs that contains the event data.

ProcessDialogKey(Keys)

Processes a dialog box key.

Declaration

protected override bool ProcessDialogKey(Keys keyData)

Parameters

Type	Name	Description
System.Windows.Forms.Keys	keyData	One of the System.Windows.Forms.Keys values that represents the key to process.

Returns

Type	Description
System.Boolean	true if the key was processed by the control; otherwise, false.

ProcessResizing(ref Message)

Processes the resizing messages.

Declaration

public bool ProcessResizing(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m	The message.

Returns

Type	Description
System.Boolean	true, if the WndProc method from the base class shouldn't be invoked.

Show(Rectangle)

Shows the pop-up window below the specified area.

Declaration

public void Show(Rectangle area)

Parameters

Type	Name	Description
System.Drawing.Rectangle	area	The area of desktop below which the pop-up will be shown.

Remarks

When there is no space below specified area, the pop-up control is shown above it.

Show(Control)

Shows the pop-up window below the specified control.

Declaration

public void Show(Control control)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control below which the pop-up will be shown.

Remarks

When there is no space below the specified control, the pop-up control is shown above it.

Exceptions

Type	Condition
System.ArgumentNullException	control is null .

Show(Control, Rectangle)

Shows the pop-up window below the specified area of the specified control.

Declaration

public void Show(Control control, Rectangle area)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control used to compute screen location of specified area.
System.Drawing.Rectangle	area	The area of control below which the pop-up will be shown.

Remarks

When there is no space below specified area, the pop-up control is shown above it.

Exceptions

Type	Condition
System.ArgumentNullException	control is null .

UpdateRegion()

Updates the pop-up region.

Declaration

protected void UpdateRegion()

WndProc(ref Message)

Processes Windows messages.

Declaration

protected override void WndProc(ref Message m)

Parameters

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