balloonUI element

Article
02/27/2023

The optional balloonUI element is used to display a message balloon on the client computer.

The balloonUI element is defined in the asyncui namespace at this URI:

https://schemas.microsoft.com/2003/print/asyncui/v1/request

This resource may not be available in some languages and countries.

Usage

<balloonUI
  iconID = "xs:string"
  resourceDll = "xs:string">
  child elements
</balloonUI>

Attributes

Attribute	Type	Required	Description
iconID	xs:string	No	An optional attribute that specifies a printer icon to display in the event notification message. The attribute value specifies the location of the icon in the resource DLL. The icon must be 32 x 32 pixels in size, with any color depth.
resourceDll	xs:string	No	An optional attribute that specifies a resource DLL that contains the printer icon to display in the event notification message. This DLL should be a dependent file of the printer driver and must be present in the driver resource folder (for example, %SYSTEMROOT%\system32\spool\drivers\w32x86\3).

Child elements

Element	Description
body	A required element that provides text that is displayed in the event notification message. This text should provide the user specific details about the printer event.
title	A required element that provides text that is displayed in the title of the event notification message.

Parent elements

Element	Description
requestOpen	An element that is used to open an event notification message on the client computer.

Remarks

If the attributes iconID and resourceDll are not specified, a generic printer icon is displayed in the balloon message. To display a custom printer icon, specify values for both attributes.

Examples

The following code example shows how to use an interactive balloon to pass CDATA type data to a DLL.

<?xml version="1.0" ?> 
  <asyncPrintUIRequest xmlns="https://schemas.microsoft.com/2003/print/asyncui/v1/request">
    <v1>
      <requestOpen>
        <balloonUI iconID="1" resourceDll="IHV.dll">
          <title stringID="1234" resourceDll="IHV.dll" />
          <body stringID="100" resourceDll="IHV.dll">
            <parameter stringID="<5>" />
            <parameter stringID="1002" resourceDll="IHV.dll" />
          </body>
          <action dll="adc.dll" entrypoint="def" />
            IHV Data to pass into dll
            MUST BE CDATA
          </action>
        </balloonUI>
      </requestOpen>
    </v1>
  </asyncPrintUIRequest>