Manifiesto de gadget de Sidebar

Manifiesto de gadget de Sidebar

2006

Publicado: 26 de Enero de 2007
En esta página

Introducción Introducción
Ejemplo de Gadget.xml  Ejemplo de Gadget.xml
Elementos definidos en el ejemplo de Gadget.xml Elementos definidos en el ejemplo de Gadget.xml

Introducción

El manifiesto de gadget de Windows Sidebar es un archivo XML que contiene la configuración de los gadgets e instrucciones de presentación para Windows Sidebar. Cada gadget requiere su propio manifiesto. El nombre de archivo del manifiesto siempre es gadget.xml.

Este tema contiene un archivo gadget.xml de ejemplo que incluye los elementos necesarios y opcionales, seguidos de las definiciones de estos elementos.

Ejemplo de Gadget.xml

En este ejemplo se muestran los datos y la estructura de un archivo gadget.xml válido.

<?xml version="1.0" encoding="utf-8" ?>
<gadget>
    <name>Hello World!</name>
    <namespace>Example.You</namespace>
    <version>1.0</version>
    <author name="Your Name">
        <info url="http://www.example.com" />
        <logo src="logo.png"/>
    </author>
    <copyright>&#169; 2006</copyright>
    <description>My first gadget</description>
    <icons>
        <icon height="48" width="48" src="icon.png" />
    </icons>
    <hosts>
        <host name="sidebar">
            <base type="HTML" src="HelloWorld.html" />
            <permissions>full</permissions>
            <platform minPlatformVersion="1.0" />
            <defaultImage src="drag.png" />
        </host>
    </hosts>
</gadget>

Elementos definidos en el ejemplo de Gadget.xml

En esta sección se definen los elementos que hay en el ejemplo de gadget.xml.

Elemento <xml>

<?xml version encoding ?>

Required.

Atributos:

  • Version. El valor esperado es 1.0.

  • Encoding. El valor esperado es UTF-8.

Elemento <gadget>

<gadget>

Required. El elemento <gadget> contiene los elementos secundarios que definen el gadget. No tiene atributos.

Elementos secundarios de <gadget> necesarios:

  • <name>

  • <version>

  • <hosts>

Elementos secundarios de <gadget> opcionales:

  • <namespace>

  • <author>

  • <copyright>

  • <description>

  • <icons>

Elemento <name>

<name>

Required. El elemento <name> contiene un valor de cadena que define el nombre descriptivo del gadget que se muestra en la Galería de gadgets, en la página Windows Sidebar del panel de control y en la ventana Sidebar del escritorio.

Primario: <gadget>.

Elemento <namespace>

<namespace>

Opcional. El elemento <namespace> está reservado para un futuro uso.

Primario: <gadget>.

Elemento <version>

<versión>

Necesario. El elemento <version> define la versión del gadget. Sidebar usa este valor durante la instalación del gadget. Si ya hay instalado otro gadget con el mismo nombre, Sidebar compara las versiones. Si las versiones difieren, se pide al usuario que seleccione la versión adecuada.

Las cadenas válidas para version son del tipo major.minor. Cada una de estas subcadenas contiene de 0 a 4 números entre 0 y 9, ambos incluidos.

Primario: <gadget>.

Elemento <author>

<nombre del autor>

Optional. El elemento <author> proporciona información específica del autor.

Atributo:

  • Name. Nombre del autor del gadget.

Elementos secundarios:

  • Info. Optional. Consulte el elemento <info>.

  • Logo. Optional. Consulte el elemento <logo>.

Primario: <gadget>.

Elemento <info>

<info url>

Optional.

Atributo:

  • Url. Hipervínculo a un sitio especificado por el autor.

Primario: <author>.

Elemento <logo>

<logo src>

Optional. El elemento <logo> especifica un gráfico asociado al autor.

Atributo:

  • Src. Define el archivo gráfico que se mostrará junto al nombre del autor en el área de detalles ampliados de la Galería de gadgets.

Primario: <author>.

Elemento <copyright>

<copyright>

Optional. El elemento <copyright> se muestra al usuario en diferentes lugares. Puede contener cualquier cadena de caracteres.

Primario: <gadget>.

Elemento <description>

<description>

Optional. El valor del elemento <description> se muestra al usuario en el cuadro de diálogo de la galería de gadgets.

Elemento <icons>

<icons>

Elemento secundario:

  • Icon. Optional. Consulte el elemento <icon>.

Primario: <gadget>.

Elemento <icon>

<icon height width src>

Optional. Un manifiesto de gadget puede contener cualquier número de elementos <icon>.

El elemento <icon> define el tamaño y el archivo gráfico de un único icono.

Atributos:

  • Height. Número entero que especifica el alto, en píxeles, del archivo gráfico del icono.

  • Width. Número entero que especifica el ancho, en píxeles, del archivo gráfico del icono.

  • Src. Required. Nombre del archivo gráfico que se mostrará como un icono. El archivo gráfico puede ser cualquier archivo admitido por GDI+ 1.0.

Nota

Se puede especificar un archivo gráfico de cualquier tamaño. Sin embargo, Sidebar usará un icono de un tamaño parecido al que se requiere para un fin determinado.

Primario: <icons>.

Elemento <hosts>

<hosts>

Required. El elemento <hosts> es un contenedor de uno o varios elementos <host name>.

Elemento secundario:

  • <host name>. Required. Consulte el elemento <host>.

Primario: <gadgets>.

Elemento <host>

<host name>

Required. El elemento <host> identifica la aplicación que aloja el gadget. Sus elementos secundarios definen el comportamiento del gadget para una aplicación host específica.

Atributo:

  • Name. El valor esperado es "sidebar".

Elementos secundarios necesarios:

  • Base. Consulte el elemento <base>.

  • Permissions. Consulte el elemento <permisos>.

  • Platform. Consulte el elemento <platform>.

Elemento secundario opcional:

  • DefaultImage. Vea el elemento <defaultImage>.

Primario: <hosts>.

Elemento <base>

<base type src>

Required. El elemento <base> proporciona a Sidebar un tipo de archivo de gadget e información acerca de la versión de la API necesarios para ejecutar el gadget.

Atributos:

  • Type. El valor esperado es "HTML".

  • Src. Especifica el archivo que Windows Sidebar debe cargar para ejecutar el gadget.

Primario: <host>.

Elemento <permissions>

<permissions>

Required. El valor esperado es "Full".

Primario: <host>.

Elemento <platform>

<platform minPlatformVersion>

Required. El elemento <platform> especifica la versión mínima de Windows Sidebar necesaria para ejecutar el gadget.

Atributo:

  • MinPlatformVersion. Required. El valor esperado es "1.0".

Primario: <host>.

Elemento <defaultImage>

<defaultImage src>

Optional.

Atributo:

  • Src. El valor es el nombre de un archivo gráfico que se mostrará cuando el usuario arrastre el gadget desde la galería de gadgets, antes de crear una instancia del mismo.

Primario: <host>.

Mostrar:
© 2016 Microsoft