Stacks API

Come build with us.
Stacks API v6 for Stacks 2.5


  <   Custom Controls Reference


Info Text — info

This content is open source. You can edit it and submit a pull request on GitHub.
This page is generated from this file.


© . YourHead Software all rights reserved.

Info Text — info

Overview

Static informational text.

The Title is the only part of this control that is displayed.

Usually keeping controls to a minimum and using descriptive titles and tooltips is enough to make the use of your stack obvious. Occasionally there's a need for a bit more text. If you find you need this control often, it's a sign that your stack is too confusing.

Never explain something confusing. Just make it less confusing.

Please use this sparingly.

Available: Stacks API v3

ID

The ID for this control. This ID must be unique within this stack. The ID is used to refer to control's property. IDs should be alpha-numeric (dashes and underscores are allowed), but should not contain special characters.




Title

The title displayed next to the control. Long titles will be trancated, so keep it short.




Enable

Hide or show the control based on the value of another property.

Enables allow a stack to show only the controls needed by the user to achieve a specific task.

The enable dictionary defines the ID of another control and the value that other control must equal. When the other control's value is not equal to the provided value, this control is hidden.

Enable Dictionary

Warning: creating infinite loops in enable dependencies has undefined behavior but will likely result in a crash.




Tool Tip

The tooltip value is used to display hints for the user on the use of each control. If the function of the control is obvious, then a tooltip should be avoided. Simply re-displaying redundant information like the title has no value to the user.




© . YourHead Software all rights reserved.