Bexel Manager API Documentation
Bexel.Api.IUIApplicationDockableControls Interface Reference

Contains logic for embedding add-in user interface controls within the host application user interface layout. More...

Public Member Functions

IDockableControl GetOrCreateDockableControl (Guid id, string title)
 Retrieves a dockable control with the specified identificator from the host application UI. If no such dockable control exists a new one is created with a specified identificator and title. More...
 
IDockableControl GetDockableControl (Guid id)
 Retrieves a dockable control with the specified identificator from the host application UI. More...
 
bool TryGetDockableControl (Guid id, out IDockableControl dockableControl)
 Tries to retrieve a dockable control with the specified identificator from the host application UI. If the dockable control doesn't exist, retrieves Null. More...
 

Detailed Description

Contains logic for embedding add-in user interface controls within the host application user interface layout.

Member Function Documentation

◆ GetDockableControl()

IDockableControl Bexel.Api.IUIApplicationDockableControls.GetDockableControl ( Guid  id)

Retrieves a dockable control with the specified identificator from the host application UI.

Parameters
idAn identificator of the dockable control.
Exceptions
DockableApiControlNotFoundExceptionIf the dockable control with the specified identificator doesn't exist.
Returns
The dockable control with the specified identificator.

◆ GetOrCreateDockableControl()

IDockableControl Bexel.Api.IUIApplicationDockableControls.GetOrCreateDockableControl ( Guid  id,
string  title 
)

Retrieves a dockable control with the specified identificator from the host application UI. If no such dockable control exists a new one is created with a specified identificator and title.

Parameters
idAn identificator of the dockable control.
titleA title of the dockable control.
Returns
The dockable control with the specified identificator and title.

◆ TryGetDockableControl()

bool Bexel.Api.IUIApplicationDockableControls.TryGetDockableControl ( Guid  id,
out IDockableControl  dockableControl 
)

Tries to retrieve a dockable control with the specified identificator from the host application UI. If the dockable control doesn't exist, retrieves Null.

Parameters
idAn identificator of the dockable control.
dockableControlA dockable control.
Returns
True if the dockable control is found, False otherwise.