Clipboard  - AS3

En matris med strängar med namnen på de dataformat som är tillgängliga i det här Clipboard-objektet.

Strängkonstanter för namn på standardformat definieras i ClipboardFormats-klassen. Andra programdefinierade strängar kan också användas som formatnamn för överföringsdata som ett objekt.

Relaterade API-element

 var availableFormats:Array = Clipboard.generalClipboard.formats;

Operativsystemets Urklipp.

Alla data som klistras in i systemets Urklipp är tillgängliga för andra program. Detta kan även omfatta osäker fjärrkod i en webbläsare.

Obs! I Flash Player 10-program, kräver en inklistringsåtgärd från Urklipp först en användarhändelse (som ett kortkommando för kommandot Klistra in eller en musklickning på kommandot Klistra in i en snabbmeny). Clipboard.getData() returnerar bara innehållet i Urklipp om InteractiveObject har tagits emot och används i en inklistringshändelse. Det går inte att anropa Clipboard.getData() under andra omständigheter. Samma begränsning gäller i AIR för innehåll som finns utanför programsandlådan.

generalClipboard-objektet skapas automatiskt. Du kan inte tilldela den här egenskapen en annan instans av ett urklipp. I stället kan du använda metoderna getData() och setData() för att läsa och skriva data till det befintliga objektet.

Du bör alltid rensa Urklipp innan du skriver nya data dit för att säkerställa att gamla data i alla format tas bort.

Ett generalClipboard-objekt kan inte skickas till NativeDragManager i AIR. Skapa ett nytt Clipboard-objekt för inbyggda dra och släpp-åtgärder i ett AIR-program.

 import flash.desktop.ClipboardFormats;
 
 var copy:String = "A string to copy to the system clipboard.";
 Clipboard.generalClipboard.clear();
 Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, copy);

 import flash.desktop.ClipboardFormats;
 
 var pasteData:String  = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;

Visar om urklippsformatet för fillöftet stöds på klientsystemet.

Skapar ett tomt Clipboard-objekt.

Skapa Clipboard-objekt för data från en inbyggd dra och släpp-gest i Adobe AIR. Ett Clipboard-objekt kan bara användas för en enda dra och släpp-gest. Du kan inte återanvända det.

Skapa inte Clipboard-objekt för kopierings- och inklistringsåtgärder. Använd då ett Clipboard.generalClipboard-objekt i stället.

Relaterade API-element

 import flash.desktop.Clipboard;
 
 var clipboard:Clipboard = new Clipboard();

Tar bort alla datarepresentationer från det här Clipboard-objektet.

 Clipboard.generalClipboard.clear();

Tar bort datarepresentationen för det angivna formatet.

Parametrar

 import flash.desktop.ClipboardFormats;
 
 Clipboard.generalClipboard.clearData(ClipboardFormats.TEXT_FORMAT);

Hämtar urklippsdata, om det finns data i det angivna formatet.

För Flash Player krävs att getData() anropas i en paste-händelsehanterare. I AIR gäller den här begränsningen endast för innehåll utanför programsäkerhetssandlådan.

När ett standarddataformat läses returneras data som ett nytt objekt för motsvarande Flash-datatyp.

När ett programdefinierat dataformat läses avgör värdet på parametern transferMode om en referens till originalobjektet eller ett anonymt objekt med en serialiserad kopia av originalobjektet returneras. När läget originalPreferred eller clonePreferred har angetts returnerar Flash Player eller AIR den alternativa versionen om den önskade versionen inte är tillgänglig. När läget originalOnly eller cloneOnly har angetts returnerar Flash Player eller AIR null om den önskade versionen inte är tillgänglig.

Parametrar

Relaterade API-element

 import flash.desktop.ClipboardFormats;

 var pasteData:String = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;

Kontrollerar om det finns data i angivet format i det här Clipboard-objektet.

Använd konstanterna i ClipboardFormats-klassen om du vill referera till standardformatnamn.

Parametrar

Relaterade API-element

if(Clipboard.generalClipboard.hasFormat(ClipboardFormats.TEXT_FORMAT)){
    //do something 
}

Lägger till en representation av den information som ska överföras i det angivna dataformatet.

setData() kan anropas när som helst i programsandlådan i Adobe AIR. I andra kontext kan setData() bara anropas som svar på en användargenererad händelse, t.ex. en tangenttryckning eller ett musklick.

Olika representationer av samma information kan läggas till i Urklipp med olika format, vilket ökar möjligheten för andra komponenter och program att kunna använda den tillgängliga informationen. Du kan t.ex. lägga till en bild som bitmappsdata för bildredigeringsprogram, som en URL och som en kodad PNG-fil för överföring till det underliggande filsystemet.

Dataparametern måste ha rätt datatyp för det angivna formatet:

Anpassade formatnamn får inte börja på "air:" eller "flash:". För att förhindra namnkonflikter när du använder anpassade format kan du använda program-ID:t eller ett paketnamn som ett prefix för formatet, t.ex. ”com.exempel.programNamn.dataPaket”.

Vid överföring inom eller mellan program avgör parametern serializable om både en referens och en kopia är tillgängliga eller om bara en referens till ett objekt är tillgänglig. Ange serializable till true om du vill att både referensen och kopian av dataobjektet ska vara tillgängliga. Ange serializable till false om du vill att bara objektreferensen ska vara tillgänglig. Objektreferenser är bara giltiga inom det aktuella programmet. Det innebär, att om du anger serializable till false är data i det formatet inte tillgängliga för andra Flash Player- eller AIR-program. En komponent kan välja att hämta referensen eller kopian av objektet genom att ange lämpligt urklippsöverföringsläge när data för det formatet läses.

Obs! Standardformaten konverteras alltid till det ursprungliga formatet när data klistras in eller dras utanför ett program som stöds, så värdet på parametern serializable påverkar inte tillgängligheten för data i standardformat för icke-Flash-baserade program.

Om du vill fördröja dataåtergivningen för ett format använder du metoden setDataHandler() i stället. Om både setData()-metoden och setDataHandler()-metoden används för att lägga till en datarepresentation med samma formatnamn anropas hanterarfunktionen aldrig.

Obs! När du ställer in parametern format på ClipboardFormats.URL_FORMAT i Mac OS överförs bara en URL om den är giltig. I annat fall töms Clipboard-objektet (och anrop av getData() returnerar null).

Parametrar

Relaterade API-element

 import flash.desktop.ClipboardFormats;
 
 var htmlString:String = "<html><body>Body content</body></html>";
 Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, urlString);
 Clipboard.generalClipboard.setData(ClipboardFormats.HTML_FORMAT, urlString);

Lägger till en referens till en hanterarfunktion som producerar de data som ska överföras.

Använd en hanterarfunktion för att fördröja att data skapas eller återges tills de faktiskt begärs.

Hanterarfunktionen måste returnera rätt datatyp för det angivna formatet:

Hanterarfunktionen anropas bara när, och endast när, data i det angivna formatet läses. Tänk på att i en del fall anropar operativsystemet funktionen innan en släppning sker. Om du till exempel använder en hanterarfunktion för att tillhandahålla data för en fil som dras från ett AIR-program till filsystemet, anropar operativsystemet datahanterarfunktionen så snart dragningsgesten lämnar AIR-programmet. Detta ger oftast upphov till en oönskad paus när fildata hämtas eller skapas. Du kan använda en URLFilePromise för detta i stället.

Tänk på att underliggande data kan ändras mellan den tidpunkt då hanteraren läggs till och den tidpunkt då data läses, om inte programmet skyddar informationen på något sätt. De beteenden garanteras inte som kan uppstå om data i Urklipp som representeras av en hanterarfunktion läses mer än en gång. Urklipp kan returnera data som producerades vid det första funktionsanropet eller anropa funktionen på nytt. Förlita dig inte på något av beteendena.

setDataHandler() kan anropas när som helst i programsandlådan i Adobe AIR. I andra kontext kan setDataHandler() bara anropas som svar på en användargenererad händelse, t.ex. en tangenttryckning eller ett musklick.

Om du vill lägga till data direkt i det här Clipboard-objektet använder du setData()-metoden i stället. Om båda metoderna setData() och setDataHandler() anropas med samma formatnamn anropas aldrig hanterarfunktionen.

Obs! När du ställer in parametern format på ClipboardFormats.URL_FORMAT i Mac OS överförs bara en URL om hanterarfunktionen returnerar en giltig URL. I annat fall töms Clipboard-objektet (och anrop av getData() returnerar null).

Parametrar

Relaterade API-element

 import flash.desktop.ClipboardFormats;
 
 Clipboard.generalClipboard.setDataHandler(ClipboardFormats.TEXT_FORMAT, randomNumberGenerator);

 public function randomNumberGenerator():String{
     return Math.random().toString();
 }

1. Skriv data (i det här fallet en sträng) till Clipboard.generalClipboard.
2. Läs innehållet i Urklipp från Clipboard.generalClipboard.

Obs! På grund av säkerhetsbegränsningar för åtkomst till urklippsdata fungerar inte det här exemplet i Flash Player. I Flash Player kan du bara anropa metoden getData() för urklippsobjektet i en paste-händelsehanterare.

package
{
    import flash.display.Sprite;
    import flash.desktop.Clipboard;
    import flash.desktop.ClipboardFormats;
    import flash.desktop.ClipboardTransferMode;

    public class ClipboardExample extends Sprite
    {
        public function ClipboardExample()
        {
            var sally:String = "Sally";
            var person:String;
            
            copy(sally);
            person = paste();
            trace(person); //traces: "Sally"
        }

        private function copy(text:String):void 
        {
            Clipboard.generalClipboard.clear();
            Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, text);
        }
        
        private function paste():String
        {
            if(Clipboard.generalClipboard.hasFormat(ClipboardFormats.TEXT_FORMAT))
            {
                return String(Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT));
            } 
            else 
            {
                return null;
            }
        }
        
    }
}