Home > Working with SGWorld > ProjectTree (IProjectTree6) > GetVisibility

GetVisibility

This method returns the visibility status of a Project Tree item on the terrain.

Supported by TerraExplorer Viewer.

 

JavaScript

 

GetVisibility(

      ItemID)

 

C#

 

int GetVisibility(

      int ItemID)

 

C++

 

HRESULT GetVisibility(

      LONG_PTR ItemID,

      long * pVal) 

Parameters

ItemID

The ID of the Project Tree item in question.

Return Value

pVal

The visibility status:

·         0 – Hide (the equivalent of the Show/Hide checkbox being unchecked in the Project Tree)

·         1- Show (the equivalent of the Show/Hide checkbox being checked)

·         2-Hide but show in Basic Viewer (the equivalent of the Show/Hide checkbox being filled in)

Note:    2 can only be returned for a group.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP

The group ID entered does not represent a valid group in the project tree.

TE_E_INFOTREE_ITEMNOTGROUP

The item entered is not a group and therefore cannot be used as a group.

TE_E_INFOTREE_CANTUSEROOT

Can not use tree root for this operation

TE_E_INFOTREE_ITEMISGROUP

ItemID is a group so an object cannot be retrieved.