Prints the gift card's initial balance.

Kuvaus

The tag is used, for example, in the shopping cart or on the checkout pages before confirming the order, or in the template of a printable PDF gift card.

The tag only prints content if the customer has activated a gift card.

The sum printed by the tag doesn't take into account the orders that have been paid for with the gift card.

You can print the remaining amount on the gift card using the {GiftCardBalanceLeft} tag.

To print the gift card balance reserved for paying for the order, use the {GiftCardBalanceReserved} tag.

Syntaksi

{GiftCardBalance( exchanged: boolean, currencysymbol: boolean, decimals: int, decimalsep: string, thousandssep: string, html: boolean, price_format: string )}

Näkyvyys

Toimii näkyvyydessä: globaali

The tag is used in the {CartGiftCards} tag's helper attribute or in the gift card template.

The gift card template/themes/print/THEME/gift-card.html

Attribuutit

exchanged:

Determines whether the tag uses currency conversion if the customer has placed an order in a currency other than the euro.

The exchanged attribute only works when the Currency Converter extension is in use.

This attribute works only after the customer has placed an order. So, you can use the attribute in order templates and e.g. inside the order products' tags.

Allowed values: true/false. The default value is false.

With the value false, the content is always printed as euros.

currencysymbol:

Determines whether the tag also prints the currency symbol. The symbol is automatically determined based on the currency in use.

Allowed values: true/false. The default value is false.

The currency symbol can also be printed using the {CurrencySymbol} tag.

decimals:

Sets the precision for printing decimals.

Allowed values: integers. Default value 2 decimal places.

decimalsep:

Defines the decimal separator character. The most popular decimal separators are comma and dot, the use of which depends on the store's locale.

Sallitut arvot: merkki, joka toimii desimaalierottimena (esim. desimaalipiste = decimalsep: '.'). Oletusarvo pilkku.
thousandssep:

Specifies the character used as the thousands separator.

According to the International System of Units, the thousand separator is a space, but in different countries, a period, comma, or apostrophe may traditionally be used. You may want to define thousands separators according to the locale.

Allowed values: a symbol that functions as a thousands separator. The default is a non-breaking space  

If you want to use an apostrophe as the thousands separator, write it between double quotes: thousandssep: "'"

If you do not want to use any thousands separator, just write two quotation marks or two apostrophes in a row in the attribute: thousandssep: "" or thousandssep: ''

html:

Determines whether the tag outputs the default HTML markup around the content.

Allowed values: true / false

price_format:

Determines the price information display format.

Sallitut arvot:
  • string (default): The price information is printed as a string, which may also include formatting and additions dependent on other attributes of the tag (e.g., currency symbol).
  • decimal: The price information is printed as a decimal number using a decimal point (e.g., 9.90), which works in, among other things, JavaScript code.

    If price_format: 'decimal' is in use, other price information formatting attributes do not affect the tag's output.

before/after:

With the before and after attributes, you can define content that is output before or after the content produced by the tag.

Allowed values: text that may contain HTML and Interface markup.

E.g.

  • before: '<p>This markup appears before the tag's own content.</p>'.
  • after: '<p>This appears after the tag's own content.</p>'

If the tag does not produce any content, the content of the before and after attributes will also not be displayed.

escape:

Adds an escape character before quotation marks in the output. The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values: true/false. The default value is false.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values: text that may contain HTML and Interface markup.

E.g. or:'Content not found.'