IKMLLayer81

This interface gives access to actions that can be performed on a KML layer. KML layers loaded into a project are always read directly from the local or remote data source.

 

	Properties
	Editable	Gets a Boolean indicating whether the layer is editable.
	ID	Gets the ID of the layer. (Inherited from ITerraExplorerObject81)
	ObjectType	Gets an enum that identifies the type of the object. (Inherited from ITerraExplorerObject81)
	Path	Gets the full path of the KML file.
	SaveInFlyFile	Gets and sets a Boolean that determines whether the layer is saved in the Fly file. (Inherited from ITerraExplorerObject81)
	TreeItem	An ITreeItem81 representing details about the representation of the layer in the Project Tree.
	Methods
	GetClientData	Gets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject81)
	GetNetworkLink	Returns an interface to to the INetworkLink81 object based on the specified ID.
	GetParam	Reserved. Currently not used. (Inherited from ITerraExplorerObject81)
	PublishToSGS	Publishes a layer to SkylineGlobe Server.
	Refresh	Refreshes the layer.
	Save	Saves layer changes to the data source.
	SaveAs	Saves layer changes to a file with a specified name.
	SetClientData	Sets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject81)
	SetParam	Reserved. Currently not used. (Inherited from ITerraExplorerObject81)

 

Editable

Gets a Boolean indicating whether the layer is editable.

JavaScript
Editable

 

C#
bool Editable { get; }

 

C++
HRESULT Editable(        [out, retval] VARIANT_BOOL* pVal)

 

Path

Gets the full path of the KML file.

JavaScript
Path

 

C#
string Path { get; }

 

C++
HRESULT Path(        [out, retval] BSTR* pVal)

 

GetNetworkLink

Returns an interface to the INetworkLink81 object based on the specified ID.

 

JavaScript
GetNetworkLink (        ObjectID)

 

C#
INetworkLink81 GetNetworkLink (        string ObjectID)

 

C++
HRESULT GetNetworkLink (        BSTR ObjectID,        INetworkLink81** pINetworkLink)

Parameters

ObjectID

The ID of the network link item requested. It must be a child element of the IKMLLayer it is called on.  

Return Value

pINetworkLink

An INetworkLink81 representing the network link object.

 

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

PublishToSGS

Publishes a layer to SkylineGlobe Server. This method executes asynchronously, i.e., it returns immediately. You can then use ISGWorld.OnPublishFinished to be notified when publishing is complete.

 

JavaScript
PublishToSGS (        HideProgressDialog,        viewAccess,        editAccess,        Tag)

 

C#
void PublishToSGS (        bool HideProgressDialog = False,        TerraExplorerX.SGPublishPermission viewAccess = 3,        TerraExplorerX.SGPublishPermission editAccess = 3,        string Tag = "")

 

C++
HRESULT PublishToSGS(        [in] VARIANT_BOOL HideProgressDialog,        [in] SGPublishPermission viewAccess,        [in] SGPublishPermission editAccess,        [in] BSTR Tag);

 

Parameters

HideProgressDialog

A Boolean that determines whether to hide the progress dialog that shows the approximate percentage of completion.

viewAccess

An enum that determines the view access for the published layer. Users with View access can view and load the layer from the Layers page. The following are the possible values:

·        SG_PERMISSION_ONLY_ME = 0,

·        SG_PERMISSION_MY_GROUP = 1,

·        SG_PERMISSION_MY_SITE = 2,

·        SG_PERMISSION_EVERYONE = 3

editAccess

An enum that determines the edit access for the published layer. Edit access adds the ability to load, edit and save changes to the layer from TerraExplorer and the browser. The following are the possible values:

·        SG_PERMISSION_ONLY_ME = 0,

·        SG_PERMISSION_MY_GROUP = 1,

·        SG_PERMISSION_MY_SITE = 2,

·        SG_PERMISSION_EVERYONE = 3

Tag

Tags, i.e., key words or terms associated with the layer for advanced searches, represented as a semi-colon delimited string. E.g., if the layer has three tags, pass "a;b;c" for this parameter, where "a" is the value of the first tag, "b" is the value of the second, and "c" the value of the third.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

Refresh

Refreshes the layer.

 

JavaScript
Refresh

 

C#
void Refresh()

 

C++
HRESULT Refresh()

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

 

Save

Saves layer changes to the data source.

 

JavaScript
Save()

 

C#
void Save()

 

C++
HRESULT Save()

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

SaveAs 

Saves the layer changes to a file with a specified name. For security reasons the file is saved to a predefined "Skyline\TerraExplorer" folder in the "Application Data" space of the current user. The full path of the saved file is provided in the method’s return value. You can also use %APPDATA% in Windows Explorer to locate the path on your computer.

Note:     If the folder contains a file by the same name, the existing file is overwritten without a prompt.

Note:     The Application Data folder path changes between different users and different Windows operating systems. To find the path used by your client look at the %APPDATA% environment variable.

 

JavaScript
SaveAs(        KmlName)

 

C#
string SaveAs(        string KmlName)

 

C++
HRESULT SaveAs(        BSTR KmlName,        BSTR* pVal)

Parameters

KmlName

The name for the layer file.
Note: A file name with a full path cannot be used here.

Return Value

pVal

A full path of the layer file being created.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.