CreateScreenOverlay
Creates an image overlay fixed to the screen, e.g., for a logo.
|
JavaScript |
|
|
CreateScreenOverlay( ImageFileName, GroupID, Description) |
|
|
C# |
|
|
IScreenOverlay80 CreateScreenOverlay ( String ImageFileName, String GroupID, String Description) |
|
|
C++ |
|
|
HRESULT CreateScreenOverlay( BSTR ImageFileName, BSTR GroupID, BSTR Description, IScreenOverlay80** pIScreenOverlay80) |
|
Parameters
ImageFileName
A full path name or a URL to an image file for the screen overlay. Only BMP, JPEG, or GIF file types are supported.
GroupID
The Project Tree group in which the screen overlay is created. If it is set to an empty string, the object is created under the root. You can obtain the GroupID by one of the following methods:
· Create the group using IProjectTree80.CreateGroup.
· Find the group, if you know the name, using IProjectTree80.FindItem.
· Traverse the Tree using IProjectTree80 methods such as GetNextItem, until you come to the desired GroupID.
Description
The name of the screen overlay object as it appears in the Project Tree. If an empty string is passed to this parameter, TerraExplorer assigns it a unique name.
Return Value
pIScreenOverlay80
An IScreenOverlay80 representing the newly created overlay.
Exceptions
See: HRESULT Return Values for a list of possible values returned by the HRESULT.