Skip to content

Interface: IActionBarProxy

Hierarchy

Implemented by

Summary

Properties

Class Properties

Currently none in this class.

Inherited Properties

Methods

Class Methods

Inherited Methods

Methods

getCaption

getCaption(): string

Overrides IControlProxy.getCaption

Returns: string


getCaptionAlignment

getCaptionAlignment(): string

Returns: string


getDataSubscriptions

getDataSubscriptions(): string[]

Returns: string[]


getItem

getItem(itemName: string): IActionBarItemProxy

Parameters:

Name Type Description
itemName string takes in _Name property of the actionbar item

Returns: IActionBarItemProxy

returns the ActionBarItemProxy instance of the item by the name


getItems

getItems(): IActionBarItemProxy[]

Returns: IActionBarItemProxy[]

The actionbar items controls for this container


getLogo(): string

Returns: string


getOverflowIcon

getOverflowIcon(): string

Returns: string


getPreferredCaptionSize

getPreferredCaptionSize(): string

Returns: string


getPrefersLargeCaption

getPrefersLargeCaption(): boolean

Returns: boolean


getStyle

getStyle(): any

Returns: any


getSubhead

getSubhead(): string

Returns: string


isContainer

isContainer(): boolean

Overrides IControlProxy.isContainer

Returns: boolean

true/false.


reset

reset(): Promise‹any›

Returns: Promise‹any›


setCaption

setCaption(caption: string): void

Parameters:

Name Type Description
caption string value to set.

Returns: void


setCaptionAlignment

setCaptionAlignment(captionAlignment: string): void

Parameters:

Name Type Description
captionAlignment string value to set.

Returns: void


setDataSubscriptions

setDataSubscriptions(dataSubscriptions: string[]): void

Parameters:

Name Type Description
dataSubscriptions string[] value to set.

Returns: void


setLogo(logo: string): void

Parameters:

Name Type Description
logo string value to set.

Returns: void


setOverflowIcon

setOverflowIcon(overflowIcon: string): void

Parameters:

Name Type Description
overflowIcon string value to set.

Returns: void


setPreferredCaptionSize

setPreferredCaptionSize(preferredCaptionSize: string): void

Parameters:

Name Type Description
preferredCaptionSize string value to set.

Returns: void


setPrefersLargeCaption

setPrefersLargeCaption(prefersLargeCaption: boolean): void

Parameters:

Name Type Description
prefersLargeCaption boolean value to set.

Returns: void


setSubhead

setSubhead(subhead: string): void

Parameters:

Name Type Description
subhead string value to set.

Returns: void