String.format (Función)
Actualización: noviembre 2007
Reemplaza los elementos de formato de un objeto String por el equivalente textual del valor de un objeto correspondiente.
var s = String.format(format, args);
Arguments
format
Cadena de formato.args
Matriz de objetos a la que se va a dar formato.
Valor devuelto
Copia de la cadena con el formato aplicado.
Excepciones
Tipo de excepción |
Condition |
|---|---|
(Depuración) Falta una llave de apertura o cierre en format. |
Comentarios
Utilice la función format para reemplazar los elementos de formato especificados por la representación textual de los valores de objeto correspondientes. El argumento args puede contener un objeto único o una matriz de objetos. El argumento format contiene cero o más instancias de texto fijo entremezcladas con uno o varios elementos de formato. Cada elemento de formato corresponde a un objeto de objects. En tiempo de ejecución, cada elemento de formato se sustituye por la representación en forma de cadena del objeto correspondiente de la lista.
Los elementos de formato constan de un número incluido entre llaves, como {0}, que identifica el elemento correspondiente en la lista objects. La numeración empieza por cero. Para especificar una única llave literal en el formato, hay que escribir dos llaves iniciales o dos llaves finales, es decir, "{{" o "}}". No se admiten llaves anidadas.
Especificar una rutina de formato personalizada
Puede especificar una rutina de formato personalizada para un elemento de formato proporcionando un objeto de formato especial que tenga un método toFormattedString en el argumento args. El método toFormattedString debe aceptar un argumento de cadena y devolver una cadena. En tiempo de ejecución, la función format pasa cada cadena entre llaves de su especificador de parámetro correspondiente al método toFormattedStrings. La cadena devuelta por el método toFormattedString se inserta en la cadena con formato en la ubicación del especificador de parámetro correspondiente.
Ejemplo
En el ejemplo siguiente se muestra cómo utilizar la función format para reemplazar elementos de formato especificados por la representación textual de los valores de objeto correspondientes. El código incluye un ejemplo de un objeto de formato personalizado que tiene un método toFormattedString.
// Define an class with a custom toFormattedString
// formatting routine.
Type.registerNamespace('Samples');
Samples.ToFormattedStringExample = function() {
}
Samples.ToFormattedStringExample.prototype = {
toFormattedString: function(format) {
return "This was custom formatted: " + format;
}
}
Samples.ToFormattedStringExample.registerClass('Samples.ToFormattedStringExample');
var result = "";
// Format a string.
result = String.format("{0:d}", 123);
// Displays: "123"
alert(result);
// Format a string with an object that has
// a custom toFormattedString method.
var o = new Samples.ToFormattedStringExample();
result = String.format("{0:12345}", o);
// Displays: "This was custom formatted: 12345"
alert(result);