TcHmiNavigationBar

[ Class ]

Implementation of the Navigation Bar control.

Attribute functions

Name

Origin

Description

getBackgroundColor

TcHmiControl

Getter for the BackgroundColor attribute.

setBackgroundColor

TcHmiControl

Setter for the BackgroundColor attribute.

getBorderColor

TcHmiControl

Getter for the BorderColor attribute.

setBorderColor

TcHmiControl

Setter for the BorderColor attribute.

getBorderRadius

TcHmiControl

Getter for the BorderRadius attribute.

setBorderRadius

TcHmiControl

Setter for the BorderRadius attribute.

getBorderStyle

TcHmiControl

Getter for the BorderStyle attribute.

setBorderStyle

TcHmiControl

Setter for the BorderStyle attribute.

getBorderWidth

TcHmiControl

Getter for the BorderWidth attribute.

setBorderWidth

TcHmiControl

Setter for the BorderWidth attribute.

getLeft

TcHmiControl

Getter for the Left attribute.

setLeft

TcHmiControl

Setter for the Left attribute.

getLeftUnit

TcHmiControl

Getter for the LeftUnit attribute.

setLeftUnit

TcHmiControl

Setter for the LeftUnit attribute.

getTop

TcHmiControl

Getter for the Top attribute.

setTop

TcHmiControl

Setter for the Top attribute.

getTopUnit

TcHmiControl

Getter for the TopUnit attribute.

setTopUnit

TcHmiControl

Setter for the TopUnit attribute.

getRight

TcHmiControl

Getter for the Right attribute.

setRight

TcHmiControl

Setter for the Right attribute.

getRightUnit

TcHmiControl

Getter for the RightUnit attribute.

setRightUnit

TcHmiControl

Setter for the RightUnit attribute.

getBottom

TcHmiControl

Getter for the Bottom attribute.

setBottom

TcHmiControl

Setter for the Bottom attribute.

getBottomUnit

TcHmiControl

Getter for the BottomUnit attribute.

setBottomUnit

TcHmiControl

Setter for the BottomUnit attribute.

getWidth

TcHmiControl

Getter for the Width attribute.

setWidth

TcHmiControl

Setter for the Width attribute.

getWidthUnit

TcHmiControl

Getter for the WidthUnit attribute.

setWidthUnit

TcHmiControl

Setter for the WidthUnit attribute.

getHeight

TcHmiControl

Getter for the Height attribute.

setHeight

TcHmiControl

Setter for the Height attribute.

getHeightUnit

TcHmiControl

Getter for the HeightUnit attribute.

setHeightUnit

TcHmiControl

Setter for the HeightUnit attribute.

getMaxWidth

TcHmiControl

Getter for the MaxWidth attribute.

setMaxWidth

TcHmiControl

Setter for the MaxWidth attribute.

getMaxWidthUnit

TcHmiControl

Getter for the MaxWidthUnit attribute.

setMaxWidthUnit

TcHmiControl

Setter for the MaxWidthUnit attribute.

getMinWidth

TcHmiControl

Getter for the MinWidth attribute.

setMinWidth

TcHmiControl

Setter for the MinWidth attribute.

getMinWidthUnit

TcHmiControl

Getter for the MinWidthUnit attribute.

setMinWidthUnit

TcHmiControl

Setter for the MinWidthUnit attribute.

getMaxHeight

TcHmiControl

Getter for the MaxHeight attribute.

setMaxHeight

TcHmiControl

Setter for the MaxHeight attribute.

getMaxHeightUnit

TcHmiControl

Getter for the MaxHeightUnit attribute.

setMaxHeightUnit

TcHmiControl

Setter for the MaxHeightUnit attribute.

getMinHeight

TcHmiControl

Getter for the MinHeight attribute.

setMinHeight

TcHmiControl

Setter for the MinHeight attribute.

getMinHeightUnit

TcHmiControl

Getter for the MinHeightUnit attribute.

setMinHeightUnit

TcHmiControl

Setter for the MinHeightUnit attribute.

getRenderedLeft

TcHmiControl

Getter for the RenderedLeft attribute.

getRenderedTop

TcHmiControl

Getter for the RenderedTop attribute.

getRenderedBottom

TcHmiControl

Getter for the RenderedBottom attribute.

getRenderedRight

TcHmiControl

Getter for the RenderedRight attribute.

getRenderedWidth

TcHmiControl

Getter for the RenderedWidth attribute.

getRenderedHeight

TcHmiControl

Getter for the RenderedHeight attribute.

getOpacity

TcHmiControl

Getter for the Opacity attribute.

setOpacity

TcHmiControl

Setter for the Opacity attribute.

getVisibility

TcHmiControl

Getter for the Visibility attribute.

setVisibility

TcHmiControl

Setter for the Visibility attribute.

getTransform

TcHmiControl

Getter for the Transform attribute.

setTransform

TcHmiControl

Setter for the Transform attribute.

getGridColumnIndex

TcHmiControl

Getter for the GridColumnIndex attribute.

setGridColumnIndex

TcHmiControl

Setter for the GridColumnIndex attribute.

getGridRowIndex

TcHmiControl

Getter for the GridRowIndex attribute.

setGridRowIndex

TcHmiControl

Setter for the GridRowIndex attribute.

getZindex

TcHmiControl

Getter for the Zindex attribute.

setZindex

TcHmiControl

Setter for the Zindex attribute.

getWidthMode

TcHmiControl

Getter for the WidthMode attribute.

setWidthMode

TcHmiControl

Setter for the WidthMode attribute.

getHeightMode

TcHmiControl

Getter for the HeightMode attribute.

setHeightMode

TcHmiControl

Setter for the HeightMode attribute.

getAlignment

TcHmiNavigationBar

Getter for the Alignment attribute.

setAlignment

TcHmiNavigationBar

Setter for the Alignment attribute.

getBreadcrumbControl

TcHmiNavigationBar

Getter for the BreadcrumbControl attribute.

setBreadcrumbControl

TcHmiNavigationBar

Setter for the BreadcrumbControl attribute.

getBreadcrumbControlSymbol

TcHmiNavigationBar

Getter for the BreadcrumbControlSymbol attribute.

setBreadcrumbControlSymbol

TcHmiNavigationBar

Setter for the BreadcrumbControlSymbol attribute.

getDesktopView

TcHmiNavigationBar

Getter for the DesktopView attribute.

getEnableMobileSwitch

TcHmiNavigationBar

Getter for the EnableMobileSwitch attribute.

setEnableMobileSwitch

TcHmiNavigationBar

Setter for the EnableMobileSwitch attribute.

getFontColor

TcHmiNavigationBar

Getter for the FontColor attribute.

setFontColor

TcHmiNavigationBar

Setter for the FontColor attribute.

getFontSize

TcHmiNavigationBar

Getter for the FontSize attribute.

setFontSize

TcHmiNavigationBar

Setter for the FontSize attribute.

getFontSizeUnit

TcHmiNavigationBar

Getter for the FontSizeUnit attribute.

setFontSizeUnit

TcHmiNavigationBar

Setter for the FontSizeUnit attribute.

getHighlightColor

TcHmiNavigationBar

Getter for the HighlightColor attribute.

setHighlightColor

TcHmiNavigationBar

Setter for the HighlightColor attribute.

getLastEventParameter

TcHmiNavigationBar

Getter for the LastEventParameter attribute.

getLastPage

TcHmiNavigationBar

Getter for the LastPage attribute.

getListenToWindowResize

TcHmiNavigationBar

Getter for the ListenToWindowResize attribute.

setListenToWindowResize

TcHmiNavigationBar

Setter for the ListenToWindowResize attribute.

getMenuSourceData

TcHmiNavigationBar

Getter for the MenuSourceData attribute.

setMenuSourceData

TcHmiNavigationBar

Setter for the MenuSourceData attribute.

getMobileIconHeight

TcHmiNavigationBar

Getter for the MobileIconHeight attribute.

setMobileIconHeight

TcHmiNavigationBar

Setter for the MobileIconHeight attribute.

getMobileIconHeightUnit

TcHmiNavigationBar

Getter for the MobileIconHeightUnit attribute.

setMobileIconHeightUnit

TcHmiNavigationBar

Setter for the MobileIconHeightUnit attribute.

getMobileIconWidth

TcHmiNavigationBar

Getter for the MobileIconWidth attribute.

setMobileIconWidth

TcHmiNavigationBar

Setter for the MobileIconWidth attribute.

getMobileIconWidthUnit

TcHmiNavigationBar

Getter for the MobileIconWidthUnit attribute.

setMobileIconWidthUnit

TcHmiNavigationBar

Setter for the MobileIconWidthUnit attribute.

getMobileMenuImage

TcHmiNavigationBar

Getter for the MobileMenuImage attribute.

setMobileMenuImage

TcHmiNavigationBar

Setter for the MobileMenuImage attribute.

getMouseOverShow

TcHmiNavigationBar

Getter for the MouseOverShow attribute.

setMouseOverShow

TcHmiNavigationBar

Setter for the MouseOverShow attribute.

getNavContentControl

TcHmiNavigationBar

Getter for the NavContentControl attribute.

setNavContentControl

TcHmiNavigationBar

Setter for the NavContentControl attribute.

getNavContentControlSymbol

TcHmiNavigationBar

Getter for the NavContentControlSymbol attribute.

setNavContentControlSymbol

TcHmiNavigationBar

Setter for the NavContentControlSymbol attribute.

getPaddingLeftRight

TcHmiNavigationBar

Getter for the PaddingLeftRight attribute.

setPaddingLeftRight

TcHmiNavigationBar

Setter for the PaddingLeftRight attribute.

getPaddingLeftRightUnit

TcHmiNavigationBar

Getter for the PaddingLeftRightUnit attribute.

setPaddingLeftRightUnit

TcHmiNavigationBar

Setter for the PaddingLeftRightUnit attribute.

getSwitchBreakpoint

TcHmiNavigationBar

Getter for the SwitchBreakpoint attribute.

setSwitchBreakpoint

TcHmiNavigationBar

Setter for the SwitchBreakpoint attribute.

getTargetRegionControl

TcHmiNavigationBar

Getter for the TargetRegionControl attribute.

setTargetRegionControl

TcHmiNavigationBar

Setter for the TargetRegionControl attribute.

getTargetRegionControlSymbol

TcHmiNavigationBar

Getter for the TargetRegionControlSymbol attribute.

setTargetRegionControlSymbol

TcHmiNavigationBar

Setter for the TargetRegionControlSymbol attribute.

getTriangleColor

TcHmiNavigationBar

Getter for the TriangleColor attribute.

setTriangleColor

TcHmiNavigationBar

Setter for the TriangleColor attribute.

getIsEnabled

TcHmiControl

Getter for the IsEnabled attribute.

setIsEnabled

TcHmiControl

Setter for the IsEnabled attribute.

getId

TcHmiControl

Getter for the id attribute.

getType

TcHmiControl

Getter for the type attribute.

getIsEnabled

TcHmiControl

Getter for the IsEnabled attribute.

setIsEnabled

TcHmiControl

Setter for the IsEnabled attribute.

getClassNames

TcHmiControl

Getter for the ClassNames attribute.

setClassNames

TcHmiControl

Setter for the ClassNames attribute.

getIsAttached

TcHmiControl

Getter for the IsAttached attribute.

getTooltip

TcHmiControl

Getter for the Tooltip attribute.

setTooltip

TcHmiControl

Setter for the Tooltip attribute.

getAccessConfig

TcHmiControl

Getter for the AccessConfig attribute.

setAccessConfig

TcHmiControl

Setter for the AccessConfig attribute.

getBackgroundImage

TcHmiControl

Getter for the BackgroundImage attribute.

setBackgroundImage

TcHmiControl

Setter for the BackgroundImage attribute.

getBackgroundImageHeight

TcHmiControl

Getter for the BackgroundImageHeight attribute.

setBackgroundImageHeight

TcHmiControl

Setter for the BackgroundImageHeight attribute.

getBackgroundImageHeightUnit

TcHmiControl

Getter for the BackgroundImageHeightUnit attribute.

setBackgroundImageHeightUnit

TcHmiControl

Setter for the BackgroundImageHeightUnit attribute.

getBackgroundImageWidth

TcHmiControl

Getter for the BackgroundImageWidth attribute.

setBackgroundImageWidth

TcHmiControl

Setter for the BackgroundImageWidth attribute.

getBackgroundImageWidthUnit

TcHmiControl

Getter for the BackgroundImageWidthUnit attribute.

setBackgroundImageWidthUnit

TcHmiControl

Setter for the BackgroundImageWidthUnit attribute.

getBackgroundImagePadding

TcHmiControl

Getter for the BackgroundImagePadding attribute.

setBackgroundImagePadding

TcHmiControl

Setter for the BackgroundImagePadding attribute.

getBackgroundImageHorizontalAlignment

TcHmiControl

Getter for the BackgroundImageHorizontalAlignment attribute.

setBackgroundImageHorizontalAlignment

TcHmiControl

Setter for the BackgroundImageHorizontalAlignment attribute.

getBackgroundImageVerticalAlignment

TcHmiControl

Getter for the BackgroundImageVerticalAlignment attribute.

setBackgroundImageVerticalAlignment

TcHmiControl

Setter for the BackgroundImageVerticalAlignment attribute.

getBoxShadow

TcHmiControl

Getter for the BoxShadow attribute.

setBoxShadow

TcHmiControl

Setter for the BoxShadow attribute.

Functions

Name

Origin

Description

getElement

TcHmiControl

Returns the root HTML element of the control.

__previnit

TcHmiControl

Pre-initialization

__init

TcHmiControl

Initialization

__attach

TcHmiControl

Code after insertion in the DOM

__detach

TcHmiControl

Code after removal from the DOM

destroy

TcHmiControl

Clean-up after deleting the control.

getIsDestroyed

TcHmiControl

Query whether control was deleted.

getAttributeDefaultValueInternal

TcHmiControl

Query of the default value of a property.

Inheritance hierarchy

Control

    Navigation Bar

See also

Reference of this control

TcHmiNavigationBar 1:

Available from version 1.12