DataTransferItem.getAsString()

This article needs a technical review. How you can help.

The DataTransferItem.getAsString() method invokes the given callback with the drag data item's string data as the argument if the item's kind is a Plain unicode string (i.e. kind is string).

SyntaxEdit

void dataTransferItem.getAsString(callback);

Arguments

FunctionStringCallback
A callback function that has access to the data transfer item's string data.

Return value

void
 

FunctionStringCallback

FunctionStringCallback is a callback function with the following argument:

DOMString
The drag data item's string data.

The FunctionStringCallback return value is void.

ExampleEdit

This example shows the use of the getAsString() method as an inline function in a drop event handler.

function drop_handler(ev) {
 console.log("Drop");
 ev.preventDefault();
 var data = event.dataTransfer.items;
 for (var i = 0; i < data.length; i += 1) {
   if ((data[i].kind == 'string') && (data[i].type.match('^text/plain'))) {
     // This item is the target node
     data[i].getAsString(function (s){
       ev.target.appendChild(document.getElementById(s)); 
     });
   } else if ((data[i].kind == 'string') && (data[i].type.match('^text/html'))) {
     // Drag data item is HTML
     console.log("... Drop: HTML");
   } else if ((data[i].kind == 'string') && (data[i].type.match('^text/uri-list'))) {
     // Drag data item is URI
     console.log("... Drop: URI");
   } else if ((data[i].kind == 'file') && (data[i].type.match('^image/'))) {
     // Drag data item is an image file
     var f = data[i].getAsFile();
     console.log("... Drop: File ");
   }
 }
}

SpecificationsEdit

Specification Status Comment
WHATWG HTML Living Standard
The definition of 'getAsString()' in that specification.
Living Standard  
HTML5.1
The definition of 'getAsString()' in that specification.
Working Draft Not included in W3C HTML5 Recommendation

Browser compatibilityEdit

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 4 No support No support 12 No support

See alsoEdit

Document Tags and Contributors

 Contributors to this page: rolfedh, AFBarstow
 Last updated by: rolfedh,