Inheritance

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

constructor

public IgbToolPanel()

Returns IgbToolPanel

Inherited from: BaseRendererControl

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

Inherited from: BaseRendererControl

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

Inherited from: BaseRendererControl

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

Inherited from: BaseRendererControl

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

Inherited from: BaseRendererControl

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }

Inherited from: BaseRendererControl

protected virtual string ParentTypeName { get; }

Inherited from: BaseRendererControl

Gets or sets how events are bubbled up from JavaScript to Blazor.

[Parameter]
public ControlEventBehavior EventBehavior { get; set; }

Inherited from: BaseRendererControl

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

Inherited from: BaseRendererControl

Gets or sets what type of date conversion to make when round tripping dates.

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

Inherited from: BaseRendererControl

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererControl

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererControl

protected virtual string DirectRenderElementName { get; }

Inherited from: BaseRendererControl

protected virtual bool NeedsDynamicContent { get; }

Inherited from: BaseRendererControl

protected virtual bool UseCamelEnumValues { get; }
[Parameter]
public string AccentColor { get; set; }

Gets or sets the data or data source instance to which to bind the grid.

public IgbToolActionCollection Actions { get; set; }
[Parameter]
public string ActualAccentColor { get; set; }
[Parameter]
public string ActualBackgroundColor { get; set; }

Gets the actual background color of the radio when in the checked state.

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

Gets the actual border color of the radio when in the checked state.

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

Gets the resolved display density to use for the toolbar.

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

Gets the actual dropdown delay.

[Parameter]
public int ActualDropdownDelay { get; set; }
[Parameter]
public string ActualGroupHeaderBackgroundColor { get; set; }

ActualGroupHeaderSeparatorBackgroundColor

Section titled "ActualGroupHeaderSeparatorBackgroundColor"
[Parameter]
public string ActualGroupHeaderSeparatorBackgroundColor { get; set; }
[Parameter]
public string ActualGroupHeaderSubtitleTextColor { get; set; }
[Parameter]
public string ActualGroupHeaderTextColor { get; set; }
[Parameter]
public string ActualHighlightColor { get; set; }
[Parameter]
public double ActualHighlightRadius { get; set; }
[Parameter]
public double ActualHighlightWidth { get; set; }
[Parameter]
public string ActualHoverBackgroundColor { get; set; }

Gets the actual icon fill color.

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

Gets the actual icon stroke color.

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

Gets the actual stroke color for all icon menu dropdown arrows.

[Parameter]
public string ActualMenuArrowStroke { get; set; }
[Parameter]
public string ActualSeparatorBackgroundColor { get; set; }

ActualSeparatorHorizontalPaddingBottom

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

ActualSeparatorHorizontalPaddingLeft

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

ActualSeparatorHorizontalPaddingRight

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

ActualSeparatorHorizontalPaddingTop

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

ActualSeparatorVerticalPaddingBottom

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

ActualSeparatorVerticalPaddingRight

Section titled "ActualSeparatorVerticalPaddingRight"
[Parameter]
public double ActualSeparatorVerticalPaddingRight { get; set; }
[Parameter]
public double ActualSeparatorVerticalPaddingTop { get; set; }
[Parameter]
public string ActualSubmenuBackgroundColor { get; set; }
[Parameter]
public string ActualSubtitleTextColor { get; set; }
[Parameter]
public string ActualTextColor { get; set; }

Gets the actual tooltip background color.

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

Gets the actual tooltip corner radius.

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

Gets the actual shadow elevation used by the tooltip.

[Parameter]
public double ActualToolTipElevation { get; set; }
[Parameter]
public string ActualToolTipTextColor { get; set; }

Gets the actual background color of the radio when in the unchecked state.

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

Gets the actual border color of the radio when in the unchecked state.

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

Gets or sets the color to use for the background of the component.

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

Gets or sets the base built in theme to use for the checkbox.

[Parameter]
public BaseControlTheme BaseTheme { get; set; }
[Parameter]
public string CellFontFamily { get; set; }
[Parameter]
public double CellFontSize { get; set; }
[Parameter]
public string CellFontStyle { get; set; }
[Parameter]
public string CellFontWeight { get; set; }

CheckboxListScrollbarActiveBackground

Section titled "CheckboxListScrollbarActiveBackground"

Gets or sets the scrollbar thumb active (dragging) background color for checkbox lists hosted in this tool panel's actions.

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

Gets or sets the scrollbar background color for checkbox lists hosted in this tool panel's actions.

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

CheckboxListScrollbarHoverBackground

Section titled "CheckboxListScrollbarHoverBackground"

Gets or sets the scrollbar thumb hover background color for checkbox lists hosted in this tool panel's actions.

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

Gets or sets the background color of the radio when in the checked state.

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

Gets or sets the border color of the radio when in the checked state.

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

Gets the components default event behavior.

protected override ControlEventBehavior DefaultEventBehavior { get; }

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

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

Gets or sets the color to use for the text in disabled tool actions.

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

Gets or sets the amount of time to wait when clicking on the icon menu button while the dropdown is opening. If a click was executed within this buffer window the dropdown will be left open. Otherwise it will close it. Setting a negative value will always keep the dropdown open during a hover open and will require an extra click to close.

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

Gets or sets the dropdown delay time in milliseconds.

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

Gets or sets the group header background color.

[Parameter]
public string GroupHeaderBackgroundColor { get; set; }
[Parameter]
public string GroupHeaderFontFamily { get; set; }
[Parameter]
public double GroupHeaderFontSize { get; set; }
[Parameter]
public string GroupHeaderFontStyle { get; set; }
[Parameter]
public string GroupHeaderFontWeight { get; set; }

GroupHeaderSeparatorBackgroundColor

Section titled "GroupHeaderSeparatorBackgroundColor"

Gets or sets the group header separator background color.

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

Gets or sets the text color for group header subtitle.

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

Gets or sets the text color for group header tool actions.

[Parameter]
public string GroupHeaderTextColor { get; set; }
[Parameter]
public string HighlightColor { get; set; }
[Parameter]
public double HighlightRadius { get; set; }
[Parameter]
public double HighlightWidth { get; set; }

Gets or sets the hover background color.

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

Gets or sets the fill color of icons in the ToolPanel.

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

Gets or sets the stroke color of icons in the ToolPanel.

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

Gets or sets the spacing between items

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

Gets or sets the stroke color for all icon menu dropdown arrows.

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

Gets or sets the mode used when displaying nested actions.

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

Gets or sets the color to use for the background of the component.

[Parameter]
public ToolPanelOrientation Orientation { get; set; }

Gets or sets the row height for the panel.

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

Gets or sets the style of scrollbar.

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

Gets or sets the separator background color.

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

Gets or sets the bottom padding for separators in the horizontal orientation.

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

Gets or sets the left padding for separators in the horizontal orientation.

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

Gets or sets the right padding for separators in the horizontal orientation.

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

Gets or sets the top padding for separators in the horizontal orientation.

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

Gets or sets the bottom padding for separators in the vertical orientation.

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

Gets or sets the left padding for separators in the vertical orientation.

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

Gets or sets the right padding for separators in the vertical orientation.

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

Gets or sets the top padding for separators in the vertical orientation.

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

Gets or sets if the tool actions should display their submenus on mouse hover.

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

Gets or sets if the tool action icon buttons should display their tooltips on mouse hover.

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

Prevents clicks on the tool actions from bubbling.

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

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

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

Gets or sets the background color for submenus.

[Parameter]
public string SubmenuBackgroundColor { get; set; }
[Parameter]
public string SubtitleFontFamily { get; set; }
[Parameter]
public double SubtitleFontSize { get; set; }
[Parameter]
public string SubtitleFontStyle { get; set; }
[Parameter]
public string SubtitleFontWeight { get; set; }

Gets or sets the color to use for the subtitle of the component.

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

Gets or sets the color to use for the text of the component.

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

Gets or sets the tooltip background color.

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

Gets or sets the tooltip corner radius.

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

Gets or sets the shadow elevation for the tooltip.

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

Gets or sets the tooltip text color.

[Parameter]
public string ToolTipTextColor { get; set; }
public override string Type { get; }

Gets or sets the background color of the radio when in the unchecked state.

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

Gets or sets the border color of the radio when in the unchecked state.

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

Inherited from: BaseRendererControl

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

Inherited from: BaseRendererControl

protected string _cachedSerializedContent

Inherited from: BaseRendererControl

Resolves the components event behavior if Auto is selected.

protected ControlEventBehavior ResolveEventBehavior()

Returns any

Inherited from: BaseRendererControl

protected virtual string ResolveDisplay()

Returns any

Inherited from: BaseRendererControl

protected string ToSpinal(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected virtual string TransformSimpleKey(string key)

Parameters

  • key: string

Returns any

Inherited from: BaseRendererControl

protected virtual bool IsTransformedEnumValue(string key)

Parameters

  • key: string

Returns any

TransformPotentialEnumValue(string, object)

Section titled "TransformPotentialEnumValue(string, object)"

Inherited from: BaseRendererControl

protected virtual object TransformPotentialEnumValue(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

Inherited from: BaseRendererControl

protected virtual SequenceInfo BuildSequenceInfo(int startSequence)

Parameters

  • startSequence: int

Returns any

Inherited from: BaseRendererControl

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

Inherited from: BaseRendererControl

protected Type TemplateContentType(string templateId)

Parameters

  • templateId: string

Returns any

Inherited from: BaseRendererControl

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

  • firstRender: bool

Returns any

Inherited from: BaseRendererControl

public Task EnsureReady()

Returns any

Inherited from: BaseRendererControl

protected void MarkPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Inherited from: BaseRendererControl

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererControl

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

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Inherited from: BaseRendererControl

public string Serialize()

Returns any

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

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

Inherited from: BaseRendererControl

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: BaseRendererControl

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

Parameters

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

Returns any

Inherited from: BaseRendererControl

Prevents data change notifications from be propagated to the component.

public void SuspendNotifications(object dataSource)

Parameters

  • dataSource: object

Returns any

Inherited from: BaseRendererControl

Resumes data change notifications.

public void ResumeNotifications(object dataSource, bool notify = true)

Parameters

  • dataSource: object
  • notify: bool

Returns any

NotifyInsertItem(object, int, object)

Section titled "NotifyInsertItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyInsertItem(object dataSource, int index, object refItem)

Parameters

  • dataSource: object
  • index: int
  • refItem: object

Returns any

NotifyRemoveItem(object, int, object)

Section titled "NotifyRemoveItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyRemoveItem(object dataSource, int index, object oldItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object

Returns any

Inherited from: BaseRendererControl

public void NotifyClearItems(object dataSource)

Parameters

  • dataSource: object

Returns any

NotifySetItem(object, int, object, object)

Section titled "NotifySetItem(object, int, object, object)"

Inherited from: BaseRendererControl

public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object
  • newItem: object

Returns any

NotifyUpdateItem(object, int, object, bool)

Section titled "NotifyUpdateItem(object, int, object, bool)"

Inherited from: BaseRendererControl

public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)

Parameters

  • dataSource: object
  • index: int
  • refItem: object
  • syncDataOnly: bool

Returns any

Inherited from: BaseRendererControl

public void OnRefChanged(string refName, object refValue)

Parameters

  • refName: string
  • refValue: object

Returns any

Inherited from: BaseRendererControl

public void OnInvokeReturn(long invokeId, object returnValue)

Parameters

  • invokeId: long
  • returnValue: object

Returns any

Inherited from: BaseRendererControl

protected string Camelize(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected string ToPascal(string value)

Parameters

  • value: string

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

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

Inherited from: BaseRendererControl

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

Parameters

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

Returns any

Inherited from: BaseRendererControl

protected virtual void Dispose(bool disposing)

Parameters

  • disposing: bool

Returns any

SetResourceStringAsync(string, string, string)

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

Inherited from: BaseRendererControl

public 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: BaseRendererControl

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

Parameters

  • grouping: string
  • json: string

Returns any

SetPropertyValue(object, PropertyInfo, JsonElement)

Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)

Parameters

  • item: object
  • property: PropertyInfo
  • jsonElement: JsonElement

Returns any

SetPropertyValue(object, PropertyInfo, object)

Section titled "SetPropertyValue(object, PropertyInfo, object)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, object value)

Parameters

  • item: object
  • property: PropertyInfo
  • value: object

Returns any

Inherited from: BaseRendererControl

public void Dispose()

Returns any

public void CloseSubmenus()

Returns any

Forces any open sub menus to close.

public Task CloseSubmenusAsync()

Returns any

protected override void EnsureModulesLoaded()

Returns any

public string ExportSerializedVisualData()

Returns any

public Task<string> ExportSerializedVisualDataAsync()

Returns any

public object ExportVisualData()

Returns any

public Task<object> ExportVisualDataAsync()

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

public void FlushRefresh()

Returns any

public Task FlushRefreshAsync()

Returns any

public bool GetBoolContextItem(string key)

Parameters

  • key: string

Returns any

public Task<bool> GetBoolContextItemAsync(string key)

Parameters

  • key: string

Returns any

public string GetBrushContextItem(string key)

Parameters

  • key: string

Returns any

public Task<string> GetBrushContextItemAsync(string key)

Parameters

  • key: string

Returns any

public string GetColorContextItem(string key)

Parameters

  • key: string

Returns any

public Task<string> GetColorContextItemAsync(string key)

Parameters

  • key: string

Returns any

public object GetDataContextItem(string key)

Parameters

  • key: string

Returns any

public Task<object> GetDataContextItemAsync(string key)

Parameters

  • key: string

Returns any

public double GetDoubleContextItem(string key)

Parameters

  • key: string

Returns any

public Task<double> GetDoubleContextItemAsync(string key)

Parameters

  • key: string

Returns any

public int GetIntContextItem(string key)

Parameters

  • key: string

Returns any

public Task<int> GetIntContextItemAsync(string key)

Parameters

  • key: string

Returns any

public string GetStringContextItem(string key)

Parameters

  • key: string

Returns any

public Task<string> GetStringContextItemAsync(string key)

Parameters

  • key: string

Returns any

public void Refresh()

Returns any

public Task RefreshAsync()

Returns any

public void SetBoolContextItem(string key, bool value)

Parameters

  • key: string
  • value: bool

Returns any

SetBoolContextItemAsync(string, bool)

Section titled "SetBoolContextItemAsync(string, bool)"
public Task SetBoolContextItemAsync(string key, bool value)

Parameters

  • key: string
  • value: bool

Returns any

SetBrushContextItem(string, string)

Section titled "SetBrushContextItem(string, string)"
public void SetBrushContextItem(string key, string value)

Parameters

  • key: string
  • value: string

Returns any

SetBrushContextItemAsync(string, string)

Section titled "SetBrushContextItemAsync(string, string)"
public Task SetBrushContextItemAsync(string key, string value)

Parameters

  • key: string
  • value: string

Returns any

SetColorContextItem(string, string)

Section titled "SetColorContextItem(string, string)"
public void SetColorContextItem(string key, string value)

Parameters

  • key: string
  • value: string

Returns any

SetColorContextItemAsync(string, string)

Section titled "SetColorContextItemAsync(string, string)"
public Task SetColorContextItemAsync(string key, string value)

Parameters

  • key: string
  • value: string

Returns any

public void SetDataContextItem(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

SetDataContextItemAsync(string, object)

Section titled "SetDataContextItemAsync(string, object)"
public Task SetDataContextItemAsync(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

SetDoubleContextItem(string, double)

Section titled "SetDoubleContextItem(string, double)"
public void SetDoubleContextItem(string key, double value)

Parameters

  • key: string
  • value: double

Returns any

SetDoubleContextItemAsync(string, double)

Section titled "SetDoubleContextItemAsync(string, double)"
public Task SetDoubleContextItemAsync(string key, double value)

Parameters

  • key: string
  • value: double

Returns any

public void SetIntContextItem(string key, int value)

Parameters

  • key: string
  • value: int

Returns any

SetIntContextItemAsync(string, int)

Section titled "SetIntContextItemAsync(string, int)"
public Task SetIntContextItemAsync(string key, int value)

Parameters

  • key: string
  • value: int

Returns any

SetStringContextItem(string, string)

Section titled "SetStringContextItem(string, string)"
public void SetStringContextItem(string key, string value)

Parameters

  • key: string
  • value: string

Returns any

SetStringContextItemAsync(string, string)

Section titled "SetStringContextItemAsync(string, string)"
public Task SetStringContextItemAsync(string key, string value)

Parameters

  • key: string
  • value: string

Returns any

[Parameter]
public EventCallback<IgbToolPanelContentRefreshedEventArgs> ContentRefreshed { get; set; }
[Parameter]
public EventCallback<IgbToolCommandEventArgs> OnCommand { get; set; }
[Parameter]
public string ContentRefreshedScript { get; set; }
[Parameter]
public string OnCommandScript { get; set; }