Client SDK for Windows Developers' Guide

Creating a Branding Text Layout File

The layout file format used to customize the session client is an UTF-8 XML text file. The layout schema is a top-level <pcoip-client-branding/> element with a version attribute describing the schema version, and containing the required elements described next:

<pcoip-client-branding version="1.0">
...
</pcoip-client-branding>

The available elements are outlined in the following table:

Parent Element	Child Element	Description
`<app-name>`		Required! The name of your custom session client. This will be used as the application window file.
`<app-icon>`		Required! The file name of your application icon. In Windows, this appears in the Windows toolbar and the window header.
`<toolbar-menu>`		Required! Describes the text labels used in OS toolbar menu's.
	`<about-item>`	The text label for the About... menu item. Optional. Without this field, there will not be an About menu item.
	`<quit-item>`	The text label for the Quit... menu item. Optional. Without this field, you will not have a Quit menu item.
`<about>`		Required! Describes the contents of the About... dialog. Must have the following required attributes: title (string): The dialog text and minWidth (number): The minimum pixel width of the dialog. For example: `<about title="My Custom Client" minWidth="100">`
	`<line>`	Describes a line of text in the dialog. All lines are optional, but the About window will be empty unless you provide at least one. `<line>` accepts the following attributes: align (string keyword): The text alignment; for example, "center". This alignment applies to all child elements of the line. Lines can be self-closed to create a blank line (). `<line>` can contain the following elements: `<logo>` contains a filename for a logo or other graphic element: `<logo>about_logo.png</logo>`. `<text>` contains the display text for each line: `<text>This text is displayed on the line. </text>`. `<hyperlink>` takes a url parameter and creates a working hyperlink: `<hyperlink url="www.teradici.com">Teradici</hyperlink>`.

A full text layout file looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<pcoip-client-branding version="1.0">
<app-name>My Custom Client</app-name>
<app-icon>app_icon.png</app-icon>
<toolbar-menu>
<about-item>About My Custom Client</about-item>
<quit-item>Quit My Custom Client</quit-item>
</toolbar-menu>
<about title="About My Custom Anyware Client" minWidth="0">
<line align="center"><logo>about_logo.jpg</logo></line>
<line />
<line align="center"><text>My Anyware Client</text></line>
<line align="center"><text>Version 0.0.0</text></line>
<line align="center"><text>© Copyright 2016 My
Corporation</text></line>
<line align="center">
<hyperlink url="www.my-company.com">My company</hyperlink>
</line>
<line />
<line align="center">
<text>For help, click here: </text>
<hyperlink url="www.google.com">Google</hyperlink>
</line>
</about>
</pcoip-client-branding>

Last updated: Thursday, July 18, 2024