ActiveKeyBarLocation enum | QSYS API Reference Guide

Estimated reading time: 2 minutes

Specifies the Active Function Key Bar location and direction.

Namespace: ASNA.QSys.Expo.Tags Assembly: ASNA.QSys.Expo.Tags.dll

Remarks

Consistent with DDS for display files, QSys Expo Display Pages define an HTML form element with a DdsFile Tag Helper child element which represents the root structure of the Page.

As shown below, a simplified (and collapsed) markup structure, the DdsFile Tag Helper has two elements:

1. A DdsFunctionKeys Tag Helper.
2. A main HTML element.

The rest of the DdsXXX Tag helpers, like DdsRecord, DdsSubfileControl Tag Helper and DdsMessagePanel Tag Helper, are described inside the main HTML element.

<form id="MonarchForm" method="post">
    <DdsFile DisplayPageModel="Model">

        <DdsFunctionKeys Location="HorizontalBottom" />
        
        <main role="main">
            <DdsSubfileControl>...<DdsSubfileControl>
            <DdsRecord>...</DdsRecord>
        </main>
    </DdsFile>
</form>

Typically, the first Tag Helper described inside the DdsFile Tag Helper is the DdsFunctionKeys Tag Helper.

The DdsFunctionKeys Tag Helper determines how the collection of Active Function Keys will be rendered as clickable buttons.

Notice that selecting the Location of the Active Function Keys also determines where the rest of the Page (main elements) will be rendered. I.E. if the Location is Hidden, the main elements will be rendered as a full-page, if the Location is HorizontalTop, the main elements will be rendered below the Active Function Keys horizontal bar, in the same way, if the Location is HorizontalBottom, the main elements will be rendered above the Active Function Keys horizontal bar, etc.

The ActiveKeyBarLocation Enumeration has the possible values for the Location property for the DdsFunctionKeys Tag Helper.

Enum Values