AccordionItem

[ Interface ]

export interface AccordionItem {
    name: string;
    text: string;
    targetFile: TargetFile;
    targetFileHostPreload: boolean;
    targetFileHostPreAttach: boolean;
    targetFileHostKeepAlive: boolean;
    accessRights?: TcHmi.AccessControl[];
    fileHost?: TcHmi.Controls.System.TcHmiRegion | TcHmi.Controls.System.TcHmiUserControlHost;
    headerElement?: HTMLElement;
    contentElement?: HTMLElement;
    scrollContainer?: HTMLElement;
    maxContentHeight?: number;
    icon?: Icon;
    iconElement?: HTMLElement;
}

Properties

Name	Type	Description
name	string	Name of the accordion element.
text	string	The displayed text of the accordion item.
targetFile	TargetFile	The control or UserControl to be displayed.
targetFileHostPreload	boolean	Fixes whether the target file host is preloaded when the Accordion region is initialized or only loaded when the Accordion item is chosen.
targetFileHostPreAttach	boolean	Determines whether the target file host is already inserted into the DOM, even if the Accordion element is not yet open. Only has an effect if TargetFileHostPreload is set to true.
targetFileHostKeepAlive	boolean	Fixes whether the target file host remains active when the accordion item is closed. Has no effect if TargetFileHostPreload is set to true.
accessRights	TcHmi.AccessControl[], undefined	A list of access rights for the accordion item.
fileHost	TcHmi.Controls.System.TcHmiRegion, TcHmi.Controls.System.TcHmiUserControlHost, undefined	The file host as a region for controls or as a UserControlHost for UserControls.
headerElement	HTMLElement, undefined	The header element of the accordion item.
contentElement	HTMLElement, undefined	The content element of the accordion item
scrollContainer	HTMLElement, undefined	The scroll container of the accordion item
maxContentHeight	number, undefined	The maximum height of the content of the accordion item in 'px'.
icon	Icon, undefined	The icon of the accordion item.
iconElement	HTMLElement, undefined	The HTML element of the icon.

Schema: tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiAccordionRegion.AccordionItem