The Action attribute is used to define the exact operation that should be executed when the button is clicked or its assigned key is pressed. Since a button becomes meaningful only when it is linked to a specific function or operation, the Action attribute establishes this functional mapping. It is a dual attribute that allows you to specify actions such as opening a report, calling a function, modifying context, or triggering data operations. Without the Action attribute, a button remains only a visual element; with it, the button becomes an actionable component within the Tally interface. Hence, it is a mandatory attribute for the Button definition when neither Action List nor ActionEx is specified. The precedence of execution is highest for Action List, followed by ActionEx, and then Action.

Syntax

[Button : <Button Name>]

Action : <Action Name> [:<Action Paramters>]

Example

The Action List attribute allows you to specify multiple actions as a comma-separated list to be executed in a defined sequence when a button is clicked or its key is pressed. These actions reference a list of key definitions that share the same key combination, ensuring consistent triggering. Action List groups several related actions under a single list name and executes them in order, making it ideal for scenarios where a single button press needs to perform a chain of operations, such as opening a report, setting filters, modifying context, or calling functions. It functions like a mini-workflow controller, ensuring that every step executes smoothly and in the correct sequence. If the Action or ActionEx attributes are also specified, they are ignored. The precedence of execution is highest for Action List, followed by ActionEx, and then Action.

Syntax

[Button : <Button Name>]

Key : <KeyName1>

Action List : <Key / Button Definition 1>, <Key / ButtonDefinition 2>,..

Example

The ActionEx attribute is used to enhance multi-action support at the button or key level by allowing multiple actions to be specified with additional parameters and finer control, as it is a triple-list attribute. It acts as an advanced version of the Action and Action List attributes, enabling more complex and structured sequences of operations to run when a button is clicked or a key is invoked—without needing to define multiple keys or buttons. Each action within ActionEx can have its own sub-parameters and extended configurations, making it ideal for scenarios that require deeper control and detailed action definitions. The precedence of execution is highest for Action List, followed by ActionEx, and then Action

Syntax

[Button:<Button Name>]

ActionEx: <Label>:<Action Keyword>[:<Action Parameters>]

OR

[Button :<Button Name>]

<Label>:<Action Keyword>[:<Action Parameters>]

Example

[Button: TSPL Button]

Key : Ctrl + F

ActionEx: TB : Display : Trial Balance

ActionEx: PL : Display : Profit and Loss

BS : Display : Balance Sheet

This example defines a button called TSPL Button.
It is triggered using the shortcut Ctrl + F.
With the ActionEx attribute, the button can perform multiple actions—TB displays the Trial Balance, PL shows the Profit & Loss, and BS brings up the Balance Sheet.
In short, one shortcut gives you quick access to all three final account reports.

The Background attribute is used to define the background color of a button, allowing you to visually distinguish it on the Tally interface. By specifying a color, you can enhance the appearance of the button, improve clarity, and help users quickly identify its purpose among multiple buttons. This attribute controls only the visual styling of the button and does not affect its functionality or behavior, making it purely a display-related property.

Syntax

[Button : Button Name]

Background : <Color Definition Name>

Example

[Button : TSPL Button]

Background : Dark Green

This TDL defines a button called TSPL Button.
It adds the backgournd color of this button as Dark Green.

The Border attribute is used to define the type of border displayed around a button, enhancing its visual appearance and helping it stand out on the Tally interface. By specifying the border style, you can improve the clarity and prominence of a button, making it easier for users to identify and interact with. Like the Background attribute, Border affects only the visual styling and does not influence the button’s functionality or behavior. It is commonly used when a button is placed inline within a Part.

Syntax

[Button : Button Name]

Border : <Border Definition Name>

Example

[Button : TSPL Button]

Border : Thin Bottom

This example creates a button called TSPL Button.

It adds a thin border at the bottom of the button.

The Bottom Toolbar Position attribute determines the placement of a button on the bottom toolbar, which can display up to ten buttons at a time, ranging from BottomToolBarBtn1 (first position) to BottomToolBarBtn10 (last position). It allows you to control the order in which buttons appear within a report, ensuring a logical and user-friendly layout. Specifying this attribute affects only the button’s placement and does not impact its functionality or behavior.

Syntax

[Button : Button Name]

BottomToolbar Position : <Position Key word>

Where position keyword can be ranging from BottomToolBarBtn1 to BottomToolBarBtn10

Example

[Button: TSPL Button]

Title   : $$LocaleString:”Cancel Vch”

Key     : Alt+X

Inactive: NOT $$InAlterMode

Action  : Cancel

BottomToolbar Position : BottomToolBarBtn8

The Cancel attribute is used to deactivate a button when a specific condition is met. In other words, the button remains active only if the specified condition evaluates to true; otherwise, it appears inactive and cannot be used. This attribute serves as an alias for the Inactive attribute of the button.

Syntax

[Button : Button Name]

Cancel / Inactive : <Logical Expression>

Example

[Button: TSPL Button]

Title : $$LocaleString:”Save”

Key : Alt + S

Action : Save Variable

Cancel : $$IsEmpty:$Name

In this example, the Cancel attribute is set to $$IsEmpty:$Name, which means the “Save” button will be cancelled (disabled or hidden) if the Name field is empty.
This ensures that the button only appears or works when the required field has a valid value.

The Color attribute is used to define the color of a button’s title. By specifying this attribute, you can control how the button text appears, enhancing readability and providing visual emphasis to make the button more noticeable on the interface.

Syntax

[Button : Button Name]

Color : <Color Definition Name>

Example

[Button : TSPL Button]

Color : Red

This example creates a button called TSPL Button.
It adds Red color to the title of the button.

The FocusBG attribute defines the background color of a button when it is selected or highlighted, helping users identify which button is currently in focus. This attribute is applicable only for inline buttons and is ignored for buttons placed on the button bar or bottom toolbar.

Syntax

[Button : <Button Name>]

FocusBG : <Color Defintion Name>

Example

[Button : TSPL Button]

FocusBG: Deep Grey

In this example, the attribute FocusBG is set to Deep Grey, which means that when the TSPL Button is selected or highlighted, its background color will change to deep grey.

The Height attribute is used to define the vertical size of a button when it is displayed either inline within a report or on the Right Button Bar. It allows you to adjust how tall the button appears, helping align it visually with surrounding elements or improve emphasis. This attribute accepts numeric values that represent height in Tally’s UI units. The Height attribute is ignored for buttons placed on the Top or Bottom Toolbars, as their dimensions are fixed by the system and cannot be customized. Incase the button is used for Bottom tool bar, then the attribute is ignored

Syntax

[Button : <Button Name>]

Height : <Required Height>

Example

[Button: TSPL Button]

Height : 5% Screen

In this example, the attribute Height is set to 5% Screen, which means the height of the TSPL Button will occupy 5% of the total screen height. This allows the button size to adjust dynamically based on the screen dimensions.

The Horizontal Align attribute is used to control how the content within a button—typically the button title and its key label—is positioned horizontally. You can align the content to Left, Right, or Centre, depending on the visual design you want to achieve. By default, the content is aligned to the Left. This attribute improves readability and visual balance, especially when buttons have additional spacing or when a specific Width is defined. It only affects how text is positioned inside the button and does not impact the button’s behavior or placement in the interface. The alignment takes effect only when there is available space within the button—either due to added spacing or an explicitly assigned width.

Syntax

[Button : <Button Name>]

Horizontal Align : < Alignment Keywords>

Example

[Button: TSPL Button]

Horizontal Align : Left

In this example, the attribute Horizontal Align is set to Left, which positions the TSPL Button towards the left side of its defined area.

The Image attribute is used to assign an image from a predefined resource to a button, allowing you to visually enhance the button’s appearance. It supports multiple image formats, including JPEG, Bitmap, Icon, and Cursor. The resource referenced in this attribute must be defined separately, with its resource type specified as Bmap, Jpeg, Icon, or Cursor. This attribute is purely visual and helps make buttons more intuitive or distinctive, especially when used in toolbars or inline button placements. It does not influence the button’s functionality only its visual representation. For more refer to Resource Definition.

Syntax

[Button : <Button Name>]

Image : < Resource Definition Name>

Example

[Button: TSPL Button]

Key : Alt + S

Action : Display : Stock Item Image

Image : Show Image

[Resource: Show Image]

Source : d:\tp\Button\StockItem.jpeg

Resource Type : Jpeg

In this example, the TSPL Button is configured to display a Stock Item Image when the user presses Alt + S. The Image attribute links to a resource named Show Image, which uses the JPEG file located at “d:\tp\Button\StockItem.jpeg”. This assigns the specified image to the button’s display.

The Inactive Color attribute is used to define the color of a button’s title and key when the button is inactive. This visual cue helps users clearly identify that the button is disabled or unavailable for interaction in the current context. By differentiating the appearance of inactive buttons, it enhances the overall usability and clarity of the interface. This attribute affects only the visual styling and does not influence the underlying functionality or behavior of the button.

Syntax

[Button : <Button Name>]

InactiveColor : <Color Definition Name>

Example

[Button: TSPL Button]

InactiveColor : Grey

In this example, the attribute InactiveColor is set to Grey, which means that when the TSPL Button is inactive or disabled, its key and title will appear in grey color.

The Key attribute is used to assign a unique key combination that triggers the button or key definition across various Tally interfaces. It is a mandatory attribute, as every button or key definition must have a unique key combination to ensure consistent and conflict-free user interaction.
When the Key attribute is used in a Button definition, the allowed key combinations are restricted to ensure compatibility with Tally’s standard UI behavior. The permissible combinations include:
Function Keys
Examples: F1, F2, F4, F8, F10, etc.
Alt + Function Keys
Examples: Alt + F1, Alt + F7, Alt + F12
Alphanumeric Keys
Examples: A, B, C, D … Z, 0–9
Alt + Alphanumeric Keys
Examples: Alt + A, Alt + G, Alt + S, Alt + 1
Ctrl + Alt + Function Keys
Examples: Ctrl + Alt + F4, Ctrl + Alt + F9
Ctrl + Alt + Alphanumeric Keys
Examples: Ctrl + Alt + V, Ctrl + Alt + B, Ctrl + Alt + 7
Shift-based combinations are not allowed when defining a button on the Tally screen.
For example, combinations such as Shift + F5 or Alt + Shift + A are not permissible in a button definition.

The Key attribute ensures that the button can be accessed seamlessly using the keyboard, supporting faster navigation and improved accessibility. While the key combination defines how the button is triggered, it does not directly influence the button’s visibility or behavior those aspects are managed through other attributes like Action, ActionEx, Cancel, and so on.

Syntax

[Button : <Button Name>]

Key : <Key combination>

Example

[Button: TSPL Button]

Key : F4

In this example, the attribute Key is set to F4, which means the TSPL Button can be activated by pressing the F4 key on the keyboard.

The Key Color attribute is used to define the display color of the key label shown on the button. In Tally’s interface, the button title and the associated shortcut key are typically displayed together—for example, Alt + G, F4, or Ctrl + Alt + V. The Key Color attribute specifically controls the color applied to this key portion of the button’s text.
This attribute helps visually distinguish the key hint from the button title, improving readability and making shortcut keys more noticeable to the user. It is especially useful when designing custom button layouts, inline buttons, or buttons placed in visually dense areas such as the Right Button Bar or Bottom Toolbar.
Key Color impacts only the text color of the key label and does not affect the button’s functionality, background, or title color. When the button becomes inactive, the InactiveColor attribute overrides Key Color to maintain consistent disabled-state visuals.

Syntax

[Button: <Button Name>]

KeyColor: <Color Definition Name>

Example

[Button: TSPL Button]

KeyColor : Blue

In this example, the attribute KeyColor is set to Blue, which means that when the TSPL Button is active, the color of its key label will appear in blue.

The Key Style attribute is used to define the font style applied specifically to the key label of a button. By assigning a font style such as Bold, Italic, or Underline, you can control how prominently the shortcut key appears relative to the button title.

This attribute is particularly useful when you want to emphasize the shortcut key for quicker recognition, improve visual hierarchy, or maintain stylistic consistency across custom interfaces. Key Style affects only the appearance of the key text and does not influence the color, background, behavior, or functionality of the button.

Syntax

[Button : <Button Name>]

KeyStyle: <Style Definition Name>

Example

[Button: TSPL Button]

KeyStyle : Small Bold

In this example, the attribute KeyStyle is set to Small Bold, which means the key label on the TSPL Button will be displayed in a smaller font size with a bold style.

The Key Vertical Align attribute is used to control the vertical positioning of the button’s key label (such as F4, Alt+G, Ctrl+Alt+V, etc.) within the button. You can align the key to the Top, Centre, or Bottom, depending on the layout or visual structure you want to achieve.
This attribute affects only the vertical alignment of the key portion not the button title or the button’s size and is especially useful when designing wider or taller buttons, inline buttons, or when the visual presentation requires finer alignment for clarity and consistency. The alignment takes effect only when there is enough height in the button or when a custom button layout is defined.

Syntax

[Button : <Button Name>]

Key Vertical Align : < Alignment Keywords>

Example

[Button: TSPL Button]

Key Vertical Align : Centre

In this example, the attribute Key Vertical Align is set to Centre, which means the key label on the TSPL Button will be vertically aligned to the center of the button.

The Line attribute is used to specify the number of lines a button should occupy on the display. By default, a button fits within a single line, but when the button title is long, Tally automatically adjusts the line usage as needed. However, when you want explicit control over how many lines the button’s title can span, the Line attribute allows you to define this manually. When the attribute is specified, it ensures consistent alignment, readability, and visual structure within the interface. It affects only the visual layout and does not influence the button’s functionality.

Syntax

[Button : <Button Name>]

Line : < Value>

Example

[Button: TSPL Button]

Title : “Sales Executive wise Summary”

Lines : 2

In this example, the attribute Lines is set to 2, which means the TSPL Button can display its title across two lines instead of the default single line.

The Mode attribute specifies the operational mode in which a button’s key action should be executed Display mode, Edit mode, or both. Since certain actions are relevant only when viewing data and others only when editing it, the Mode attribute helps control when the button is active and responsive. By setting the appropriate mode, you ensure that the button behaves contextually, preventing unintended actions and enhancing user interaction. This attribute affects only the activation context of the button and does not influence its visual appearance.

Syntax

[Button : <Button Name>]

Mode : <Value>

Example

[Button: TSPL Button]

Key : F5

Action : Alter : Stock Item

Mode : Edit

In this example, the Mode attribute is set to Edit, which means the action linked to the F5 key (to alter a Stock Item) will only be executed when Tally is in Edit mode.

The Modifier Button attribute is used to group buttons that perform similar or related actions under a single button definition. Instead of creating multiple buttons on the interface which can clutter the button bar, this attribute allows you to use modifier keys such as Ctrl or Alt to trigger alternate actions.

When the user presses a modifier key, Tally automatically regenerates the button to display the updated key combination and title, indicating the alternative action that will be executed.

This approach keeps the button bar clean and clutter-free, while still providing quick access to multiple variations of an action from the same interface. The Modifier Button attribute is especially useful when several actions share a common context but differ in behavior based on the modifier key used.

Syntax

[Button: <Button Name>]

Modifier Key : <Button/Key Name>

Example

[Button: TSPL Button]

Title : $$LocaleString:”Fortnightly”

Key : F6

Action : Set: SVPeriodicity :”Fortnight”

Modifier Keys : TSPLMonthly, TSPLQuaterly

[Button: TSPL Monthly]

Title : $$LocaleString:”Monthly”

Key : Alt + F6

Action : Set : SVPeriodicity :”Month”

[Button: TSPLQuaterly]

Title : $$LocaleString:”Quaterly”

Key : Ctrl + F6

Action : Set: SVPeriodicity :”3 Month”

In this example, the Modifier Keys attribute is used to group buttons that perform similar actions—setting different periodicities.

The main TSPL Button is triggered with F6 for Fortnightly, while the modifier keys (Alt and Ctrl) generate alternate versions of the same button: Alt + F6 for Monthly and Ctrl + F6 for Quarterly.
This allows related actions to be merged under one button definition, where pressing a modifier key dynamically changes the button’s title and action based on the selected key combination.

The Scope attribute is used to specify the range or extent on which a button’s action should operate. Depending on the requirement, the action can be applied to a single line, multiple lines, or a specific subset of lines within a report. The supported values typically include:
Current Line / Line – Executes the action only on the line where the cursor is positioned.
All Lines – Applies the action to every line in the report or list.
Selected Lines – Executes the action only on lines that the user has explicitly selected.
Unselected Lines – Executes the action on all lines except the selected ones.
By defining the scope, you gain precise control over where the action is applied, ensuring accurate and context-aware operations especially in multi-line reports, ledgers, or grid-like interfaces. This attribute influences which data the action affects, without altering the button’s appearance or key behavior.

Syntax

[Button : Button Name]

Scope : <Keyword Value>

Example

[Button : TSPL Button]

Title : $$LocaleString:”Prev. Tile”

Key : Ctrl + Left

Action : Focus Previous Tile

Scope : DASHBOARD

In this example, a button titled “Prev. Tile” is defined to help navigate between tiles on a dashboard.
When the user presses Ctrl + Left, the action Focus Previous Tile is executed.
The attribute Scope : DASHBOARD specifies that this action will only apply within the Dashboard context — meaning the button’s functionality is limited to dashboard operations and won’t affect other areas of Tally.

The Skip Forward attribute is used to make the cursor skip over the button during normal navigation and move directly to the next field or button in sequence. This is useful when the button should remain available for use but should not interrupt the natural data-entry flow. Even though the button is skipped while moving forward, if the user presses Backspace from the subsequent field or button, the focus correctly shifts back to this button. This ensures smooth backward navigation without altering the intended forward flow. It is applied for inline button setups where certain buttons should be accessible but should not disrupt streamlined data entry.

Syntax

[Button : <Button Name>]

Skip Forward : < Logical Expression / Value >

Example

[Button: TSPL Button]

Skip Forward : Yes

In this example, the attribute Skip Forward is set to Yes, which means when the cursor moves through the interface, this TSPL Button will be skipped and the focus will jump to the next button or field.

The Space Left attribute is used to define the amount of horizontal space that should be maintained on the left side of a button. By specifying this spacing, you can control the visual separation between the button and adjacent UI elements, improving layout clarity and alignment.

This attribute affects only the visual positioning of the button and does not influence its functionality or behavior. It is especially useful when designing inline buttons or creating structured, neatly aligned interfaces where consistent spacing enhances readability and aesthetics.

Syntax

[Button : <Button Name>]

Space Left : <Required Space>

Example

[Button: TSPL Button]

Space Left : 5% Screen

In this example, the attribute Space Left is set to 5% Screen, which means there will be a space equal to 5% of the screen width on the left side of the TSPL Button.

The Space Right attribute is used to define the amount of horizontal space that should be maintained on the right side of a button. By specifying this spacing, you can control the button’s visual separation from adjacent UI elements, ensuring a clean, organized, and balanced layout.

This attribute affects only the visual positioning of the button and does not alter its functionality or behavior. It is particularly helpful when designing inline buttons or structured forms where uniform spacing enhances readability and the overall user interface appearance.

Syntax

[Button : <Button Name>]

Space Right : <Required Space>

Example

[Button: TSPL Button]

Space Right : 5% Screen

In this example, the attribute Space Right is set to 5% Screen, which means a space equal to 5% of the screen width will be maintained on the right side of the TSPL Button.

The Style attribute is used to specify the font style applied to the title of the button. By defining this attribute, you can control the visual appearance of the button’s title such as making it bold, italic or applying any predefined text style. This attribute affects only the presentation of the button title and does not influence the button’s behavior or functionality. It is commonly used to highlight important buttons, maintain design consistency, or enhance readability within the interface.

Syntax

[Button : <Button Name>]

Style: <Style Definition Name>

Example

[Button: TSPL Button]

Style : Small

In this example, the attribute Style is set to Small, which means the title text of the TSPL Button will be displayed in a smaller font style.

‘Switch’ attribute is similar to the Option attribute but reduces code complexity and improves the performance. The Switch are grouped using a label. Once a condition is satisfied from one group, switch won’t check further conditions from the same group. It will evaluate the conditions from the other groups specified, if any.

Syntax

[Button : Button Name]

Switch : <Label> : <Definition Name> : <Condition>

Switch : <Label> : <Definition Name> : <Condition>

Example

[Button: TSPL Button]

Title : $$LocaleString:”Process Data”

Key : Alt + P

Switch : ModeGroup : TSPL Button Display : ##InDisplayMode

Switch : ModeGroup : TSPL Button Alter : ##InAlterMode

Switch : ModeGroup : TSPL Button Create : ##InCreateMode

[Button: TSPL Button Display]

Action : Display : Report : Display Mode Report

[Button: TSPL Button Alter]

Action : Display : Report : Alter Mode Report

[Button: TSPL Button Create]

Action : Display : Report : Create Mode Report

The Switch attribute is used here to select which button definition to apply based on the current mode.
All switches are grouped under the label ModeGroup.
Depending on the mode:
1. If ##InDisplayMode is true → TSPL Button Display executes.
2. If ##InAlterMode is true → TSPL Button Alter executes.
3. If ##InCreateMode is true → TSPL Button Create executes.

Once one condition in the group is satisfied, Tally stops checking the remaining conditions within that same group, improving performance.

The Title attribute is used to specify the meaningful text that appears as the display name of the button on the Button Bar or within an inline interface. This title represents the action or purpose of the button, helping users quickly understand what the button does.

It affects only the visual label of the button and does not influence its functionality. A clear, concise title improves usability and ensures that the button is easily identifiable within the Tally interface.

Syntax

[Button : Button Name]

Title : <Title Name>

Example

[Button: TSPL Button]

Key        : Alt+D

Title:  $$LocaleString : “Remove Tile”

The Title attribute specifies the button’s label as Remove Tile, which is displayed on the screen, while the Key attribute allows users to quickly activate the button using the keyboard.

This attribute is used to specify the category of the buttons. The button type can be any of the permissible types as PrintButton,Export Button,MailButton etc.

Syntax

[Button : Button Name]

Type : <Permissible Values>

Example

[Button : TSPL Button]

Type : Export Button

In this example, the attribute Type is set to Export Button, which means the TSPL Button will fetch the values associated to this type.

Use attribute is used when you have to use the properties of already existing definition in another definition. This is done by calling the already existing definition in other definition. Furthermore, one can modify the newly formed definition with this.

Syntax

[Button : Button Name]

Use: <Definition name>

Example

[Button: Save Button]

Title : $$LocaleString:”Save”

[Button: TSPL Button]

Use : Save Button

In this example, the TSPL Button uses the Use attribute to borrow all properties from the existing Save Button.
So, TSPL Button will have the same title “Save” without having to define it again.

The Vertical Align attribute is used to control how the content within a button, typically the button title and its key label, is positioned vertically. You can align the content to Top, Centre, or Bottom, depending on the visual presentation you want to achieve. By default, the content is aligned to the Centre vertically. This attribute enhances readability and visual balance, especially when the button has additional height or when the Line attribute is used to allocate multiple lines. It affects only the vertical positioning of the text inside the button and does not influence the button’s behavior or its position in the overall interface. The alignment is applied only when the button has sufficient vertical space for repositioning either due to increased height or multiline allocation.

Syntax

[Button : <Button Name>]

Vertical Alignment : <Alignment Keywords>

Example

[Button : TSPL Button]

Vertical Alignment : Top

In this example, the attribute Vertical Alignment is set to Top, which means the TSPL Button will be positioned at the top.

The Width attribute is used to specify the horizontal width of a button, allowing you to control how much space the button occupies on the interface. This is particularly useful when creating inline buttons, aligning multiple buttons uniformly, or when the button title requires additional horizontal room for better readability. The attribute affects only the visual dimension of the button and does not alter its behavior or functional mapping. This attribute is not applicable for Right Toolbar buttons, as their width is managed automatically by the Tally interface. For all other button placements, specifying Width ensures cleaner layouts and more consistent UI design.

Syntax

[Button : <Button Name>]

Width : <Required Width>

Example

[Button: TSPL Button]

Width : 10% Screen

In this example, the attribute Width is set to 10% Screen, which means the TSPL Button will occupy 10% of the total screen width. This helps control the button’s size relative to the screen, ensuring consistent layout across different display sizes.