Represents base class for all tool actions in toolbar

Inheritance

object
Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

Constructors

Section titled "Constructors"

constructor

public IgbToolAction()

Returns IgbToolAction

Properties

Section titled "Properties"

IgBlazor

Section titled "IgBlazor"

Inherited from: BaseRendererElement 

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

IsComponentRooted

Section titled "IsComponentRooted"

Inherited from: BaseRendererElement 

public bool IsComponentRooted { get; }

UseDirectRender

Section titled "UseDirectRender"

Inherited from: BaseRendererElement 

protected virtual bool UseDirectRender { get; }

ChildContent

Section titled "ChildContent"

Inherited from: BaseRendererElement 

[Parameter]
public RenderFragment ChildContent { get; set; }

SupportsVisualChildren

Section titled "SupportsVisualChildren"

Inherited from: BaseRendererElement 

protected virtual bool SupportsVisualChildren { get; }

Name

Section titled "Name"

Inherited from: BaseRendererElement 

[Parameter]
public string Name { get; set; }

Parent

Section titled "Parent"

Inherited from: BaseRendererElement 

public object Parent { get; }

MethodTarget

Section titled "MethodTarget"

Inherited from: BaseRendererElement 

protected virtual string MethodTarget { get; }

CurrParent

Section titled "CurrParent"

Inherited from: BaseRendererElement 

protected object CurrParent { get; }

AccentColor

Section titled "AccentColor" 
[Parameter]
public string AccentColor { get; set; }

Actions

Section titled "Actions"

Gets the sub actions associated with this tool action.

 
public IgbToolActionCollection Actions { get; protected set; }

ActualAccentColor

Section titled "ActualAccentColor" 
[Parameter]
public string ActualAccentColor { get; set; }

ActualActions

Section titled "ActualActions" 
public IgbToolActionCollection ActualActions { get; }

ActualBackground

Section titled "ActualBackground"

Gets the actual background used by the tool action.

 
[Parameter]
public string ActualBackground { get; set; }

ActualDensity

Section titled "ActualDensity"

Gets the resolved display density to use for the action.

 
[Parameter]
public ControlDisplayDensity ActualDensity { get; set; }

ActualDisabledTextColor

Section titled "ActualDisabledTextColor"

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

 
[Parameter]
public string ActualDisabledTextColor { get; set; }

ActualHighlightColor

Section titled "ActualHighlightColor" 
[Parameter]
public string ActualHighlightColor { get; set; }

ActualHighlightRadius

Section titled "ActualHighlightRadius" 
[Parameter]
public double ActualHighlightRadius { get; set; }

ActualHighlightWidth

Section titled "ActualHighlightWidth" 
[Parameter]
public double ActualHighlightWidth { get; set; }

ActualHoverBackground

Section titled "ActualHoverBackground"

Gets the actual hover background used by the tool action.

 
[Parameter]
public string ActualHoverBackground { get; set; }

ActualIconFill

Section titled "ActualIconFill"

Gets the actual icon fill color.

 
[Parameter]
public string ActualIconFill { get; set; }

ActualIconHeight

Section titled "ActualIconHeight"

Gets the actual icon height used.

 
[Parameter]
public double ActualIconHeight { get; set; }

ActualIconStroke

Section titled "ActualIconStroke"

Gets the actual icon stroke color.

 
[Parameter]
public string ActualIconStroke { get; set; }

ActualIconWidth

Section titled "ActualIconWidth"

Gets the actual icon width used.

 
[Parameter]
public double ActualIconWidth { get; set; }

ActualPaddingBottom

Section titled "ActualPaddingBottom" 
[Parameter]
public double ActualPaddingBottom { get; set; }

ActualPaddingLeft

Section titled "ActualPaddingLeft" 
[Parameter]
public double ActualPaddingLeft { get; set; }

ActualPaddingRight

Section titled "ActualPaddingRight" 
[Parameter]
public double ActualPaddingRight { get; set; }

ActualPaddingTop

Section titled "ActualPaddingTop" 
[Parameter]
public double ActualPaddingTop { get; set; }

ActualSubPanelRowHeight

Section titled "ActualSubPanelRowHeight" 
[Parameter]
public int ActualSubPanelRowHeight { get; set; }

ActualSubtitleTextColor

Section titled "ActualSubtitleTextColor"

Gets the actual label text color.

 
[Parameter]
public string ActualSubtitleTextColor { get; set; }

ActualTextColor

Section titled "ActualTextColor"

Gets the actual label text color.

 
[Parameter]
public string ActualTextColor { get; set; }

AfterId

Section titled "AfterId"

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

 
[Parameter]
public string AfterId { get; set; }

Background

Section titled "Background"

Gets or sets the background color of the tool action.

 
[Parameter]
public string Background { get; set; }

BeforeId

Section titled "BeforeId"

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

 
[Parameter]
public string BeforeId { get; set; }

CloseOnExecute

Section titled "CloseOnExecute"

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

 
[Parameter]
public bool CloseOnExecute { get; set; }

CommandArgument

Section titled "CommandArgument" 
[Parameter]
public string CommandArgument { get; set; }

CommandArgumentValue

Section titled "CommandArgumentValue" 
[Parameter]
public object CommandArgumentValue { get; set; }

CommandId

Section titled "CommandId" 
[Parameter]
public string CommandId { get; set; }

ContentActions

Section titled "ContentActions" 
public IgbToolActionCollection ContentActions { get; }

ContextBindings

Section titled "ContextBindings"

Gets the context bindings for this tool action.

 
public IgbToolContextBindingCollection ContextBindings { get; set; }

Density

Section titled "Density"

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

 
[Parameter]
public ControlDisplayDensity Density { get; set; }

DisabledTextColor

Section titled "DisabledTextColor"

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

 
[Parameter]
public string DisabledTextColor { get; set; }

FontFamily

Section titled "FontFamily" 
[Parameter]
public string FontFamily { get; set; }

FontSize

Section titled "FontSize" 
[Parameter]
public double FontSize { get; set; }

FontStyle

Section titled "FontStyle" 
[Parameter]
public string FontStyle { get; set; }

FontWeight

Section titled "FontWeight" 
[Parameter]
public string FontWeight { get; set; }

Height

Section titled "Height"

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

 
[Parameter]
public double Height { get; set; }

HighlightColor

Section titled "HighlightColor" 
[Parameter]
public string HighlightColor { get; set; }

HighlightRadius

Section titled "HighlightRadius" 
[Parameter]
public double HighlightRadius { get; set; }

HighlightWidth

Section titled "HighlightWidth" 
[Parameter]
public double HighlightWidth { get; set; }

HoverBackground

Section titled "HoverBackground"

Gets or sets the hover background for this tool action.

 
[Parameter]
public string HoverBackground { get; set; }

IconCollectionName

Section titled "IconCollectionName" 
[Parameter]
public string IconCollectionName { get; set; }

IconFill

Section titled "IconFill"

Gets or sets the icon fill color.

 
[Parameter]
public string IconFill { get; set; }

IconFillColors

Section titled "IconFillColors"

Gets or sets the icon fill colors.

 
[Parameter]
public string IconFillColors { get; set; }

IconHeight

Section titled "IconHeight"

Gets or sets the height of the icon.

 
[Parameter]
public double IconHeight { get; set; }

IconName

Section titled "IconName" 
[Parameter]
public string IconName { get; set; }

IconStroke

Section titled "IconStroke"

Gets or sets the icon stroke color.

 
[Parameter]
public string IconStroke { get; set; }

IconStrokeColors

Section titled "IconStrokeColors"

Gets or sets the icon stroke colors.

 
[Parameter]
public string IconStrokeColors { get; set; }

IconStrokeWidth

Section titled "IconStrokeWidth"

Gets or sets the icon viewbox width.

 
[Parameter]
public double IconStrokeWidth { get; set; }

IconViewBoxHeight

Section titled "IconViewBoxHeight"

Gets or sets the icon viewbox height.

 
[Parameter]
public double IconViewBoxHeight { get; set; }

IconViewBoxLeft

Section titled "IconViewBoxLeft"

Gets or sets the icon viewbox left.

 
[Parameter]
public double IconViewBoxLeft { get; set; }

IconViewBoxTop

Section titled "IconViewBoxTop"

Gets or sets the icon viewbox top.

 
[Parameter]
public double IconViewBoxTop { get; set; }

IconViewBoxWidth

Section titled "IconViewBoxWidth"

Gets or sets the icon viewbox width.

 
[Parameter]
public double IconViewBoxWidth { get; set; }

IconWidth

Section titled "IconWidth"

Gets or sets the width of the icon.

 
[Parameter]
public double IconWidth { get; set; }

IsDisabled

Section titled "IsDisabled" 
[Parameter]
public bool IsDisabled { get; set; }

IsHighlighted

Section titled "IsHighlighted" 
[Parameter]
public bool IsHighlighted { get; set; }

OverlayId

Section titled "OverlayId"

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

 
[Parameter]
public string OverlayId { get; set; }

PaddingBottom

Section titled "PaddingBottom" 
[Parameter]
public double PaddingBottom { get; set; }

PaddingLeft

Section titled "PaddingLeft" 
[Parameter]
public double PaddingLeft { get; set; }

PaddingRight

Section titled "PaddingRight" 
[Parameter]
public double PaddingRight { get; set; }

PaddingTop

Section titled "PaddingTop" 
[Parameter]
public double PaddingTop { get; set; }

ParentId

Section titled "ParentId" 
[Parameter]
public string ParentId { get; set; }

ParentTypeName

Section titled "ParentTypeName" 
protected override string ParentTypeName { get; }

SubPanelRowHeight

Section titled "SubPanelRowHeight"

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

 
[Parameter]
public int SubPanelRowHeight { get; set; }

Subtitle

Section titled "Subtitle"

Gets or sets the subtitle of the tool.

 
[Parameter]
public string Subtitle { get; set; }

SubtitleFontFamily

Section titled "SubtitleFontFamily" 
[Parameter]
public string SubtitleFontFamily { get; set; }

SubtitleFontSize

Section titled "SubtitleFontSize" 
[Parameter]
public double SubtitleFontSize { get; set; }

SubtitleFontStyle

Section titled "SubtitleFontStyle" 
[Parameter]
public string SubtitleFontStyle { get; set; }

SubtitleFontWeight

Section titled "SubtitleFontWeight" 
[Parameter]
public string SubtitleFontWeight { get; set; }

SubtitleTextColor

Section titled "SubtitleTextColor"

Gets or sets the label text color.

 
[Parameter]
public string SubtitleTextColor { get; set; }

TextColor

Section titled "TextColor"

Gets or sets the label text color.

 
[Parameter]
public string TextColor { get; set; }

Title

Section titled "Title"

Gets or sets the title of the tool.

 
[Parameter]
public string Title { get; set; }

TitleHorizontalAlignment

Section titled "TitleHorizontalAlignment"

Gets or sets the title horizontal alignment.

 
[Parameter]
public HorizontalAlignment TitleHorizontalAlignment { get; set; }

ToolActionParent

Section titled "ToolActionParent" 
[CascadingParameter(Name = "ToolActionParent")]
protected BaseRendererElement ToolActionParent { get; set; }

ToolbarParent

Section titled "ToolbarParent" 
[CascadingParameter(Name = "ToolbarParent")]
protected BaseRendererControl ToolbarParent { get; set; }

Type

Section titled "Type" 
public override string Type { get; }

Visibility

Section titled "Visibility"

Gets or sets the tool action visibility.

 
[Parameter]
public Visibility Visibility { get; set; }

Width

Section titled "Width"

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

 
[Parameter]
public double Width { get; set; }

Accessors

Section titled "Accessors"

_name

Section titled "_name"

Inherited from: BaseRendererElement 

protected string _name

eventCallbacksCache

Section titled "eventCallbacksCache"

Inherited from: BaseRendererElement 

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

_cachedSerializedContent

Section titled "_cachedSerializedContent"

Inherited from: BaseRendererElement 

protected string _cachedSerializedContent

Methods

Section titled "Methods"

EnsureModulesLoaded()

Section titled "EnsureModulesLoaded()"

Inherited from: BaseRendererElement 

protected virtual void EnsureModulesLoaded()

Returns any

BuildRenderTree(RenderTreeBuilder)

Section titled "BuildRenderTree(RenderTreeBuilder)"

Inherited from: BaseRendererElement 

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererElement 

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement 

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement 

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodHelper(string, string, object[], string[], ElementReference[])

Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement 

protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

  • target: string
  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])

Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement 

protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

  • target: string
  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

IsPropDirty(string)

Section titled "IsPropDirty(string)"

Inherited from: BaseRendererElement 

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererElement 

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Serialize()

Section titled "Serialize()"

Inherited from: BaseRendererElement 

public string Serialize()

Returns any

EnsureValid()

Section titled "EnsureValid()"

Inherited from: BaseRendererElement 

protected void EnsureValid()

Returns any

FromEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"

Inherited from: BaseRendererElement 

protected virtual void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

ToEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"

Inherited from: BaseRendererElement 

protected virtual void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererElement 

protected Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

  • grouping: string
  • id: string
  • value: string

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererElement 

protected Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

  • grouping: string
  • json: string

Returns any

CloseSubmenu()

Section titled "CloseSubmenu()" 
public virtual void CloseSubmenu()

Returns any

CloseSubmenuAsync()

Section titled "CloseSubmenuAsync()" 
public virtual Task CloseSubmenuAsync()

Returns any

Dispose()

Section titled "Dispose()" 
public void Dispose()

Returns any

ExportSerializedVisualData()

Section titled "ExportSerializedVisualData()" 
public string ExportSerializedVisualData()

Returns any

ExportSerializedVisualDataAsync()

Section titled "ExportSerializedVisualDataAsync()" 
public Task<string> ExportSerializedVisualDataAsync()

Returns any

ExportVisualData()

Section titled "ExportVisualData()" 
public virtual object ExportVisualData()

Returns any

ExportVisualDataAsync()

Section titled "ExportVisualDataAsync()" 
public virtual Task<object> ExportVisualDataAsync()

Returns any

FindByName(string)

Section titled "FindByName(string)" 
public override object FindByName(string name)

Parameters

  • name: string

Returns any

OnInitializedAsync()

Section titled "OnInitializedAsync()" 
protected override Task OnInitializedAsync()

Returns any

OpenSubMenu()

Section titled "OpenSubMenu()" 
public virtual void OpenSubMenu()

Returns any

OpenSubMenuAsync()

Section titled "OpenSubMenuAsync()" 
public virtual Task OpenSubMenuAsync()

Returns any

Events

Section titled "Events"

OnCommand

Section titled "OnCommand" 
[Parameter]
public EventCallback<IgbToolCommandEventArgs> OnCommand { get; set; }

Performed

Section titled "Performed" 
[Parameter]
public EventCallback<IgbToolActionPerformedEventArgs> Performed { get; set; }

OnCommandScript

Section titled "OnCommandScript" 
[Parameter]
public string OnCommandScript { get; set; }

PerformedScript

Section titled "PerformedScript" 
[Parameter]
public string PerformedScript { get; set; }