Class BannerTextProvider
Provides the ability to show banner text (text cue) for text box controls.
Inheritance
Implements
Namespace: Syncfusion.Windows.Forms
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class BannerTextProvider : Component, IExtenderProviderConstructors
BannerTextProvider()
Default constructor.
Declaration
public BannerTextProvider()BannerTextProvider(IContainer)
Creates instance of BannerTextProvider class and registers it in owner's container.
Declaration
public BannerTextProvider(IContainer container)Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.IContainer | container | Owner's container. |
Properties
ETB2Component
Retrieves text box to component backward map.
Declaration
protected static IDictionary ETB2Component { get; }Property Value
| Type |
|---|
| System.Collections.IDictionary |
Remarks
Mapping is created on demand.
Methods
Dispose(Boolean)
Releases the resources used by the BannerTextProvider.
Declaration
protected override void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
Extend(BannerTextProvider, IExtendableTexBox, IExtendableTexBox)
Static helper method to extend a sub text box using a specified BannerTextProvider.
Declaration
protected static void Extend(BannerTextProvider provider, IExtendableTexBox mainETB, IExtendableTexBox subETB)Parameters
| Type | Name | Description |
|---|---|---|
| BannerTextProvider | provider | The banner text provider instance to use for extension. |
| IExtendableTexBox | mainETB | The main extendable text box already associated with a component. |
| IExtendableTexBox | subETB | The sub extendable text box to be linked and extended. |
Extend(IExtendableTexBox, IExtendableTexBox)
Associates a sub text box with the same component as the main text box and extends it with banner text functionality.
Declaration
protected void Extend(IExtendableTexBox mainETB, IExtendableTexBox subETB)Parameters
| Type | Name | Description |
|---|---|---|
| IExtendableTexBox | mainETB | The main extendable text box already associated with a component. |
| IExtendableTexBox | subETB | The sub extendable text box to be linked and extended. |
Extend(Component, IExtendableTexBox)
Extends the specified component with banner text functionality using the provided IExtendableTexBox.
Declaration
protected void Extend(Component component, IExtendableTexBox etb)Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.Component | component | The component to be extended. |
| IExtendableTexBox | etb | The extendable text box interface used to apply banner text. |
GetBannerText(Component)
Returns BannerTextInfo for given component.
Declaration
public BannerTextInfo GetBannerText(Component component)Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.Component | component | Component to retirive info for. |
Returns
| Type | Description |
|---|---|
| BannerTextInfo | Associated BannerTextInfo object. |
Remarks
Returns a copy of BannerTextInfo object.
RegisterProvider(IComponentBannerTextProvider)
Register additional IComponentBannerTextProvider.
Declaration
public static void RegisterProvider(IComponentBannerTextProvider provider)Parameters
| Type | Name | Description |
|---|---|---|
| IComponentBannerTextProvider | provider | Provider to register. |
ResetBannerText(Component)
Resets the BannerText property for the specified component to its default value.
Declaration
protected void ResetBannerText(Component component)Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.Component | component | The component whose banner text should be reset. |
SetBannerText(Component, BannerTextInfo)
Associates BannerTextInfo with component.
Declaration
public void SetBannerText(Component component, BannerTextInfo info)Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.Component | component | Component. |
| BannerTextInfo | info | info object. |
ShouldSerializeBannerText(Component)
Determines whether the BannerText property for the specified component should be serialized.
Declaration
protected bool ShouldSerializeBannerText(Component component)Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.Component | component | The component to check. |
Returns
| Type |
|---|
| System.Boolean |