CurrencyFormatter  - AS3

Namnet på det faktiska språk-ID som används av det här CurrencyFormatter-objektet.

Det finns tre möjliga värden för namnet, beroende på operativsystemet och värdet på den requestedLocaleIDName-parameter som skickas till CurrencyFormatter()-konstruktorn.

1. Om det begärda språket inte var LocaleID.DEFAULT, och operativsystemet har stöd för det begärda språket, är det namn som returneras samma som egenskapen requestedLocaleIDName.
2. Om LocaleID.DEFAULT användes som värdet för parametern requestedLocaleIDName till konstruktorn, används det namn för det aktuella språket som specificeras av användarens operativsystem. Värdet LocaleID.DEFAULT bevarar användarens anpassade inställningar i operativsystemet. Om du skickar ett uttryckligt värde som requestedLocaleIDName-parameter ger det inte nödvändigtvis samma resultat som när du använder LocaleID.DEFAULT, även om de båda språknamnen är samma. Användaren kan ha anpassat språkinställningarna på datorn, och om du begär ett uttryckligt språk-ID i stället för att använda LocaleID.DEFAULT hämtar ditt program inte dessa anpassade inställningar.
3. Om systemet saknar stöd för det requestedLocaleIDName som anges i konstruktorn används ett reservspråk-ID i stället.

Relaterade API-element

En ISO 4217-valutakod med tre tecken för det språk som faktiskt används.

Den här koden används för att fastställa valutasymbolen eller valutasträngen vid formatering av valutabelopp med metoden format() och med parametern withCurrencySymbol inställd på false.

Den här egenskapen initieras av konstruktorn baserat på det språk som faktiskt används. När ett reservspråk används speglar den här egenskapen den önskade standardvalutakoden för reservspråket.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Valutasymbolen eller -strängen för det språk som faktiskt används.

Den här egenskapen används som valutasymbol vid formatering av valutabelopp med metoden format() och med parametern withCurrencySymbol inställd på true.

Den här egenskapen initieras av konstruktorn baserat på det språk som faktiskt används. När ett reservspråk används speglar den här egenskapen den önskade standardvalutasymbolen för reservspråket.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Den decimalavgränsare som används för att formatera eller tolka valutabelopp med decimaler.

Den här egenskapen ställs först in baserat på det språk som är valt när formateringsobjektet skapas.

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Definierar den sifferuppsättning som ska användas för att formatera valutabelopp.

Olika språk och regioner använder olika teckenuppsättningar för att representera siffrorna 0 till 9. Den här egenskapen definierar den sifferuppsättning som ska användas

Värdet på den här egenskapen representerar Unicode-värdet för siffran noll i en decimalsifferuppsättning. Giltiga värden för den här egenskapen definieras i klassen NationalDigitsType.

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Det största antal siffror som kan visas efter decimaltecknet.

Talen avrundas till det antal siffror som anges av den här egenskapen. Avrundningsschemat varierar beroende på användarens operativsystem.

När egenskapen trailingZeros är true fylls talets bråkdel (efter decimaltecknet) ut med nollor tills längden matchar värdet för den här fractionalDigits-egenskapen.

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är 0.

Relaterade API-element

Beskriver placeringen för grupperingsavgränsare i den formaterade valutabeloppsträngen.

När egenskapen useGrouping är true används egenskapen groupingPattern för att definiera den placering och det mönster som används för grupperingsavgränsaren.

Grupperingsmönstret definieras som en sträng med tal, som avgränsas med semikolon och som kan avslutas med en asterisk. Till exempel: "3;2;*". Varje tal i strängen representerar antalet siffror i en grupp. Grupperingsavgränsaren placeras före varje siffergrupp. En asterisk i slutet av strängen anger att grupper med det antalet siffror ska upprepas i resten av den formaterade strängen. Om det inte finns någon asterisk finns inga ytterligare grupper eller avgränsare för resten av den formaterade strängen.

Det första talet i strängen motsvarar den första gruppen med siffror till vänster om decimaltecknet. Efterföljande tal definierar antalet siffror i efterföljande grupper till vänster. Strängen "3;2;*" anger alltså att en grupperingsavgränsare placeras efter den första gruppen med tre siffror, följt av grupper med två siffror. Till exempel: 98,76,54,321

Följande tabell innehåller exempel på hur valutabeloppet 123456789.12 kan formateras med olika grupperingsmönster. Grupperingsavgränsaren är ett komma, decimaltecknet är en punkt och valutasymbolen är ett dollartecken ($).

Du kan bara definiera ett begränsat antal grupperingsstorlekar. På vissa operativsystem kan grupperingsmönster bara innehålla två tal plus en asterisk. Andra operativsystem kan ha stöd för fyra tal och en asterisk. För mönster utan någon asterisk har vissa operativsystem bara stöd för ett tal, medan andra har stöd för upp till tre. Om det största tillåtna antalet element för grupperingsmönstret överskrids, ignoreras ytterligare element och egenskapen lastOperationStatus ställs in enligt nedanstående.

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Relaterade API-element

Det tecken eller den sträng som används för grupperingsavgränsaren.

Värdet på den här egenskapen används som grupperingsavgränsare vid formatering av valutabelopp när egenskapen useGrouping är inställd på true. Den här egenskapen ställs först in baserat på det språk som är valt när formateringsobjektet skapas.

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Status för den senaste åtgärden som detta CurrencyFormatter-objekt har utfört. Egenskapen lastOperationStatus anges när konstruktorn eller en metod för den här klassen anropas eller när en annan egenskap anges. Beskrivningarna av de olika metoderna innehåller information om möjliga värden.

Relaterade API-element

Anger om en inledande nolla inkluderas i ett formaterat valutabelopp när det inte finns några heltalssiffror till vänster om decimaltecknet.

När den här egenskapen är true inkluderas en inledande nolla till vänster om decimaltecknet vid formatering av numeriska värden mellan -1,0 och 1,0. När egenskapen är false inkluderas ingen inledande nolla.

Om valutabeloppet till exempel är 0,321, och den här egenskapen är true, inkluderas den inledande nollan i den formaterade strängen. Om egenskapen är false inkluderas ingen inledande nolla. I så fall innehåller strängen bara decimaltecknet följt av decimalerna, som i $.321.

Följande tabell innehåller exempel på hur valutabelopp formateras baserat på värdena för den här egenskapen och de relaterade egenskaperna fractionalDigits och trailingZeros.

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Ett numeriskt värde som anger ett formateringsmönster för negativa valutabelopp. Det här mönstret definierar placeringen av valutasymbolen och den negativa symbolen eller parentesen i förhållande till den numeriska delen av valutabeloppet.

Värdet för den här egenskapen måste vara en av de konstanter som definieras i tabellen nedan.

I tabellen nedan sammanfattas möjliga formateringsmönster för negativa valutabelopp. När ett valutabelopp formateras med metoden format():

• Symbolen '¤' ersätts med värdet för egenskapen currencyISOCode eller currencySymbol, beroende på värdet för den withCurrencySymbol-parameter som skickas till metoden format();
• Tecknet '-' ersätts med värdet på egenskapen negativeNumberSymbol;
• Tecknet 'n' ersätts med det valutabelopp som skickas till metoden format().

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Den negativa symbol som används vid formatering av negativa valutabelopp.

Den här symbolen används med negativa valutaformat vid formatering av valutabelopp som är mindre än noll. Det används inte i format för negativa valutabelopp som inte innehåller ett negativt tecken (t.ex. när negativa valutabelopp står inom parentes).

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Ett numeriskt värde som anger ett formateringsmönster för positiva valutabelopp. Det här formatet definierar placeringen av valutasymbolen i förhållande till den numeriska delen av valutabeloppet.

Värdet för den här egenskapen måste vara en av de konstanter som definieras i tabellen nedan.

I tabellen nedan sammanfattas möjliga formateringsmönster för positiva valutabelopp. När ett valutabelopp formateras med metoden format():

• Symbolen '¤' ersätts med värdet för egenskapen currencyISOCode eller currencySymbol, beroende på värdet för den withCurrencySymbol-parameter som skickas till metoden format();
• Tecknet 'n' ersätts med det valutabelopp som skickas till metoden format().

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Namnet på det begärda språk-ID som skickades till konstruktorn för det här CurrencyFormatter-objektet.

Om värdet LocaleID.DEFAULT användes returneras namnet "i-default". Det språk som faktiskt används kan skilja sig från det begärda språket när ett reservspråk används. Namnet på det faktiska språket kan hämtas med egenskapen actualLocaleIDName.

Relaterade API-element

Anger om efterföljande nollor ska inkluderas i det formaterade valutabeloppet.

När den här egenskapen är true inkluderas efterföljande nollor i det formaterade talets bråkdel, upp till den gräns som anges av egenskapen fractionalDigits. När den här egenskapen är false visas inga efterföljande nollor.

Om valutabeloppet till exempel är 123.4, och den här egenskapen är true och egenskapen fractionalDigits är 3, innehåller den formaterade strängen efterföljande nollor, som i $123.400. Om den här egenskapen är false inkluderas inga efterföljande nollor och strängen visar bara decimaltecknet följt av de decimaler som inte är nollor, som i $123,4.

Följande tabell innehåller exempel på hur valutabelopp formateras baserat på värdena för den här egenskapen och de relaterade egenskaperna fractionalDigits och leadingZero.

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Standardvärdet är dependent on the actual locale and operating system.

Relaterade API-element

Medger användning av grupperingsavgränsare vid formatering av valutabelopp.

När egenskapen useGrouping är true grupperas siffror och avgränsas med tecknet för grupperingsavgränsaren. Exempel: $123,456,789

När egenskapen useGrouping är false varken grupperas eller avgränsas siffror. Exempel: $123456789

Egenskapen groupingSeparatoranvänds för att definiera symbolen som ska användas som en grupperingsavgränsare. Egenskapen groupingPattern definierar antalet siffror mellan grupperingsavgränsarna.

När den här egenskapen tilldelas ett värde, och det inte visas några varningar eller fel, ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Relaterade API-element

Skapar ett nytt CurrencyFormatter-objekt för att formatera tal som representerar valutabelopp i enlighet med reglerna för ett visst språk.

Den här konstruktorn avgör om det aktuella operativsystemet har stöd för det begärda språk-ID:t. Om det inte stöds används ett reservspråk i stället. Om ett reservspråk används visar egenskapen lastOperationStatus dess typ, och egenskapen actualLocaleIDName innehåller namnet på reservspråkets-ID:t.

Vissa egenskaper, som currencySymbol och currencyISOCode, ställs in automatiskt utifrån språket.

Obs! När ett reservspråk används får valutaegenskaperna standardvärden, och därför kan egenskapen currencySymbol eller currencyISOCode få oväntade värden. Det är alltid bra att kontrollera värdena för egenskaperna currencySymbol och currencyISOCode innan valutabeloppet formateras.

Om formateringen ska ske baserat på användarens aktuella operativsysteminställningar skickar du värdet LocaleID.DEFAULT i parametern requestedLocaleIDName till konstruktorn.

När konstruktorn anropas och slutförs felfritt ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

När det begärda språk-ID:t inte är tillgängligt ställs lastOperationStatus in på något av följande:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Mer information om de varningsmeddelanden som visas ovan och andra möjliga värden för egenskapen lastOperationStatus finns i beskrivningarna för klassen LastOperationStatus.

Relaterade API-element

Skapar en sträng som representerar ett valutabelopp som formateras i enlighet med de aktuella egenskaperna för det här CurrencyFormatter-objektet, bl.a. språk, valutasymbol och valutans ISO-kod.

Som standard använder den här metoden egenskapen currencyISOCode för att fastställa valutasymbolen och andra inställningar vid formatering.

Många länder och regioner använder samma valutasymbol för flera olika valutor. USA, Australien, Nya Zeeland, Kanada och Mexiko använder till exempel alla samma dollarsymbol ($) för sina lokala valutavärden. När formateringsvalutan skiljer sig från användarens lokala valuta är det bäst att använda ISO-koden som valutasträng. Du kan använda metoden formattingWithCurrencySymbolIsSafe() för att testa om ISO-koden för den valuta som ska formateras matchar egenskapen currencyISOCode i formateraren.

Den här metoden kan användas för att formatera både mycket stora och mycket små tal. Antalet värdesiffror är dock begränsat till den noggrannhet som anges i datatypen Number.

Parametrar

Relaterade API-element

 
         var cf:CurrencyFormatter = new CurrencyFormatter("fr-CA");  
         
         trace(cf.actualLocaleIDName);               // "fr-CA"  
         trace(cf.currencyISOCode);                // "CAD"
         trace(cf.currencySymbol);                // "$"
         
         trace(cf.format(1254.56));                // "1 254,56 CAD"
         trace(cf.format(1254.56, true));            // "1 254,56 $"
         

 
         var cf:CurrencyFormatter = new CurrencyFormatter(LocaleID.DEFAULT);  
         
         if (cf.formattingWithCurrencySymbolIsSafe("CAD")) {
           trace(cf.actualLocaleIDName);     // "fr-CA French (Canada)"
           trace(cf.format(1254.56, false)); // "1 254,56 $"
         }
         else {
           trace(cf.actualLocaleIDName);     // "en-US English (USA)"
           cf.setCurrency("CAD", "C$")
           trace(cf.format(1254.56, true));  // "C$ 1,254.56"
         }
         

Avgör om den för tillfället angivna valutasymbolen kan användas vid formatering av valutabelopp.

Många länder och regioner använder samma valutasymboler. Den här metoden kan användas för att undvika tvetydiga valutasymboler och oväntade valutasymboler eller ISO-koder (på grund av att ett reservspråk används).

Ett vanligt sätt att använda den här metoden är för att fastställa om en lokal valutasymbol ska visas (om beloppet ska formateras enligt användarens standardvaluta) eller en mer specifik ISO-kod (om beloppet är formaterat med en annan valuta än användarens standardvaluta).

Den här metoden jämför parametern requestedISOCode med den aktuella currencyISOCode-egenskapen och returnerar true om strängarna är lika och false om de inte är det. Om strängarna är lika, och metoden format() används med parametern withCurrencySymbol inställd på true, resulterar detta i en formaterad valutasträng med en valutasymbol som är unik för språket. Om den här metoden returnerar värdet false kan metoden format() med parametern withCurrencySymbol inställd på true resultera i att en tvetydig eller felaktig valutasymbol används.

När den här metoden anropas och slutförs felfritt ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Parametrar

Relaterade API-element

Visar alla språk-ID:n som stöds i den här klassen.

Om den här klassen inte stöds på det aktuella operativsystemet returnerar metoden värdet null.

När den här metoden anropas och slutförs felfritt ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Tolkar en sträng till ett valutabelopp och en valutasymbol.

Tolkningsalgoritmen använder värdet på egenskapen decimalSeparator för att fastställa heltalsdelen och bråkdelen av talet. Värdena på egenskaperna negativeCurrencyFormat och positiveCurrencyFormat används för att fastställa valutasymbolens eller -strängens placering i förhållande till valutabeloppet. För negativa belopp avgör värdet på egenskapen negativeCurrencyFormat den negativa symbolens placering och om parenteser ska användas.

Om ordningen på valutasymbolen, minustecknet och talet i indatasträngen inte matchar det mönster som anges i egenskaperna negativeCurrencyFormat och positiveCurrencyFormat sker följande:

1. Egenskapen value för det returnerade CurrencyParseResult-objektet ställs in på NaN.
2. Egenskapen currencyString för det returnerade CurrencyParseResult-objektet ställs in på null.
3. Egenskapen lastOperationStatus ställs in för att ange att tolkningen misslyckades.

Indatasträngen kan innehålla mellanslagstecken, som ignoreras under tolkningen.

Tolkningen kan lyckas även om en valutasymbol saknas. Den del av strängen som motsvarar valutasymbolen kontrolleras inte. Om det inte finns någon valutasymbol eller -sträng ställs egenskapen currencyString i det returnerade CurrencyParseResult-objektet in på en tom sträng.

När den här metoden anropas och slutförs felfritt ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ställs egenskapen lastOperationStatus in på en av de konstanter som definieras i klassen LastOperationStatus.

Parametrar

Relaterade API-element

Anger egenskaperna currencyISOCode och currencySymbol för CurrencyFormatter-objektet.

När den här metoden anropas och slutförs felfritt ställs egenskapen lastOperationStatus in på:

• LastOperationStatus.NO_ERROR

I annat fall ändras egenskaperna currencyISOCode och currencySymbol inte, och egenskapen lastOperationStatus ställs in på en av de konstanter som definieras i klassen LastOperationStatus.

Parametrar

Relaterade API-element

I det här exemplet används följande språk:

• Operativsystemets standardspråk för valutaformatering (LocaleID.DEFAULT)
• Japanska (Japan)
• Engelska (USA)
• Franska (Frankrike)

I exemplet utförs följande för varje språk i listan:

1. Skapar ett CurrencyFormatter-objekt.
2. Använder metoden formattingWithCurrencySymbolIsSafe() för att kontrollera om standardvalutan för språket är Euro ("EUR") och om det är fallet formateras strängen med valutasymbolen. I annat fall formateras strängen med ISO-koden.

  
package {
    import flash.display.Sprite;
    import flash.globalization.CurrencyFormatter;
    import flash.globalization.LocaleID;
    
    public class CurrencyFormatterExample1 extends Sprite
    {
        public function CurrencyFormatterExample1():void
        {
            var cf:CurrencyFormatter;
            var amountWithSymbol:String;
            var amountWithISOCode:String
            
            var localeNames:Array = [LocaleID.DEFAULT, "ja-JP", "en-US", "fr-FR"];
            
            for each (var localeName:String in localeNames) 
            {
                cf = new CurrencyFormatter(localeName);
                
                trace('\n' + "LocaleID requested=" + cf.requestedLocaleIDName 
                    + "; actual=" + cf.actualLocaleIDName);
                
                trace("Last Operation Status: " + cf.lastOperationStatus );
                
                trace("Currency ISO Code: " + cf.currencyISOCode);
                
                if (cf.formattingWithCurrencySymbolIsSafe("EUR")) 
                {
                    amountWithSymbol = cf.format(123456789.19, true);
                    trace("Format using Symbol: "+ amountWithSymbol);
                }
                else 
                {
                    amountWithISOCode = cf.format(123456789.19); 
                    trace("Format using ISO Code: " + amountWithISOCode);
                }
            }
        }
    }
}

Följande steg utförs i det här exemplet:

1. Skapar ett CurrencyFormatter-objekt för språket engelska (USA).
2. Använder metoden parse() för att tolka indatasträngen.
3. Visar beloppet och valutasträngsvärdena från det resulterande CurrencyParseResult-objektet.

 
package {
      import flash.display.Sprite;
      import flash.globalization.CurrencyFormatter;
      import flash.globalization.CurrencyParseResult;
      import flash.globalization.LastOperationStatus;
      import flash.globalization.LocaleID;

      public class CurrencyFormatterParseExample extends Sprite
      {
            public function CurrencyFormatterParseExample()
            {
                var cf:CurrencyFormatter = new CurrencyFormatter( "en_US" );
                
                trace("LocaleID requested=" + cf.requestedLocaleIDName 
                    + "; actual=" + cf.actualLocaleIDName);
                trace("Last Operation Status: " + cf.lastOperationStatus );

                var inputString:String = "Dollar 123,567,89,0.254";
                
                var result:CurrencyParseResult = cf.parse(inputString);
                
                if (cf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Amount value: " + result.value); 
                    trace("Currency string: " + result.currencyString); 
                }
            }
      }
}