Where are the methods available in the CSOM for WebExplorerBar defined / documented?
I look in the documentation and all I see under the CSOM reference guide links me to the Namespace. However, I do not see the methods available!
I know from the docs that I can do a var itm = eventArgs.getExplorerBarItem() to get the item that has been clicked on. But where is it documented what methods are available on this item? I know I can do itm.get_Value() and a couple of others, but I am unable to find any documentation on what methods / properties are available.
I specifically am wondering how to determine in the ItemClick event whether the item is a Group or an item.
A few years ago I wrote extensive Java coding that used the 'Classic' controls. I recall having very good documentation to assist me in the development. The client is having me upgrade the code to the new controls, but without good documentation this is very frustrating!
Hello sjreed ,
Thank you for posting in our forum.
Under the WebExplorerBar namespace:
http://help.infragistics.com/NetAdvantage/ASPNET/2011.1/CLR4.0/?page=WebExplorerBar~Infragistics.Web.UI_namespace.html
You’ll find the main classes. If you open for example the WebExplorerBar Class on the bottom you’ll see a link to its members: WebExplorerBar Members
That’ll lead you to the page with all available properties and methods.
Similarly for the ExplorerBarItem class, if you open the link at the bottom of its page in the documentation: ExplorerBarItem Members you’ll see its available methods and properties.
Regarding the events. When you create them you’ll get a comment that will explain the type of parameters that will be passed. For example:
function WebExplorerBar1_ItemClick(sender, eventArgs)
{
///<summary>
///
///</summary>
///<param name="sender" type="Infragistics.Web.UI.WebExplorerBar"></param>
///<param name="eventArgs" type="Infragistics.Web.UI.ExplorerBarCancelEventArgs"></param>
//Add code to handle your event here.
}
So in this case the sender will the WebExplorerBar so it will contain the methods and properties of the WebExplorerBar class (WebExplorerBar Members).
And the eventArgs will be from the ExplorerBarCancelEventArgs class which can be found in the documentation (
http://help.infragistics.com/NetAdvantage/ASPNET/2011.1/CLR4.0/?page=WebExplorerBar~Infragistics.Web.UI.ExplorerBarCancelEventArgs.html
). It’s members can be found on the bottom of its page at ExplorerBarCancelEventArgs Members .
Let me know if you have any questions or concerns.
Best Regards,
Maya Kirova
Developer Support Engineer II
Infragistics, Inc.
http://es.infragistics.com/support
Maya,
Thank you for your quick response!
My apologies for not specifying that I am using 2013.1 with .Net 4.5 and Visual Studio 2012, and that I am using the 'Local' Help files. These files DO NOT have the links I expected to find on the bottom of the pages! I do, however, notice that they have a 'Members' link at the top of the page.
In the case of the ExplorerBarCancelEventArgs getExplorerBarItem, it would be helpful if the documentation had a 'Reference' link to the ExplorerBarItem class, since that is what is returned.
That being said, I find that none of the ExplorerBarItem Properties work when attempting to access them after capturing the ItemClick event in the CSOM environment! I do a var itm=eventArgs.getExplorerBarItem() to get the item, then try to use the properties (such as itm.value). When doing this in the immediate window, it returns undefined! If I change this to a method call, i.e. itm.get_value(), it returns the expected value.
My question is: Where are these Method calls documented?
Also, I do not see a property / method to determine if the ExplorerBarItem is a Group Bar item. The ExplorerBarItemClickEventArgs contains this as ItemType, but how do I get that while in a Click event. It is not a property of ExplorerBarCancelEventArgs nor ExplorerBarItem!
Thanks again...Steve
On a related note, there used to be function to find Tree / Node items on pages, i.e., igtree_getNodeById, igtbar_getToolbarById.
Are there similar functions for the new tools? Where are they documented?
Thanks!
If you open the properties you’ll see that they actually contain functions. For example the value:
http://help.infragistics.com/Help/NetAdvantage/ASPNET/2011.1/CLR4.0/html/WebExplorerBar~Infragistics.Web.UI.ExplorerBarItem~value.html
Contains the following getter and setter:
function get_value() : String
function set_value(value : String)
Which are the functions you'd need to use when retrieving the value.
Regarding the type of the clicked item. There’s no method you could use that would check whether the clicked item is a group. However you could check its css class. For example:
if(eventArgs.getExplorerBarItem().get_cssClass().indexOf("Group")!=-1)
//clicked item is a group
Regarding the utility functions like igtree_getNodeById. There are no similar methods for the new controls.
However you can retrieve the control itself by its client id using: $find(“ControlID”). You can get any of the Aikido controls by their ClientID using that method.
Let me know if you have any questions.