Bexel.Api.IUIApplication Interface Reference

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

Public Member Functions
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	GetOrCreateRibbonGroup (string tabName, string groupName)
	Retrieves a ribbon group with the specified name from the host application UI. 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. 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. If no such group exists a new one is created. More...
IRibbonButton	GetOrCreateRibbonButton (string tabName, string groupName, string buttonName)
	Retrieves a ribbon button with the specified name from the host application UI. 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. 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. If no such button exists a new one is created. More...

Detailed Description

Represents the UI part of the host application.

Member Function Documentation

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. 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

Returns

The ribbon button with the specified name.

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. 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.

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. 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.

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. 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.

Returns

The ribbon group with the specified name.

GetOrCreateRibbonGroup() [2/3]

IRibbonGroup Bexel.Api.IUIApplication.GetOrCreateRibbonGroup

(

string

groupName

)

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

Parameters

groupName

The name of the ribbon group.

Returns

The ribbon group with the specified name.

GetOrCreateRibbonGroup() [3/3]

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

Retrieves a ribbon group with the specified name from the host application UI. 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 ribbon group with the specified name.

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.

Returns

The ribbon tab with the specified name.