Class IgbBanner

The igc-banner component displays important and concise message(s) for a user to address, that is specific to a page or feature.

Inheritance
System.Object
BaseRendererControl
IgbBanner
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbBanner : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbBanner()

Declaration
public IgbBanner()

Properties

Closed

Declaration
public EventCallback<IgbVoidEventArgs> Closed { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosedScript

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

Closing

Declaration
public EventCallback<IgbVoidEventArgs> Closing { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosingScript

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

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

Open

Determines whether the banner is being shown/hidden.

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

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

Hide()

Declaration
public bool Hide()
Returns
Type Description
System.Boolean

HideAsync()

Hides the banner if not already hidden. Returns true when the animation has completed.

Declaration
public Task<bool> HideAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Show()

Declaration
public bool Show()
Returns
Type Description
System.Boolean

ShowAsync()

Shows the banner if not already shown. Returns true when the animation has completed.

Declaration
public Task<bool> ShowAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Toggle()

Declaration
public bool Toggle()
Returns
Type Description
System.Boolean

ToggleAsync()

Toggles between shown/hidden state. Returns true when the animation has completed.

Declaration
public Task<bool> ToggleAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Implements

System.IDisposable