Class IgbToolAction

Represents base class for all tool actions in toolbar

Inheritance

System.Object

BaseRendererElement

IgbToolAction

IgbToolActionButton

IgbToolActionButtonPair

IgbToolActionCheckbox

IgbToolActionCheckboxList

IgbToolActionColorEditor

IgbToolActionCombo

IgbToolActionFieldSelector

IgbToolActionGroupHeader

IgbToolActionIconButton

IgbToolActionLabel

IgbToolActionNumberInput

IgbToolActionRadio

IgbToolActionSeparator

IgbToolActionSubPanel

IgbToolActionTextInput

Implements

JsonSerializable

System.IDisposable

Inherited Members

BaseRendererElement._name

BaseRendererElement.eventCallbacksCache

BaseRendererElement._cachedSerializedContent

BaseRendererElement.EnsureModulesLoaded()

BaseRendererElement.BuildRenderTree(RenderTreeBuilder)

BaseRendererElement.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererElement.InvokeMethod(String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodSync(String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodHelper(String, String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodHelperSync(String, String, Object[], String[], ElementReference[])

BaseRendererElement.IsPropDirty(String)

BaseRendererElement.Serialize(SerializationContext, String)

BaseRendererElement.Serialize()

BaseRendererElement.EnsureValid()

BaseRendererElement.FromEventJson(BaseRendererControl, Dictionary<String, Object>)

BaseRendererElement.ToEventJson(BaseRendererControl, Dictionary<String, Object>)

BaseRendererElement.SetResourceStringAsync(String, String, String)

BaseRendererElement.SetResourceStringAsync(String, String)

BaseRendererElement.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)

BaseRendererElement.IgBlazor

BaseRendererElement.IsComponentRooted

BaseRendererElement.UseDirectRender

BaseRendererElement.ChildContent

BaseRendererElement.SupportsVisualChildren

BaseRendererElement.Name

BaseRendererElement.Parent

BaseRendererElement.MethodTarget

BaseRendererElement.CurrParent

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbToolAction : BaseRendererElement, JsonSerializable, IDisposable

Constructors

IgbToolAction()

Declaration

public IgbToolAction()

Properties

AccentColor

Declaration

public string AccentColor { get; set; }

Property Value

Type	Description
System.String

Actions

Gets the sub actions associated with this tool action.

Declaration

public IgbToolActionCollection Actions { get; protected set; }

Property Value

Type	Description
IgbToolActionCollection

ActualAccentColor

Declaration

public string ActualAccentColor { get; set; }

Property Value

Type	Description
System.String

ActualActions

Declaration

public IgbToolActionCollection ActualActions { get; }

Property Value

Type	Description
IgbToolActionCollection

ActualBackground

Gets the actual background used by the tool action.

Declaration

public string ActualBackground { get; set; }

Property Value

Type	Description
System.String

ActualDensity

Gets the resolved display density to use for the action.

Declaration

public ControlDisplayDensity ActualDensity { get; set; }

Property Value

Type	Description
ControlDisplayDensity

ActualDisabledTextColor

Gets the actual label text color when the tool is disabled.

Declaration

public string ActualDisabledTextColor { get; set; }

Property Value

Type	Description
System.String

ActualHighlightColor

Declaration

public string ActualHighlightColor { get; set; }

Property Value

Type	Description
System.String

ActualHighlightRadius

Declaration

public double ActualHighlightRadius { get; set; }

Property Value

Type	Description
System.Double

ActualHighlightWidth

Declaration

public double ActualHighlightWidth { get; set; }

Property Value

Type	Description
System.Double

ActualHoverBackground

Gets the actual hover background used by the tool action.

Declaration

public string ActualHoverBackground { get; set; }

Property Value

Type	Description
System.String

ActualIconFill

Gets the actual icon fill color.

Declaration

public string ActualIconFill { get; set; }

Property Value

Type	Description
System.String

ActualIconHeight

Gets the actual icon height used.

Declaration

public double ActualIconHeight { get; set; }

Property Value

Type	Description
System.Double

ActualIconStroke

Gets the actual icon stroke color.

Declaration

public string ActualIconStroke { get; set; }

Property Value

Type	Description
System.String

ActualIconWidth

Gets the actual icon width used.

Declaration

public double ActualIconWidth { get; set; }

Property Value

Type	Description
System.Double

ActualPaddingBottom

Declaration

public double ActualPaddingBottom { get; set; }

Property Value

Type	Description
System.Double

ActualPaddingLeft

Declaration

public double ActualPaddingLeft { get; set; }

Property Value

Type	Description
System.Double

ActualPaddingRight

Declaration

public double ActualPaddingRight { get; set; }

Property Value

Type	Description
System.Double

ActualPaddingTop

Declaration

public double ActualPaddingTop { get; set; }

Property Value

Type	Description
System.Double

ActualSubtitleTextColor

Gets the actual label text color.

Declaration

public string ActualSubtitleTextColor { get; set; }

Property Value

Type	Description
System.String

ActualTextColor

Gets the actual label text color.

Declaration

public string ActualTextColor { get; set; }

Property Value

Type	Description
System.String

AfterId

Gets or sets the Id of the action that this action will be inserted after.

Declaration

public string AfterId { get; set; }

Property Value

Type	Description
System.String

Remarks

Subsequent actions will continue to insert after the target action, following the original action that set this property. If using this property do not use the BeforeId property. This property is only relevant during initial insertion into the toolbar. Changing the property after the action has already been added will have no effect.

Background

Gets or sets the background color of the tool action.

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String

BeforeId

Gets or sets the Id of the action that this action will be inserted before.

Declaration

public string BeforeId { get; set; }

Property Value

Type	Description
System.String

Remarks

Subsequent actions will continue to insert before the target action, following the original action that set this property. If using this property do not use the AfterId property. This property is only relevant during initial insertion into the toolbar. Changing the property after the action has already been added will have no effect.

CloseOnExecute

Gets or sets if the tool action will close its parent dropdown when executed by the user.

Declaration

public bool CloseOnExecute { get; set; }

Property Value

Type	Description
System.Boolean

CommandArgument

Declaration

public string CommandArgument { get; set; }

Property Value

Type	Description
System.String

CommandArgumentValue

Declaration

public object CommandArgumentValue { get; set; }

Property Value

Type	Description
System.Object

CommandId

Declaration

public string CommandId { get; set; }

Property Value

Type	Description
System.String

ContentActions

Declaration

public IgbToolActionCollection ContentActions { get; }

Property Value

Type	Description
IgbToolActionCollection

ContextBindings

Gets the context bindings for this tool action.

Declaration

public IgbToolContextBindingCollection ContextBindings { get; set; }

Property Value

Type	Description
IgbToolContextBindingCollection

Density

Gets or sets the display density to use for the action.

Declaration

public ControlDisplayDensity Density { get; set; }

Property Value

Type	Description
ControlDisplayDensity

DisabledTextColor

Gets or sets the label text color when the tool is disabled.

Declaration

public string DisabledTextColor { get; set; }

Property Value

Type	Description
System.String

FontFamily

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
System.String

FontSize

Declaration

public double FontSize { get; set; }

Property Value

Type	Description
System.Double

FontStyle

Declaration

public string FontStyle { get; set; }

Property Value

Type	Description
System.String

FontWeight

Declaration

public string FontWeight { get; set; }

Property Value

Type	Description
System.String

Height

Gets or sets the height to use for this tool action.

Declaration

public double Height { get; set; }

Property Value

Type	Description
System.Double

HighlightColor

Declaration

public string HighlightColor { get; set; }

Property Value

Type	Description
System.String

HighlightRadius

Declaration

public double HighlightRadius { get; set; }

Property Value

Type	Description
System.Double

HighlightWidth

Declaration

public double HighlightWidth { get; set; }

Property Value

Type	Description
System.Double

HoverBackground

Gets or sets the hover background for this tool action.

Declaration

public string HoverBackground { get; set; }

Property Value

Type	Description
System.String

IconCollectionName

Declaration

public string IconCollectionName { get; set; }

Property Value

Type	Description
System.String

IconFill

Gets or sets the icon fill color.

Declaration

public string IconFill { get; set; }

Property Value

Type	Description
System.String

IconFillColors

Gets or sets the icon fill colors.

Declaration

public string IconFillColors { get; set; }

Property Value

Type	Description
System.String

IconHeight

Gets or sets the height of the icon.

Declaration

public double IconHeight { get; set; }

Property Value

Type	Description
System.Double

IconName

Declaration

public string IconName { get; set; }

Property Value

Type	Description
System.String

IconStroke

Gets or sets the icon stroke color.

Declaration

public string IconStroke { get; set; }

Property Value

Type	Description
System.String

IconStrokeColors

Gets or sets the icon stroke colors.

Declaration

public string IconStrokeColors { get; set; }

Property Value

Type	Description
System.String

IconStrokeWidth

Gets or sets the icon viewbox width.

Declaration

public double IconStrokeWidth { get; set; }

Property Value

Type	Description
System.Double

IconViewBoxHeight

Gets or sets the icon viewbox height.

Declaration

public double IconViewBoxHeight { get; set; }

Property Value

Type	Description
System.Double

IconViewBoxLeft

Gets or sets the icon viewbox left.

Declaration

public double IconViewBoxLeft { get; set; }

Property Value

Type	Description
System.Double

IconViewBoxTop

Gets or sets the icon viewbox top.

Declaration

public double IconViewBoxTop { get; set; }

Property Value

Type	Description
System.Double

IconViewBoxWidth

Gets or sets the icon viewbox width.

Declaration

public double IconViewBoxWidth { get; set; }

Property Value

Type	Description
System.Double

IconWidth

Gets or sets the width of the icon.

Declaration

public double IconWidth { get; set; }

Property Value

Type	Description
System.Double

IsDisabled

Declaration

public bool IsDisabled { get; set; }

Property Value

Type	Description
System.Boolean

IsHighlighted

Declaration

public bool IsHighlighted { get; set; }

Property Value

Type	Description
System.Boolean

OnCommand

Declaration

public EventCallback<IgbToolCommandEventArgs> OnCommand { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbToolCommandEventArgs>

OnCommandScript

Declaration

public string OnCommandScript { get; set; }

Property Value

Type	Description
System.String

OverlayId

Sets to the Id of the action that this action will overlay itself on to.

Declaration

public string OverlayId { get; set; }

Property Value

Type	Description
System.String

Remarks

The purpose of this property is to allow users to override actions automatically generated by toolbar targets such as the DataChart. These generated actions all have unique Ids associated with them that can be used for the OverlayId. These overlaid actions will not replace the generated one but will have its properties overlaid onto the generated actions.

PaddingBottom

Declaration

public double PaddingBottom { get; set; }

Property Value

Type	Description
System.Double

PaddingLeft

Declaration

public double PaddingLeft { get; set; }

Property Value

Type	Description
System.Double

PaddingRight

Declaration

public double PaddingRight { get; set; }

Property Value

Type	Description
System.Double

PaddingTop

Declaration

public double PaddingTop { get; set; }

Property Value

Type	Description
System.Double

ParentId

Declaration

public string ParentId { get; set; }

Property Value

Type	Description
System.String

ParentTypeName

Declaration

protected override string ParentTypeName { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererElement.ParentTypeName

Performed

Declaration

public EventCallback<IgbToolActionPerformedEventArgs> Performed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbToolActionPerformedEventArgs>

PerformedScript

Declaration

public string PerformedScript { get; set; }

Property Value

Type	Description
System.String

SubPanelRowHeight

Gets or sets the height to use for the sub panel if different than default

Declaration

public int SubPanelRowHeight { get; set; }

Property Value

Type	Description
System.Int32

Subtitle

Gets or sets the subtitle of the tool.

Declaration

public string Subtitle { get; set; }

Property Value

Type	Description
System.String

SubtitleFontFamily

Declaration

public string SubtitleFontFamily { get; set; }

Property Value

Type	Description
System.String

SubtitleFontSize

Declaration

public double SubtitleFontSize { get; set; }

Property Value

Type	Description
System.Double

SubtitleFontStyle

Declaration

public string SubtitleFontStyle { get; set; }

Property Value

Type	Description
System.String

SubtitleFontWeight

Declaration

public string SubtitleFontWeight { get; set; }

Property Value

Type	Description
System.String

SubtitleTextColor

Gets or sets the label text color.

Declaration

public string SubtitleTextColor { get; set; }

Property Value

Type	Description
System.String

TextColor

Gets or sets the label text color.

Declaration

public string TextColor { get; set; }

Property Value

Type	Description
System.String

Title

Gets or sets the title of the tool.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

TitleHorizontalAlignment

Gets or sets the title horizontal alignment.

Declaration

public HorizontalAlignment TitleHorizontalAlignment { get; set; }

Property Value

Type	Description
HorizontalAlignment

ToolActionParent

Declaration

protected BaseRendererElement ToolActionParent { get; set; }

Property Value

Type	Description
BaseRendererElement

ToolbarParent

Declaration

protected BaseRendererControl ToolbarParent { get; set; }

Property Value

Type	Description
BaseRendererControl

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererElement.Type

Visibility

Gets or sets the tool action visibility.

Declaration

public Visibility Visibility { get; set; }

Property Value

Type	Description
Visibility

Width

Gets or sets the width to use for this tool action.

Declaration

public double Width { get; set; }

Property Value

Type	Description
System.Double

Methods

CloseSubmenu()

Declaration

public virtual void CloseSubmenu()

CloseSubmenuAsync()

Declaration

public virtual Task CloseSubmenuAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Dispose()

Declaration

public void Dispose()

ExportSerializedVisualData()

Declaration

public string ExportSerializedVisualData()

Returns

Type	Description
System.String

ExportSerializedVisualDataAsync()

Declaration

public Task<string> ExportSerializedVisualDataAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

ExportVisualData()

Declaration

public virtual object ExportVisualData()

Returns

Type	Description
System.Object

ExportVisualDataAsync()

Declaration

public virtual Task<object> ExportVisualDataAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

BaseRendererElement.FindByName(String)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

OpenSubMenu()

Declaration

public virtual void OpenSubMenu()

OpenSubMenuAsync()

Declaration

public virtual Task OpenSubMenuAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Implements

JsonSerializable

System.IDisposable