Class BannerTextProvider.TextBoxExtender

Renders banner text for System.Windows.Forms.TextBox-derived control.

Inheritance

System.Object

BannerTextProvider.TextBoxExtender

Namespace: Syncfusion.Windows.Forms

Assembly: Syncfusion.Shared.Base.dll

Syntax

public class TextBoxExtender : NativeWindow

Constructors

TextBoxExtender(BannerTextInfo, IExtendableTexBox)

Declaration

public TextBoxExtender(BannerTextInfo info, IExtendableTexBox etb)

Parameters

Type	Name	Description
BannerTextInfo	info
IExtendableTexBox	etb

Properties

ETB

Declaration

public IExtendableTexBox ETB { get; }

Property Value

Type
IExtendableTexBox

Font

Declaration

public Font Font { get; }

Property Value

Type
System.Drawing.Font

IsTextEmpty

Declaration

protected bool IsTextEmpty { get; }

Property Value

Type
System.Boolean

ShouldDrawBanner

Declaration

protected bool ShouldDrawBanner { get; }

Property Value

Type
System.Boolean

Methods

DrawBannerText(Graphics, BannerTextInfo, Color, Font, RightToLeft, Rectangle)

Draws banner text.

Declaration

public static void DrawBannerText(Graphics g, BannerTextInfo info, Color bgColor, Font font, RightToLeft rtl, Rectangle clientRect)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	System.Drawing.Graphics to draw at.
BannerTextInfo	info	Specifies banner text appearance.
System.Drawing.Color	bgColor	Banner text background color.
System.Drawing.Font	font	Fallback font for the case when doesn't contain valid font.
System.Windows.Forms.RightToLeft	rtl	Text flow layout.
System.Drawing.Rectangle	clientRect	Rectangle to draw within.

IsBannerTextVisible(BannerTextInfo, Boolean, Boolean)

Determines whether draw text is visible and must be drawn.

Declaration

public static bool IsBannerTextVisible(BannerTextInfo info, bool bFocused, bool bEmptyText)

Parameters

Type	Name	Description
BannerTextInfo	info	Describes banner text appearance.
System.Boolean	bFocused	Indicates whether extended text box is focused.
System.Boolean	bEmptyText	Indicates whether extended text box's text is empty.

Returns

Type	Description
System.Boolean	True if banner text is visible.

OnHandleChange()

Declaration

protected override void OnHandleChange()

OnPaint(Graphics)

Declaration

protected virtual void OnPaint(Graphics g)

Parameters

Type	Name	Description
System.Drawing.Graphics	g

ReleaseHandle()

Declaration

public override void ReleaseHandle()

WndProc(ref Message)

Declaration

protected override void WndProc(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m