Share via

Developing Windows Client Control Add-ins

  • Article

Microsoft Dynamics NAV 2013 R2 includes the client extensibility API for creating Microsoft Dynamics NAV Windows client control add-ins. The client extensibility API is provided in the Microsoft.Dynamics.Framework.UI.Extensibility.dll assembly, which is installed with the Microsoft Dynamics NAV Windows client. You develop control add-ins using Microsoft Visual Studio and distribute them as Microsoft .NET Framework–based assemblies for deployment to computers that are running the Microsoft Dynamics NAV Windows client.

Design Considerations When Developing Control Add-ins

This section includes things to consider when you develop control add-ins.

Using a Control Add-in on Pages

  • You apply control add-ins on field controls of Microsoft Dynamics NAV Windows client pages.

    Important

    Control add-ins are not supported by the Microsoft Dynamics NAV Web client. You should not use a control add-in on a page that will be displayed in the Microsoft Dynamics NAV Web client.

  • You can apply control add-ins on more than one field control on a page.

  • You can use control add-ins on all page types except a RoleCenter page type.

    Note

    To include a control add-in on a Role Center, you apply the control add-in on a page that is assigned to a part of the Role Center.

  • You can use control add-ins on pages that are included in parts and FactBoxes of other pages.

  • You can design the user interface of the control add-in to fill the page part area partially or completely.

  • You cannot use control add-ins on the following areas:

    • On a field under a repeater control, this is used display data in a list, such as in a list place

    • Ribbon

    • Command bar

    • Filter pane

Binding a Control Add-in to the Database to Display Data

A control add-in can bind with data in the Microsoft Dynamics NAV database, which lets you create control add-ins that can display and update data in the database. For more information, see Binding a Windows Client Control Add-in to the Database.

Exposing Events and Calling Respective C/AL Triggers on a Page

By firing exposed events, a control add-in can call the OnControlAddin trigger or other triggers that correspond to those events on a page for a field that is equipped with the control add-in. For more information, see Exposing Events and Calling Respective C/AL Triggers from a Windows Client Control Add-in.

Exposing Methods and Properties to C/AL code

To extend UI controls on a page, you can expose methods and properties in a control add-in assembly so that they can be called by C/AL code on most any page code. For more information, see Exposing Methods and Properties in a Windows Client Control Add-in.

See Also

Tasks

How to: Create a Windows Client Control Add-in

Concepts

Client Extensibility API Overview
Binding a Windows Client Control Add-in to the Database
Exposing Events and Calling Respective C/AL Triggers from a Windows Client Control Add-in
Installing and Configuring Windows Client Control Add-ins on Pages
Windows Client Control Add-in Overview