Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrToolActionButtonPairProps

Hierarchy

Hierarchy

Properties

Properties

Optional actualBackground

actualBackground?: string

Gets the actual background used by the tool action.

Optional actualDensity

actualDensity?: string | ControlDisplayDensity

Gets the resolved display density to use for the action.

Optional actualDisabledTextColor

actualDisabledTextColor?: string

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

Optional actualHighlightColor

actualHighlightColor?: string

Optional actualHighlightRadius

actualHighlightRadius?: string | number

Optional actualHighlightWidth

actualHighlightWidth?: string | number

Optional actualHoverBackground

actualHoverBackground?: string

Gets the actual hover background used by the tool action.

Optional actualIconFill

actualIconFill?: string

Gets the actual icon fill color.

Optional actualIconHeight

actualIconHeight?: string | number

Gets the actual icon height used.

Optional actualIconStroke

actualIconStroke?: string

Gets the actual icon stroke color.

Optional actualIconWidth

actualIconWidth?: string | number

Gets the actual icon width used.

Optional actualLeftIconFill

actualLeftIconFill?: string

Gets the actual LeftIcon fill color.

Optional actualLeftIconStroke

actualLeftIconStroke?: string

Gets the actual LeftIcon stroke color.

Optional actualPaddingBottom

actualPaddingBottom?: string | number

Optional actualPaddingLeft

actualPaddingLeft?: string | number

Optional actualPaddingRight

actualPaddingRight?: string | number

Optional actualPaddingTop

actualPaddingTop?: string | number

Optional actualRightIconFill

actualRightIconFill?: string

Gets the actual RightIcon fill color.

Optional actualRightIconStroke

actualRightIconStroke?: string

Gets the actual RightIcon stroke color.

Optional actualSubtitleTextColor

actualSubtitleTextColor?: string

Gets the actual label text color.

Optional actualSubtitleTextStyle

actualSubtitleTextStyle?: FontInfo

Gets the actual font used.

Optional actualTextColor

actualTextColor?: string

Gets the actual label text color.

Optional actualTextStyle

actualTextStyle?: FontInfo

Gets the actual font used.

Optional afterId

afterId?: string

Gets or sets the Id of the action that this action will be inserted after. 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.

Optional background

background?: string

Gets or sets the background color of the tool action.

Optional beforeId

beforeId?: string

Gets or sets the Id of the action that this action will be inserted before. 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.

Optional children

children?: ReactNode

Optional closeOnExecute

closeOnExecute?: string | boolean

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

Optional commandArgument

commandArgument?: string

Optional commandArgumentValue

commandArgumentValue?: any

Optional commandId

commandId?: string

Optional contextBindings

contextBindings?: string | IgrToolContextBindingCollection

Gets the context bindings for this tool action.

Optional cornerRadius

cornerRadius?: string | number

Gets or sets the button corner radius.

Optional density

density?: string | ControlDisplayDensity

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

Optional disabledTextColor

disabledTextColor?: string

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

Optional displayType

displayType?: string | ToolActionButtonGroupDisplayType

Gets or sets the display type for the button.

Optional height

height?: string | number

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

Optional highlightColor

highlightColor?: string

Optional highlightRadius

highlightRadius?: string | number

Optional highlightWidth

highlightWidth?: string | number

Optional hoverBackground

hoverBackground?: string

Gets or sets the hover background for this tool action.

Optional iconCollectionName

iconCollectionName?: string

Optional iconFill

iconFill?: string

Gets or sets the icon fill color.

Optional iconFillColors

iconFillColors?: string | string[]

Gets or sets the icon fill colors.

Optional iconHeight

iconHeight?: string | number

Gets or sets the height of the icon.

Optional iconName

iconName?: string

Optional iconStroke

iconStroke?: string

Gets or sets the icon stroke color.

Optional iconStrokeColors

iconStrokeColors?: string | string[]

Gets or sets the icon stroke colors.

Optional iconStrokeWidth

iconStrokeWidth?: string | number

Gets or sets the icon viewbox width.

Optional iconViewBoxHeight

iconViewBoxHeight?: string | number

Gets or sets the icon viewbox height.

Optional iconViewBoxLeft

iconViewBoxLeft?: string | number

Gets or sets the icon viewbox left.

Optional iconViewBoxTop

iconViewBoxTop?: string | number

Gets or sets the icon viewbox top.

Optional iconViewBoxWidth

iconViewBoxWidth?: string | number

Gets or sets the icon viewbox width.

Optional iconWidth

iconWidth?: string | number

Gets or sets the width of the icon.

Optional isDisabled

isDisabled?: string | boolean

Optional isHighlighted

isHighlighted?: string | boolean

Optional isToggleDisabled

isToggleDisabled?: string | boolean

Optional leftCommandArgument

leftCommandArgument?: string

Optional leftIconCollectionName

leftIconCollectionName?: string

Optional leftIconFill

leftIconFill?: string

Gets or sets the LeftIcon fill color.

Optional leftIconFillColors

leftIconFillColors?: string | string[]

Gets or sets the LeftIcon fill colors.

Optional leftIconName

leftIconName?: string

Optional leftIconStroke

leftIconStroke?: string

Gets or sets the LeftIcon stroke color.

Optional leftIconStrokeColors

leftIconStrokeColors?: string | string[]

Gets or sets the LeftIcon stroke colors.

Optional leftIconStrokeWidth

leftIconStrokeWidth?: string | number

Gets or sets the LeftIcon viewbox width.

Optional leftIconViewBoxHeight

leftIconViewBoxHeight?: string | number

Gets or sets the LeftIcon viewbox height.

Optional leftIconViewBoxLeft

leftIconViewBoxLeft?: string | number

Gets or sets the LeftIcon viewbox left.

Optional leftIconViewBoxTop

leftIconViewBoxTop?: string | number

Gets or sets the LeftIcon viewbox top.

Optional leftIconViewBoxWidth

leftIconViewBoxWidth?: string | number

Gets or sets the LeftIcon viewbox width.

Optional leftIsDisabled

leftIsDisabled?: string | boolean

Optional leftIsSelected

leftIsSelected?: string | boolean

Optional leftTitle

leftTitle?: string

Gets or sets the title of the left button.

Optional name

name?: string

Optional onCommand

onCommand?: ((s, e) => void)

Type declaration

Optional overlayId

overlayId?: string

Sets to the Id of the action that this action will overlay itself on to. 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.

Optional paddingBottom

paddingBottom?: string | number

Optional paddingLeft

paddingLeft?: string | number

Optional paddingRight

paddingRight?: string | number

Optional paddingTop

paddingTop?: string | number

Optional parentId

parentId?: string

Optional performed

performed?: ((s, e) => void)

Type declaration

Optional rightCommandArgument

rightCommandArgument?: string

Optional rightIconCollectionName

rightIconCollectionName?: string

Optional rightIconFill

rightIconFill?: string

Gets or sets the RightIcon fill color.

Optional rightIconFillColors

rightIconFillColors?: string | string[]

Gets or sets the RightIcon fill colors.

Optional rightIconName

rightIconName?: string

Optional rightIconStroke

rightIconStroke?: string

Gets or sets the RightIcon stroke color.

Optional rightIconStrokeColors

rightIconStrokeColors?: string | string[]

Gets or sets the RightIcon stroke colors.

Optional rightIconStrokeWidth

rightIconStrokeWidth?: string | number

Gets or sets the RightIcon viewbox width.

Optional rightIconViewBoxHeight

rightIconViewBoxHeight?: string | number

Gets or sets the RightIcon viewbox height.

Optional rightIconViewBoxLeft

rightIconViewBoxLeft?: string | number

Gets or sets the RightIcon viewbox left.

Optional rightIconViewBoxTop

rightIconViewBoxTop?: string | number

Gets or sets the RightIcon viewbox top.

Optional rightIconViewBoxWidth

rightIconViewBoxWidth?: string | number

Gets or sets the RightIcon viewbox width.

Optional rightIsDisabled

rightIsDisabled?: string | boolean

Optional rightIsSelected

rightIsSelected?: string | boolean

Optional rightTitle

rightTitle?: string

Gets or sets the title of the Right button.

Optional subPanelRowHeight

subPanelRowHeight?: string | number

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

Optional subtitle

subtitle?: string

Gets or sets the subtitle of the tool.

Optional subtitleTextColor

subtitleTextColor?: string

Gets or sets the label text color.

Optional subtitleTextStyle

subtitleTextStyle?: string

Gets or sets the font to use.

Optional textColor

textColor?: string

Gets or sets the label text color.

Optional textStyle

textStyle?: string

Gets or sets the font to use.

Optional title

title?: string

Gets or sets the title of the tool.

Optional titleHorizontalAlignment

titleHorizontalAlignment?: string | HorizontalAlignment

Gets or sets the title horizontal alignment.

Optional visibility

visibility?: string | Visibility

Gets or sets the tool action visibility.

Optional width

width?: string | number

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