Difficulty finding documentation

4 posts, 0 answers
  1. Aleks
    Aleks avatar
    20 posts
    Member since:
    Nov 2018

    Posted 18 Feb 2020 Link to this post

    I'm trying to find detailed documentation on (for example) grid options, and I cannot seem to find what I'm after.

    Take for example details on configuring filtering.

    I'm aware of the demos (https://demos.telerik.com/aspnet-core/grid/filter-row) that show examples of *some* uses of *some* of the options, but don't describe in detail what parameters can be passed to the methods, etc.

    There's a documentation link (https://docs.telerik.com/aspnet-core/html-helpers/data-management/grid/overview) right down the bottom of the page that seems to lead to more detailed documentation, however, if I want to get more details on filtering, I click on "filtering" and end up on a page that redirects me back to the demos (https://docs.telerik.com/aspnet-core/html-helpers/data-management/grid/filtering).

    If I click the inconspicuous "Server-Side API" link (https://docs.telerik.com/aspnet-core/api/grid) in the "Related Articles" section, I feel like I'm getting a bit closer, however, I want to see what options can be passed to `Filterable(System.Action<Kendo.Mvc.UI.Fluent.GridFilterableSettingsBuilder>)`

    No doco there, just an example. So I click on the non-obvious link "Kendo.Mvc.UI.Fluent.GridFilterableSettingsBuilder" (https://docs.telerik.com/aspnet-core/api/Kendo.Mvc.UI.Fluent/GridFilterableSettingsBuilder) which I wouldn't have known was a link unless I happened to hover over it, which takes me to a basically blank page, that just says "Defines the fluent interface for configuring Filterable."

    Am I missing something?
  2. Ivan Danchev
    Admin
    Ivan Danchev avatar
    2128 posts

    Posted 21 Feb 2020 Link to this post

    Hello Aleks,

    We acknowledge that some of the classes are not exposed in the Server-Side API documentation section. While it is impossible to cover all the possible combinations of configuration options in our Demos, we can definitely think of ways to expose more of the configuration options in the API section. I will discuss this with the team.

    With regard to the GridFilterableSettingsBuilder's parameters, they are declared as properties of the GridFilterableSettings class:

        public class GridFilterableSettings : JsonObject
        {
            public GridFilterableSettings();
    
            public bool Enabled { get; set; }
            public bool? Extra { get; set; }
            public GridFilterMode Mode { get; set; }
            public GridFilterableMessages Messages { get; }
            public GridFilterableOperators Operators { get; set; }

    Until the mentioned API documentation improvement becomes reality, or even afterwards, if you find the following method faster and easier, you can see the options in more detail in Visual Studio. Its intellisense gives you the available options. For example typing "." after filtering:

    .Filterable(filtering => filtering.)

    will bring up the the available options with more details on them: screenshot. You can then select an option, highlight it and navigate to its declaration with F12. This way you can check in more detail what parameters a specific option accepts.

    Regards,
    Ivan Danchev
    Progress Telerik

    Get quickly onboarded and successful with Telerik UI for ASP.NET Core with the dedicated Virtual Classroom technical training, available to all active customers.
  3. Aleks
    Aleks avatar
    20 posts
    Member since:
    Nov 2018

    Posted 22 Feb 2020 in reply to Ivan Danchev Link to this post

    Hi Ivan,

    Thanks for your reply.

    Whilst it's true that you can use Intellisense to see the available properties/methods of the action lambda, non of the options have descriptions, so that doesn't really help.

     

     

     

  4. Ivan Danchev
    Admin
    Ivan Danchev avatar
    2128 posts

    Posted 26 Feb 2020 Link to this post

    Hi Aleks,

    This is correct, and it is something we will look into improving.

    For the time being, I can suggest consulting the Kendo UI Grid's API documentation, since it better describes the various options. The ASP.NET Core Grid has the Kendo UI Grid under the hood (the Html helper is a wrapper of the Kendo UI widget), so, for the most part, there is parity in terms of options and functionality. The razor syntax the Core Grid uses is an alternative to initializing the Grid widget with JavaScript.

    You can find the Grid's client-side API here: https://docs.telerik.com/kendo-ui/api/javascript/ui/grid

    The column's filterable search option from the screenshot you posted, look like this in the API documentation: https://docs.telerik.com/kendo-ui/api/javascript/ui/grid/configuration/columns.filterable.search

     

    Regards,
    Ivan Danchev
    Progress Telerik

    Get quickly onboarded and successful with Telerik UI for ASP.NET Core with the dedicated Virtual Classroom technical training, available to all active customers.
Back to Top