Skip past navigation linksSecure Global Desktop 4.31 Administration Guide > Applets > Login applet parameters

Login applet parameters

Note The diagrams of the login applet's parameters may help you to understand the parameters described in this topic.

The login applet has the following parameters:

Parameter Type Default Description
AsadPort Integer No default

The TCP port the login applet uses to communicate with the Secure Global Desktop server.

Use the placeholder %%ASADPORT%% to let Secure Global Desktop supply the correct value for this parameter. You should only enter a particular value for this parameter (rather than the placeholder) if you're sure you know what you're doing.

This parameter has no default value. Communication with the Secure Global Desktop server is only possible if you supply a valid TCP port number (or use %%ASADPORT%%).

HintsBackgroundColor Color definition 192,192,192 (Grey)

The background color of the hints area.

HintsFontFamily Font family Browser dependent

The font used to display hints.

HintsFontSize Integer Browser dependent

The point size of the font used to display hints.

HintsFontStyle Style indicator plain

The style of font used to display hints.

HintsForegroundColor Color definition 0,0,0 (Black)

The color hints appear in.

HintsHeight Integer 0

The height of the hints area.

The hints area is used by Secure Global Desktop to display messages about the login process for the user.

The hints area is bottom-aligned within the applet area.

The setting 0 means Secure Global Desktop doesn't display hints to the user.

LoginButtonDownImage Graphic filename No graphic A graphics file to represent the button when it is clicked.
LoginButtonUpImage Graphic filename No graphic

A graphics file to represent the button in its unclicked (default) state.

If you don't specify this image, the login applet doesn't provide a login button.

If the login button overlaps MainImage or TitleImage, LoginButtonUpImage obscures these images.

LoginButtonX Integer 0

The gap between the login button's left edge and the title area's left side. The value 0 (the default) means the login button's left edge is aligned with the title area's left side.

LoginButtonY Integer 0

The gap between the top edge of the applet area and the top of the login button. The value 0 (the default) means the top of the login button is aligned with the title area's top edge.

MainImage Graphic filename No graphic

The background image that the login applet displays.

The login applet displays this image horizontally centered and top-aligned within the applet area. If you specify MainImageY, MainImage appears offset from the top of the applet area by this amount.

All other elements (captions and text boxes, for example) are displayed in front of MainImage, except for TitleImage.

MainImageY Integer 0

The gap between the background image MainImage and the top of the applet area.

NameCaptionCenterY Integer 0

The gap between the top edge of the applet area and the center of the username caption area. The value 0 (the default) means the center of the username caption area is aligned with the applet area's top edge.

The username caption area displays the text specified by NameCaptionText.

NameCaptionFontFamily Font family Browser dependent

The font used to display NameCaptionText.

NameCaptionFontSize Integer Browser dependent

The point size of the font used to display NameCaptionText.

NameCaptionFontStyle Style indicator plain

The style of font used to display NameCaptionText.

NameCaptionForegroundColor Color definition 0,0,0 (Black)

The color of NameCaptionText.

NameCaptionHorizontalAlignment Alignment indicator left

How NameCaptionText is aligned within the username caption area.

NameCaptionText String ""

The text displayed in the username caption area, for example, "Username".

NameCaptionWidth Integer 0

The width of the username caption area.

The username caption area doesn't clip NameCaptionText -- text is allowed to extend beyond the width of the username caption area. This setting is used to calculate the position of text when used with NameCaptionHorizontalAlignment values of center and right.

A value of 0 means the applet won't display NameCaptionText.

NameCaptionX Integer 0

The gap between the username caption area's left edge and the applet area's left side. The value 0 (the default) means the username caption area's left edge is aligned with the applet area's left side.

The username caption area displays the text specified by NameCaptionText.

NameEditBackgroundColor Color definition 255,255,255 (White)

The color of the username text box's background.

NameEditCenterY Integer 0

The gap between the top edge of the applet area and the center of the username text box. The value 0 (the default) means the center of the username text box is aligned with the applet area's top edge.

NameEditFontFamily Font family Browser dependent

The font used to display text in the username text box.

NameEditFontSize Integer Browser dependent

The point size of the font used to display text in the username text box.

NameEditFontStyle Style indicator plain

The style of font used to display text in the username text box.

NameEditForegroundColor Color definition 0,0,0 (Black)

The color of text displayed in the username text box.

NameEditText String ""

Any default text to appear in the username text box. By default, the username text box is empty.

NameEditWidth Integer 0

The width of the username text box.

NameEditX Integer 0

The gap between the username text box's left edge and the applet area's left side. The value 0 (the default) means the username text box's left edge is aligned with the applet area's left side.

PasswordCaptionCenterY Integer 0

The gap between the top edge of the applet area and the center of the password caption area. The value 0 (the default) means the center of the password caption area is aligned with the applet area's top edge.

The password caption area displays the text specified by PasswordCaptionText.

PasswordCaptionFontFamily Font family Browser dependent

The font used to display PasswordCaptionText.

PasswordCaptionFontSize Integer Browser dependent

The point size of the font used to display PasswordCaptionText.

PasswordCaptionFontStyle Style indicator plain

The style of font used to display PasswordCaptionText.

PasswordCaptionForegroundColor Color definition 0,0,0 (Black)

The color of PasswordCaptionText.

PasswordCaptionHorizontalAlignment Alignment indicator left

How PasswordCaptionText is aligned within the title area.

PasswordCaptionText String ""

The text displayed in the password caption area, for example, "Password".

PasswordCaptionWidth Integer 0

The width of the password caption area.

The password caption area doesn't clip PasswordCaptionText -- text is allowed to extend beyond the width of the password caption area. This setting is used to calculate the position of text when used with PasswordCaptionHorizontalAlignment values of center and right.

PasswordCaptionX Integer 0

The gap between the password caption area's left edge and the applet area's left side. The value 0 (the default) means the password caption area's left edge is aligned with the applet area's left side.

The password caption area displays the text specified by PasswordCaptionText.

PasswordEditBackgroundColor Color definition 255,255,255 (White)

The color of the password text box's background.

PasswordEditCenterY Integer 0

The gap between the top edge of the applet area and the center of the password text box. The value 0 (the default) means the center of the password text box is aligned with the applet area's top edge.

PasswordEditFontFamily Font family Browser dependent

The font used to display text in the password text box.

PasswordEditFontSize Integer Browser dependent

The point size of the font used to display text in the password text box.

PasswordEditFontStyle Style indicator plain

The style of font used to display text in the password text box.

PasswordEditForegroundColor Color definition 0,0,0 (Black)

The color of any text displayed in the password text box.

PasswordEditText String ""

Any default password text to appear in the password text box. The actual text will be hidden by asterisks. By default, the password text box is empty.

PasswordEditWidth Integer 0

The width of the password text box.

PasswordEditX Integer 0

The gap between the password text box's left edge and the applet area's left side. The value 0 (the default) means the password text box's left edge is aligned with the applet area's left side.

TargetFrame String "_self"

The name of the frame used to display the webtop tray applet.

Use the placeholder %%TARGETFRAME%% to let Secure Global Desktop supply the correct value for this parameter.

TitleCenterY Integer 0

The gap between the top edge of the applet area and the center of the title area. The value 0 (the default) means the center of the title area is aligned with the applet area's top edge.

Note that the title area only displays the text specified by TitleText. This setting doesn't affect how the applet displays TitleImage.

TitleFontFamily Font family Browser dependent

The font used to display TitleText.

TitleFontSize Integer Browser dependent

The point size of the font used to display TitleText.

TitleFontStyle Style indicator plain

The style of font used to display TitleText.

TitleForegroundColor Color definition 0,0,0 (Black)

The color of TitleText.

TitleHorizontalAlignment Alignment indicator left

How TitleText is aligned within the title area.

TitleImage Graphic filename No graphic

A graphic file to be used either as a title or the background to TitleText.

The login applet displays this image horizontally centered and top-aligned within the applet area.

If you specify MainImage, use MainImageY to offset MainImage. If you don't, MainImage will obscure TitleImage.

TitleText String ""

The text displayed in the title area, for example, "Welcome to Secure Global Desktop".

TitleWidth Integer 0

The width of the title area.

The title area doesn't clip TitleText -- text is allowed to extend beyond the width of the title area. This setting is used to calculate the position of text when used with TitleHorizontalAlignment values of center and right.

A value of 0 means the applet won't display TitleText.

Note that the title area only displays the text specified by TitleText. This setting doesn't affect how the applet displays TitleImage.

TitleX Integer 0

The gap between the title area's left edge and the applet area's left side. The value 0 (the default) means the title area's left edge is aligned with the applet area's left side.

Note that the title area only displays the text specified by TitleText. This setting doesn't affect how the applet displays TitleImage.

Diagrams of the login applet's parameters

Diagram of the login applet showing where the title, main image and hints parameters display

Diagram of the login applet showing where the username caption and password caption parameters display

Diagram of the login applet showing where the username edit and password edit parameters display

Diagram of the login applet showing where the login button parameters display

Related topics