Class IgxToolActionButtonPairComponent

Represents base class for all tool actions in toolbar

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

contentActions: QueryList<IgxToolActionComponent>
ngAcceptInputType_actions: string | IgxToolActionCollection
ngAcceptInputType_actualDensity: string | ControlDisplayDensity
ngAcceptInputType_actualHighlightRadius: string | number
ngAcceptInputType_actualHighlightWidth: string | number
ngAcceptInputType_actualIconHeight: string | number
ngAcceptInputType_actualIconWidth: string | number
ngAcceptInputType_actualPaddingBottom: string | number
ngAcceptInputType_actualPaddingLeft: string | number
ngAcceptInputType_actualPaddingRight: string | number
ngAcceptInputType_actualPaddingTop: string | number
ngAcceptInputType_closeOnExecute: string | boolean
ngAcceptInputType_contextBindings: string | IgxToolContextBindingCollection
ngAcceptInputType_cornerRadius: string | number
ngAcceptInputType_density: string | ControlDisplayDensity
ngAcceptInputType_displayType: string | ToolActionButtonGroupDisplayType
ngAcceptInputType_height: string | number
ngAcceptInputType_highlightRadius: string | number
ngAcceptInputType_highlightWidth: string | number
ngAcceptInputType_iconFillColors: string | string[]
ngAcceptInputType_iconHeight: string | number
ngAcceptInputType_iconStrokeColors: string | string[]
ngAcceptInputType_iconStrokeWidth: string | number
ngAcceptInputType_iconViewBoxHeight: string | number
ngAcceptInputType_iconViewBoxLeft: string | number
ngAcceptInputType_iconViewBoxTop: string | number
ngAcceptInputType_iconViewBoxWidth: string | number
ngAcceptInputType_iconWidth: string | number
ngAcceptInputType_isDisabled: string | boolean
ngAcceptInputType_isHighlighted: string | boolean
ngAcceptInputType_isOpen: string | boolean
ngAcceptInputType_isToggleDisabled: string | boolean
ngAcceptInputType_leftIconFillColors: string | string[]
ngAcceptInputType_leftIconStrokeColors: string | string[]
ngAcceptInputType_leftIconStrokeWidth: string | number
ngAcceptInputType_leftIconViewBoxHeight: string | number
ngAcceptInputType_leftIconViewBoxLeft: string | number
ngAcceptInputType_leftIconViewBoxTop: string | number
ngAcceptInputType_leftIconViewBoxWidth: string | number
ngAcceptInputType_leftIsDisabled: string | boolean
ngAcceptInputType_leftIsSelected: string | boolean
ngAcceptInputType_paddingBottom: string | number
ngAcceptInputType_paddingLeft: string | number
ngAcceptInputType_paddingRight: string | number
ngAcceptInputType_paddingTop: string | number
ngAcceptInputType_rightIconFillColors: string | string[]
ngAcceptInputType_rightIconStrokeColors: string | string[]
ngAcceptInputType_rightIconStrokeWidth: string | number
ngAcceptInputType_rightIconViewBoxHeight: string | number
ngAcceptInputType_rightIconViewBoxLeft: string | number
ngAcceptInputType_rightIconViewBoxTop: string | number
ngAcceptInputType_rightIconViewBoxWidth: string | number
ngAcceptInputType_rightIsDisabled: string | boolean
ngAcceptInputType_rightIsSelected: string | boolean
ngAcceptInputType_subPanelRowHeight: string | number
ngAcceptInputType_titleHorizontalAlignment: string | HorizontalAlignment
ngAcceptInputType_visibility: string | Visibility
ngAcceptInputType_width: string | number
ɵcmp: unknown
ɵfac: unknown

Accessors

  • get actionId(): string
  • Returns string

  • get actions(): IgxToolActionCollection
  • Gets the sub actions associated with this tool action.

    Returns IgxToolActionCollection

  • get actualBackground(): string
  • Gets the actual background used by the tool action.

    Returns string

  • set actualBackground(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualDensity(): ControlDisplayDensity
  • Gets the resolved display density to use for the action.

    Returns ControlDisplayDensity

  • set actualDensity(v: ControlDisplayDensity): void
  • Parameters

    Returns void

  • get actualDisabledTextColor(): string
  • Gets the actual label text color when the tool is disabled.

    Returns string

  • set actualDisabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualHighlightColor(): string
  • Returns string

  • set actualHighlightColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualHighlightRadius(): number
  • Returns number

  • set actualHighlightRadius(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualHighlightWidth(): number
  • Returns number

  • set actualHighlightWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualHoverBackground(): string
  • Gets the actual hover background used by the tool action.

    Returns string

  • set actualHoverBackground(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualIconFill(): string
  • Gets the actual icon fill color.

    Returns string

  • set actualIconFill(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualIconHeight(): number
  • Gets the actual icon height used.

    Returns number

  • set actualIconHeight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualIconStroke(): string
  • Gets the actual icon stroke color.

    Returns string

  • set actualIconStroke(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualIconWidth(): number
  • Gets the actual icon width used.

    Returns number

  • set actualIconWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualLeftIconFill(): string
  • Gets the actual LeftIcon fill color.

    Returns string

  • set actualLeftIconFill(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualLeftIconStroke(): string
  • Gets the actual LeftIcon stroke color.

    Returns string

  • set actualLeftIconStroke(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualPaddingBottom(): number
  • Returns number

  • set actualPaddingBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualPaddingLeft(): number
  • Returns number

  • set actualPaddingLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualPaddingRight(): number
  • Returns number

  • set actualPaddingRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualPaddingTop(): number
  • Returns number

  • set actualPaddingTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get actualRightIconFill(): string
  • Gets the actual RightIcon fill color.

    Returns string

  • set actualRightIconFill(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualRightIconStroke(): string
  • Gets the actual RightIcon stroke color.

    Returns string

  • set actualRightIconStroke(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualSubtitleTextColor(): string
  • Gets the actual label text color.

    Returns string

  • set actualSubtitleTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualSubtitleTextStyle(): FontInfo
  • Gets the actual font used.

    Returns FontInfo

  • set actualSubtitleTextStyle(v: FontInfo): void
  • Parameters

    • v: FontInfo

    Returns void

  • get actualTextColor(): string
  • Gets the actual label text color.

    Returns string

  • set actualTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get actualTextStyle(): FontInfo
  • Gets the actual font used.

    Returns FontInfo

  • set actualTextStyle(v: FontInfo): void
  • Parameters

    • v: FontInfo

    Returns void

  • get 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.

    Returns string

  • set afterId(v: string): void
  • Parameters

    • v: string

    Returns void

  • get background(): string
  • Gets or sets the background color of the tool action.

    Returns string

  • set background(v: string): void
  • Parameters

    • v: string

    Returns void

  • get 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.

    Returns string

  • set beforeId(v: string): void
  • Parameters

    • v: string

    Returns void

  • get closeOnExecute(): boolean
  • Gets or sets if the tool action will close its parent dropdown when executed by the user.

    Returns boolean

  • set closeOnExecute(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get commandArgument(): string
  • Returns string

  • set commandArgument(v: string): void
  • Parameters

    • v: string

    Returns void

  • get commandArgumentValue(): any
  • Returns any

  • set commandArgumentValue(v: any): void
  • Parameters

    • v: any

    Returns void

  • get commandId(): string
  • Returns string

  • set commandId(v: string): void
  • Parameters

    • v: string

    Returns void

  • get cornerRadius(): number
  • Gets or sets the button corner radius.

    Returns number

  • set cornerRadius(v: number): void
  • Parameters

    • v: number

    Returns void

  • get density(): ControlDisplayDensity
  • Gets or sets the display density to use for the action.

    Returns ControlDisplayDensity

  • set density(v: ControlDisplayDensity): void
  • Parameters

    Returns void

  • get disabledTextColor(): string
  • Gets or sets the label text color when the tool is disabled.

    Returns string

  • set disabledTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get height(): number
  • Gets or sets the height to use for this tool action.

    Returns number

  • set height(v: number): void
  • Parameters

    • v: number

    Returns void

  • get highlightColor(): string
  • Returns string

  • set highlightColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get highlightRadius(): number
  • Returns number

  • set highlightRadius(v: number): void
  • Parameters

    • v: number

    Returns void

  • get highlightWidth(): number
  • Returns number

  • set highlightWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get hoverBackground(): string
  • Gets or sets the hover background for this tool action.

    Returns string

  • set hoverBackground(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconCollectionName(): string
  • Returns string

  • set iconCollectionName(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconFill(): string
  • Gets or sets the icon fill color.

    Returns string

  • set iconFill(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconFillColors(): string[]
  • Gets or sets the icon fill colors.

    Returns string[]

  • set iconFillColors(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get iconHeight(): number
  • Gets or sets the height of the icon.

    Returns number

  • set iconHeight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconName(): string
  • Returns string

  • set iconName(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconStroke(): string
  • Gets or sets the icon stroke color.

    Returns string

  • set iconStroke(v: string): void
  • Parameters

    • v: string

    Returns void

  • get iconStrokeColors(): string[]
  • Gets or sets the icon stroke colors.

    Returns string[]

  • set iconStrokeColors(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get iconStrokeWidth(): number
  • Gets or sets the icon viewbox width.

    Returns number

  • set iconStrokeWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconViewBoxHeight(): number
  • Gets or sets the icon viewbox height.

    Returns number

  • set iconViewBoxHeight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconViewBoxLeft(): number
  • Gets or sets the icon viewbox left.

    Returns number

  • set iconViewBoxLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconViewBoxTop(): number
  • Gets or sets the icon viewbox top.

    Returns number

  • set iconViewBoxTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconViewBoxWidth(): number
  • Gets or sets the icon viewbox width.

    Returns number

  • set iconViewBoxWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get iconWidth(): number
  • Gets or sets the width of the icon.

    Returns number

  • set iconWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get isDisabled(): boolean
  • Returns boolean

  • set isDisabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isHighlighted(): boolean
  • Returns boolean

  • set isHighlighted(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isOpen(): boolean
  • Returns boolean

  • get isToggleDisabled(): boolean
  • Returns boolean

  • set isToggleDisabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get leftCommandArgument(): string
  • Returns string

  • set leftCommandArgument(v: string): void
  • Parameters

    • v: string

    Returns void

  • get leftIconCollectionName(): string
  • Returns string

  • set leftIconCollectionName(v: string): void
  • Parameters

    • v: string

    Returns void

  • get leftIconFill(): string
  • Gets or sets the LeftIcon fill color.

    Returns string

  • set leftIconFill(v: string): void
  • Parameters

    • v: string

    Returns void

  • get leftIconFillColors(): string[]
  • Gets or sets the LeftIcon fill colors.

    Returns string[]

  • set leftIconFillColors(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get leftIconName(): string
  • Returns string

  • set leftIconName(v: string): void
  • Parameters

    • v: string

    Returns void

  • get leftIconStroke(): string
  • Gets or sets the LeftIcon stroke color.

    Returns string

  • set leftIconStroke(v: string): void
  • Parameters

    • v: string

    Returns void

  • get leftIconStrokeColors(): string[]
  • Gets or sets the LeftIcon stroke colors.

    Returns string[]

  • set leftIconStrokeColors(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get leftIconStrokeWidth(): number
  • Gets or sets the LeftIcon viewbox width.

    Returns number

  • set leftIconStrokeWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get leftIconViewBoxHeight(): number
  • Gets or sets the LeftIcon viewbox height.

    Returns number

  • set leftIconViewBoxHeight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get leftIconViewBoxLeft(): number
  • Gets or sets the LeftIcon viewbox left.

    Returns number

  • set leftIconViewBoxLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get leftIconViewBoxTop(): number
  • Gets or sets the LeftIcon viewbox top.

    Returns number

  • set leftIconViewBoxTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get leftIconViewBoxWidth(): number
  • Gets or sets the LeftIcon viewbox width.

    Returns number

  • set leftIconViewBoxWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get leftIsDisabled(): boolean
  • Returns boolean

  • set leftIsDisabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get leftIsSelected(): boolean
  • Returns boolean

  • set leftIsSelected(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get leftTitle(): string
  • Gets or sets the title of the left button.

    Returns string

  • set leftTitle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get name(): string
  • Returns string

  • set name(v: string): void
  • Parameters

    • v: string

    Returns void

  • get onCommand(): EventEmitter<{
        args: IgxToolCommandEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxToolCommandEventArgs;
        sender: any;
    }>

  • get 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.

    Returns string

  • set overlayId(v: string): void
  • Parameters

    • v: string

    Returns void

  • get paddingBottom(): number
  • Returns number

  • set paddingBottom(v: number): void
  • Parameters

    • v: number

    Returns void

  • get paddingLeft(): number
  • Returns number

  • set paddingLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get paddingRight(): number
  • Returns number

  • set paddingRight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get paddingTop(): number
  • Returns number

  • set paddingTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get parentId(): string
  • Returns string

  • set parentId(v: string): void
  • Parameters

    • v: string

    Returns void

  • get performed(): EventEmitter<{
        args: IgxToolActionPerformedEventArgs;
        sender: any;
    }>
  • Returns EventEmitter<{
        args: IgxToolActionPerformedEventArgs;
        sender: any;
    }>

  • get rightCommandArgument(): string
  • Returns string

  • set rightCommandArgument(v: string): void
  • Parameters

    • v: string

    Returns void

  • get rightIconCollectionName(): string
  • Returns string

  • set rightIconCollectionName(v: string): void
  • Parameters

    • v: string

    Returns void

  • get rightIconFill(): string
  • Gets or sets the RightIcon fill color.

    Returns string

  • set rightIconFill(v: string): void
  • Parameters

    • v: string

    Returns void

  • get rightIconFillColors(): string[]
  • Gets or sets the RightIcon fill colors.

    Returns string[]

  • set rightIconFillColors(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get rightIconName(): string
  • Returns string

  • set rightIconName(v: string): void
  • Parameters

    • v: string

    Returns void

  • get rightIconStroke(): string
  • Gets or sets the RightIcon stroke color.

    Returns string

  • set rightIconStroke(v: string): void
  • Parameters

    • v: string

    Returns void

  • get rightIconStrokeColors(): string[]
  • Gets or sets the RightIcon stroke colors.

    Returns string[]

  • set rightIconStrokeColors(v: string[]): void
  • Parameters

    • v: string[]

    Returns void

  • get rightIconStrokeWidth(): number
  • Gets or sets the RightIcon viewbox width.

    Returns number

  • set rightIconStrokeWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get rightIconViewBoxHeight(): number
  • Gets or sets the RightIcon viewbox height.

    Returns number

  • set rightIconViewBoxHeight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get rightIconViewBoxLeft(): number
  • Gets or sets the RightIcon viewbox left.

    Returns number

  • set rightIconViewBoxLeft(v: number): void
  • Parameters

    • v: number

    Returns void

  • get rightIconViewBoxTop(): number
  • Gets or sets the RightIcon viewbox top.

    Returns number

  • set rightIconViewBoxTop(v: number): void
  • Parameters

    • v: number

    Returns void

  • get rightIconViewBoxWidth(): number
  • Gets or sets the RightIcon viewbox width.

    Returns number

  • set rightIconViewBoxWidth(v: number): void
  • Parameters

    • v: number

    Returns void

  • get rightIsDisabled(): boolean
  • Returns boolean

  • set rightIsDisabled(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get rightIsSelected(): boolean
  • Returns boolean

  • set rightIsSelected(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get rightTitle(): string
  • Gets or sets the title of the Right button.

    Returns string

  • set rightTitle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get subPanelRowHeight(): number
  • Gets or sets the height to use for the sub panel if different than default

    Returns number

  • set subPanelRowHeight(v: number): void
  • Parameters

    • v: number

    Returns void

  • get subtitle(): string
  • Gets or sets the subtitle of the tool.

    Returns string

  • set subtitle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get subtitleTextColor(): string
  • Gets or sets the label text color.

    Returns string

  • set subtitleTextColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get subtitleTextStyle(): string
  • Gets or sets the font to use.

    Returns string

  • set subtitleTextStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get textColor(): string
  • Gets or sets the label text color.

    Returns string

  • set textColor(v: string): void
  • Parameters

    • v: string

    Returns void

  • get textStyle(): string
  • Gets or sets the font to use.

    Returns string

  • set textStyle(v: string): void
  • Parameters

    • v: string

    Returns void

  • get title(): string
  • Gets or sets the title of the tool.

    Returns string

  • set title(v: string): void
  • Parameters

    • v: string

    Returns void

  • get titleHorizontalAlignment(): HorizontalAlignment
  • Gets or sets the title horizontal alignment.

    Returns HorizontalAlignment

  • set titleHorizontalAlignment(v: HorizontalAlignment): void
  • Parameters

    Returns void

  • get visibility(): Visibility
  • Gets or sets the tool action visibility.

    Returns Visibility

  • set visibility(v: Visibility): void
  • Parameters

    Returns void

  • get width(): number
  • Gets or sets the width to use for this tool action.

    Returns number

  • set width(v: number): void
  • Parameters

    • v: number

    Returns void

Methods

  • Parameters

    • name: string

    Returns any

  • Returns void