This discussion has been locked.
You can no longer post new replies to this discussion. If you have a question you can start a new discussion

DEVELOPERS FORUM - How to use API?

vishal_trivedi - Monday, February 28, 2011 1:17 AM:

Hi,

I want to know how to use the methods available in API reference..

Can anybody suggest me the way??

e.g.

Namespace   -   Aras.Client.Controls.

Interface - ITDropDownButtonComIncoming

Method - GetId

In above example there is a method given GetId and i want to use it by referring API Reference.

So, how to use it??

Thanks in Advance.

Vishal



Brian - Monday, February 28, 2011 6:22 AM:

Hi Vishal,

Each client controls (for example the TreeGridContainerClass for displaying information in a Tree Structure like the Table Of Contents) has methods that you can call.

The ITDropDownButtonComIncoming is what is known as an Interface. The Interface defines particular methods that the Control implements. This is a way of building up common functionality with Sub Classes where each of the Sub Classes has different behaviour for the same call OR where the Sub Classes all use the Base or Common implementation of the Method.

To use any of the API calls you need to have the Object that the call works on. For example in the TreeGridContainerClass there is a method called AddRow which takes an ID for the row, a string to display in the row and an action for the grid to perform.

In order to call this method you need to have a TreeGridContainerClass object.

That's how all of the API items work.

Get the Object and then use the method.

Hope this helps

Brian.



vishal_trivedi - Monday, February 28, 2011 7:36 AM:

Hi Brian,

Can you give me an example with some code???

It will be really useful for me.

-Vishal