IContainerItem80

This interface allows you to get or set details for a specified container object. For example, you can find out whether the container holds text or a URL to a file, and where its initial docking location is.

 

 

Properties

 

ItemID

Gets the ID of the selected container.

Name

Gets and sets the container name as appears on the container caption.

StartupSite

Gets and sets the initial docking location of the container.

Text

Gets and sets the text to display in the container.

URL

Gets and sets the URL of the file to be opened in the container.

UseEdge

Gets and sets a Boolean that determines whether a container opens in Edge or Internet Explorer web browser.

UseURL

Gets and sets a Boolean that determines if a URL to a file is used or a simple text message.

ItemID

Gets the ID of the container.

 

JavaScript

 

ItemID

 

C#

 

int ItemID { get; } 

 

C++

 

HRESULT ItemID([out, retval] long* pVal)

Name

Gets and sets the container name that appears on the container caption or on the tab (if multiple windows are placed in the same container).

 

JavaScript

 

Name

 

C#

 

string Name { get; set; }

 

C++

 

HRESULT Name([out, retval] BSTR* pVal)

HRESULT Name([in] BSTR pVal)

StartupSite

Gets and sets an enum determining the startup site used for the container. The StartupSite enum can use any of the following values:

§   CS_NOT_VALID         = -1

§   CS_DOCK_LEFT         = 0

§   CS_DOCK_RIGHT      = 1

§   CS_DOCK_TOP          = 2

§   CS_DOCK_BOTTOM = 3

§   CS_DOCK_FLOAT     = 4

§   CS_MAIN                    = 5

 

JavaScript

 

StartupSite

 

C#

 

ContainerSite StartupSite { get; set; }

 

C++

 

HRESULT StartupSite([out, retval] ContainerSite* pVal)

HRESULT StartupSite([in] ContainerSite pVal)

Text

Gets and sets the text to display in the container, if the UseURL Boolean is set to FALSE.

 

JavaScript

 

Text

 

C#

 

string Text { get; set; }

 

C++

 

HRESULT Text([out, retval] BSTR* pVal)

HRESULT Text([in] BSTR pVal)

URL

Gets and sets the URL of the file to be opened in the container, if the UseURL Boolean is set to TRUE.

 

JavaScript

 

URL

 

C#

 

string URL { get; set; }

 

C++

 

HRESULT URL([out, retval] BSTR* pVal)

HRESULT URL([in] BSTR pVal)

 

UseEdge

Gets and sets a Boolean that determines what web browser the container’s URL is opened in: Microsoft Edge or legacy Internet Explorer. This property should be used together with the UseURL Boolean set to TRUE. See "How To" in the "Overview" chapter for information on how to open Edge and legacy Internet Explorer in TerraExplorer containers.

 

JavaScript

 

UseEdge

 

C#

 

bool UseEdge { get; set; }

 

C++

 

HRESULT UseEdge ([out, retval] VARIANT_BOOL* pVal)

HRESULT UseEdge ([in] VARIANT_BOOL pVal)

 

UseURL

Gets and sets a Boolean that determines if a URL to a file is used or a simple text message.

 

JavaScript

 

UseURL

 

C#

 

bool UseURL { get; set; }

 

C++

 

HRESULT UseURL([out, retval] VARIANT_BOOL* pVal)

HRESULT UseURL([in] VARIANT_BOOL pVal)