Represents the UI part of the host application. More...

Public Member Functions
IRibbonTab	CreateRibbonTab (string tabName)
	Creates a ribbon tab with the specified name in the host application UI. More...

IRibbonTab	GetOrCreateRibbonTab (string tabName)
	Retrieves a ribbon tab with the specified name from the host application UI. If no such tab exists a new one is created. More...

IRibbonGroup	CreateRibbonGroup (string tabName, string groupName)
	Creates a ribbon group with the specified name in the host application UI within the specified tab. More...

IRibbonGroup	CreateRibbonGroup (IRibbonTab tab, string groupName)
	Creates a ribbon group with the specified name in the host application UI within the specified tab. More...

IRibbonGroup	CreateRibbonGroup (string groupName)
	Creates a ribbon group with the specified name in the host application UI within predefined Add-ins tab. More...

IRibbonGroup	GetOrCreateRibbonGroup (string tabName, string groupName)
	Retrieves a ribbon group with the specified name from the host application UI within the specified tab. If no such group exists a new one is created. More...

IRibbonGroup	GetOrCreateRibbonGroup (IRibbonTab tab, string groupName)
	Retrieves a ribbon group with the specified name from the host application UI within the specified tab. If no such group exists a new one is created. More...

IRibbonGroup	GetOrCreateRibbonGroup (string groupName)
	Retrieves a ribbon group with the specified name from the host application UI within predefined Add-ins tab. If no such group exists a new one is created. More...

IRibbonButton	CreateRibbonButton (string tabName, string groupName, string buttonName)
	Creates a ribbon button with the specified name from the host application UI within the specified tab and group. More...

IRibbonButton	CreateRibbonButton (IRibbonTab tab, string groupName, string buttonName)
	Creates a ribbon button with the specified name from the host application UI within the specified tab and group. More...

IRibbonButton	CreateRibbonButton (IRibbonGroup group, string buttonName)
	Creates a ribbon button with the specified name in the host application UI within predefined Add-ins tab and the specified group. More...

IRibbonButton	GetOrCreateRibbonButton (string tabName, string groupName, string buttonName)
	Retrieves a ribbon button with the specified name from the host application UI within the specified tab and group. If no such button exists a new one is created. More...

IRibbonButton	GetOrCreateRibbonButton (string groupName, string buttonName)
	Retrieves a ribbon button with the specified name from the host application UI within predefined Add-ins tab and the specified group. If no such button exists a new one is created. More...

IRibbonButton	GetOrCreateRibbonButton (IRibbonGroup group, string buttonName)
	Retrieves a ribbon button with the specified name from the host application UI within predefined Add-ins tab and the specified group. If no such button exists a new one is created. More...

Properties
IUIApplicationDockableControls	DockableControls `[get]`
	Contains logic for embedding add-in user interface controls within the host application user interface layout. More...

Detailed Description

Represents the UI part of the host application.

Member Function Documentation

◆ CreateRibbonButton() [1/3]

IRibbonButton Bexel.Api.IUIApplication.CreateRibbonButton	(	string	tabName,
		string	groupName,
		string	buttonName
	)

Creates a ribbon button with the specified name from the host application UI within the specified tab and group.

Parameters

tabName	The name of the ribbon tab.
groupName	The name of the ribbon group.
buttonName	The name of the ribbon button

Exceptions

System.NotSupportedException If any of the predefined tabs are specified.

Returns: The newly created ribbon button with the specified name within the specified tab and group.

◆ CreateRibbonButton() [2/3]

IRibbonButton Bexel.Api.IUIApplication.CreateRibbonButton	(	IRibbonTab	tab,
		string	groupName,
		string	buttonName
	)

Creates a ribbon button with the specified name from the host application UI within the specified tab and group.

Parameters

tab	The reference to the ribbon tab.
groupName	The name of the ribbon group.
buttonName	The name of the ribbon button

Returns: The newly created ribbon button with the specified name within the specified tab and group.

◆ CreateRibbonButton() [3/3]

IRibbonButton Bexel.Api.IUIApplication.CreateRibbonButton	(	IRibbonGroup	group,
		string	buttonName
	)

Creates a ribbon button with the specified name in the host application UI within predefined Add-ins tab and the specified group.

Parameters

group	The reference to the ribbon group.
buttonName	The name of the ribbon button

Returns: The newly created ribbon button with the specified name within predefined Add-ins tab and the specified group.

◆ CreateRibbonGroup() [1/3]

IRibbonGroup Bexel.Api.IUIApplication.CreateRibbonGroup	(	string	tabName,
		string	groupName
	)

Creates a ribbon group with the specified name in the host application UI within the specified tab.

Parameters

tabName	The name of the ribbon tab.
groupName	The name of the ribbon group.

Exceptions

System.NotSupportedException If any of the predefined tabs are specified.

Returns: The newly created ribbon group with the specified name within the specified tab.

◆ CreateRibbonGroup() [2/3]

IRibbonGroup Bexel.Api.IUIApplication.CreateRibbonGroup	(	IRibbonTab	tab,
		string	groupName
	)

Creates a ribbon group with the specified name in the host application UI within the specified tab.

Parameters

tab	The reference to the ribbon tab.
groupName	The name of the ribbon group.

Returns: The newly created ribbon group with the specified name within the specified tab.

◆ CreateRibbonGroup() [3/3]

IRibbonGroup Bexel.Api.IUIApplication.CreateRibbonGroup ( string groupName )

Creates a ribbon group with the specified name in the host application UI within predefined Add-ins tab.

Parameters

groupName The name of the ribbon group.

Returns: The newly created ribbon group with the specified name within predefined Add-ins tab.

◆ CreateRibbonTab()

IRibbonTab Bexel.Api.IUIApplication.CreateRibbonTab ( string tabName )

Creates a ribbon tab with the specified name in the host application UI.

Parameters

tabName The name of the ribbon tab to be created.

Exceptions

System.NotSupportedException Tab with the specified name already exists.

Returns: The newly created ribbon tab with the specified name.

◆ GetOrCreateRibbonButton() [1/3]

IRibbonButton Bexel.Api.IUIApplication.GetOrCreateRibbonButton	(	string	tabName,
		string	groupName,
		string	buttonName
	)

Retrieves a ribbon button with the specified name from the host application UI within the specified tab and group. If no such button exists a new one is created.

Parameters

tabName	The name of the ribbon tab.
groupName	The name of the ribbon group.
buttonName	The name of the ribbon button

Exceptions

System.NotSupportedException If any of the predefined tabs are specified.

Returns: The existing or newly created ribbon button with the specified name within the specified tab and group.

◆ GetOrCreateRibbonButton() [2/3]

IRibbonButton Bexel.Api.IUIApplication.GetOrCreateRibbonButton	(	string	groupName,
		string	buttonName
	)

Retrieves a ribbon button with the specified name from the host application UI within predefined Add-ins tab and the specified group. If no such button exists a new one is created.

Parameters

groupName	The name of the ribbon group.
buttonName	The name of the ribbon button

Returns: The ribbon button with the specified name within predefined Add-ins tab and the specified group.

◆ GetOrCreateRibbonButton() [3/3]

IRibbonButton Bexel.Api.IUIApplication.GetOrCreateRibbonButton	(	IRibbonGroup	group,
		string	buttonName
	)

Retrieves a ribbon button with the specified name from the host application UI within predefined Add-ins tab and the specified group. If no such button exists a new one is created.

Parameters

group	The reference to the ribbon group.
buttonName	The name of the ribbon button

Returns: The ribbon button with the specified name within predefined Add-ins tab and the specified group.

◆ GetOrCreateRibbonGroup() [1/3]

IRibbonGroup Bexel.Api.IUIApplication.GetOrCreateRibbonGroup	(	string	tabName,
		string	groupName
	)

Retrieves a ribbon group with the specified name from the host application UI within the specified tab. If no such group exists a new one is created.

Parameters

tabName	The name of the ribbon tab.
groupName	The name of the ribbon group.

Exceptions

System.NotSupportedException If any of the predefined tabs are specified.

Returns: The existing or newly created ribbon group with the specified name within the specified tab.

◆ GetOrCreateRibbonGroup() [2/3]

IRibbonGroup Bexel.Api.IUIApplication.GetOrCreateRibbonGroup	(	IRibbonTab	tab,
		string	groupName
	)

Retrieves a ribbon group with the specified name from the host application UI within the specified tab. If no such group exists a new one is created.

Parameters

tab	The reference to the ribbon tab.
groupName	The name of the ribbon group.

Returns: The existing or newly created ribbon group with the specified name within the specified tab.

◆ GetOrCreateRibbonGroup() [3/3]

IRibbonGroup Bexel.Api.IUIApplication.GetOrCreateRibbonGroup ( string groupName )

Retrieves a ribbon group with the specified name from the host application UI within predefined Add-ins tab. If no such group exists a new one is created.

Parameters

groupName The name of the ribbon group.

Returns: The existing or newly created ribbon group with the specified name within predefined Add-ins tab.

◆ GetOrCreateRibbonTab()

IRibbonTab Bexel.Api.IUIApplication.GetOrCreateRibbonTab ( string tabName )

Retrieves a ribbon tab with the specified name from the host application UI. If no such tab exists a new one is created.

Parameters

tabName The name of the ribbon tab.

Exceptions

System.NotSupportedException If any of the predefined tabs are specified.

Returns: The existing or newly created ribbon tab with the specified name.

Property Documentation

◆ DockableControls

IUIApplicationDockableControls Bexel.Api.IUIApplication.DockableControls

get

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CreateRibbonButton() [1/3]

◆ CreateRibbonButton() [2/3]

◆ CreateRibbonButton() [3/3]

◆ CreateRibbonGroup() [1/3]

◆ CreateRibbonGroup() [2/3]

◆ CreateRibbonGroup() [3/3]

◆ CreateRibbonTab()

◆ GetOrCreateRibbonButton() [1/3]

◆ GetOrCreateRibbonButton() [2/3]

◆ GetOrCreateRibbonButton() [3/3]

◆ GetOrCreateRibbonGroup() [1/3]

◆ GetOrCreateRibbonGroup() [2/3]

◆ GetOrCreateRibbonGroup() [3/3]

◆ GetOrCreateRibbonTab()

Property Documentation

◆ DockableControls