Bexel Manager API Documentation
Bexel.Api.IDockableControl Interface Reference

Represents a dockable control in the host application UI. More...

Public Member Functions

void Dock ()
 Docks a dockable control in the host application UI. More...
 
void Undock ()
 Undocks a dockable control in the host application UI. More...
 
void ShowControl ()
 Shows a dockable control in the host application UI. More...
 
void HideControl ()
 Hides a dockable control in the host application UI. More...
 
void SetUserControl (UserControl userControl)
 Sets a user control in the dockable control in the host application UI. More...
 
void RemoveUserControl ()
 Removes a user control from the dockable control in the host application UI. More...
 

Properties

Guid ID [get]
 Represents an identificator of the dockable control in the host application UI. More...
 
string Title [get, set]
 Represents a title of the dockable control in the host application UI. More...
 
UserControl UserControl [get]
 Represents a user control that is attached to the dockable control in the host application UI. More...
 
DockableControlState State [get]
 Represents a current state of the dockable control in the host application UI. More...
 

Detailed Description

Represents a dockable control in the host application UI.

Member Function Documentation

◆ Dock()

void Bexel.Api.IDockableControl.Dock ( )

Docks a dockable control in the host application UI.

◆ HideControl()

void Bexel.Api.IDockableControl.HideControl ( )

Hides a dockable control in the host application UI.

◆ RemoveUserControl()

void Bexel.Api.IDockableControl.RemoveUserControl ( )

Removes a user control from the dockable control in the host application UI.

◆ SetUserControl()

void Bexel.Api.IDockableControl.SetUserControl ( UserControl  userControl)

Sets a user control in the dockable control in the host application UI.

Parameters
userControlA user control to be set in the dockable control in the host application UI.

◆ ShowControl()

void Bexel.Api.IDockableControl.ShowControl ( )

Shows a dockable control in the host application UI.

◆ Undock()

void Bexel.Api.IDockableControl.Undock ( )

Undocks a dockable control in the host application UI.

Property Documentation

◆ ID

Guid Bexel.Api.IDockableControl.ID
get

Represents an identificator of the dockable control in the host application UI.

◆ State

DockableControlState Bexel.Api.IDockableControl.State
get

Represents a current state of the dockable control in the host application UI.

◆ Title

string Bexel.Api.IDockableControl.Title
getset

Represents a title of the dockable control in the host application UI.

◆ UserControl

UserControl Bexel.Api.IDockableControl.UserControl
get

Represents a user control that is attached to the dockable control in the host application UI.