Your Privacy Matters: We use our own and third-party cookies to improve your experience on our website. By continuing to use the website we understand that you accept their use. Cookie Policy
275
How are the samples and documentation suppose to work?
posted

First, it's not clear to me how the samples are supose to work. Here's an example:

 

http://es.infragistics.com/products/aspnet/sample/data-menu/data-binding

 

The code example listed above has references to stuff in ~SampleCommon, such as the DataSourceControl.ascx. Where am I suppose to find this?

 

Second, the download sample applications don't have examples of all the controls. For instance, I cannot find an example of how the WebDataMenu is used. All I can do is try and search the forums for vague and incomplete examples from the problems others have posted. Am I not aware of some other place on the website that provides more comprehensive examples and documentation?

 

Lastly, I can't seem to find any complete documentation on how to use the Javascript OM API. I see links like this:

 

http://help.infragistics.com/NetAdvantage/ASPNET/2012.1/CLR4.0/

 

but the documentation are lax and minimalistic in how to actually use the API. For instance, the parameter descriptions are usually self-descriptive and example usage are usually useless one-linerer. Example:

 

Parameters

clientID
Client ID of the control to look for.
 
ASP.NET Ajax Javascript (Usage)
var resultVar = instanceOfWebDataMenu.find(String);

 

Is this just the way things are or am I missing something?

Parents
No Data
Reply
  • 29417
    Offline posted

    Hello Anthony ,

     

    Thank you for posting in our forum.

     

    Generally the code snippets you see in the samples are directly copied from the code in the samples browser. The sample browser uses some common assemblies, user controls and other things while the code underneath the online sample usually contains only the mark-up page(aspx) and the code behind(cs/vb) without the additional resources it’s possible to be a bit ambiguous .

    If you have the samples installed locally however you should be able to find  any of the additional resources you might want to see.

     

    Generally the downloaded samples should contain the same samples that are available in the online one. I can see that there are a dew samples for the WebDataMenu here:

    http://es.infragistics.com/products/aspnet/data-menu

    Are you looking a specific sample?

     

    Generally you might be able to find the different properties and methods if you check the members of a specific class. Here’s a list of all the classes for the WebDataMenu for example:

     http://help.infragistics.com/NetAdvantage/ASPNET/2012.1/CLR4.0/?page=WebDataMenu~Infragistics.Web.UI_namespace.html

    So for example if you select WebDataMenu object  at the bottom you can see a link to the Members. The members contain all of the public methods and properties for that object:

    http://help.infragistics.com/NetAdvantage/ASPNET/2012.1/CLR4.0/?page=WebDataMenu~Infragistics.Web.UI.WebDataMenu_members.html

    Let me know if you’re looking for something specific but you’re not able to find it.

     

    Let me know if you have any questions or if there’s anything else I can do to assist you.

     

    Best Regards,

    Maya Kirova

    Developer Support Engineer II

    Infragistics, Inc.

    http://es.infragistics.com/support

     

Children
  • 275
    posted in reply to Maya Kirova

    Hi Maya,

     

    Thanks for your time and help. I've been referring to the same samples and API reference you've linked to. For instance, the data-binding example for the WebDataMenu:

     

    http://es.infragistics.com/products/aspnet/sample/data-menu/data-binding

     

    Has the following code in the .aspx file:

     

    <%@ Register Src="~/SamplesCommon/aspnet/Common/UserControls/DataSourceControl/DataSourceControl.ascx"     TagName="DataSourceControl" TagPrefix="uc1" %>

     

    Where is that reference in the samples/example applications? Also, when I change the drop-down for "Select a Data Source" I do not see anything change in the code. For instance, I continue to see the use of an XML data source even after choosing IEnumerable. Actually, in fact, I cannot find an example of the WebDataMenu in any of the showcase applications (InfraProperties, InfraShop, MyMail). Is there a complete, end-to-end working example of the WebDataMenu that I can download or look at available on this site? I run into similar issues with other controls, too. I'm just using the WebDataMenu as an example.

    Lastly, I understand the basics of how to navigate the API reference. What I was asking/pointing out was that the references themselves seem to lack the thoroughness and clarity I'd expect from a premium product like this. The example I gave was a method example with a parameter. The documentation wasn't very helpful because if a method/property is called "get_property" it's redundant documentation to simply say "Gets the property." If a parameter is called "objectID" it's redundant to document it as "The ID of the object." Furthermore, it's redundant in the documentation to show the method usage as such a simple one-line example like "object.get_property()" because it's already fairly well understood how methods and properties are generally invoked. I think what's missing are context and practical examples. I suppose I'm too used to Microsoft, where every piece of the API has a thoroughly documented explanation with complete code-in-context examples. I was asking if that was truly all there is to the API documentation or if I'm missing something else that's more thorough.

    Lastly, one of the things I really wish I could find would be more complete examples using the Javascript API features with the controls without having to hunt the forums for them. Is there a repository of examples using the Javascript API?

     

    Thanks again for your help.