namespace OSS.Application.WebServices
{

#nullable disable

    /*  NOTE: The NavMenu Component in the Shared folder is currently implemented using the TelerikTreeView Component. 
              The TelerikTreeView Component requires a data-model (eg 'TreeItem' list) containing certain properties. 
              If the properties are named the same as in the TelerikTreeView or TelerikBreadcrumb Components, then no assignments are required in the razor markup. 

              If these type Blazor Components are replaced then try to use the same TreeItem and BreadcrumbItem models. see the TreeItem.cs file for details. 
              Else, more extensive coding changes may be required. 
                Options for the 'Data' component parameter: 
        <TelerikTreeView>   TreeItem        qty 10: IdField,   ParentIdField, HasChildrenField, ItemsField, Level   (plus qty 5 of the BreadcrumbItem parameters) 
        <TelerikBreadcrumb> BreadcrumbItem  qty  5: TextField, ImageUrlField, IconField,    IconClassField, UrlField, 
                                            qty  3: Title,          Disabled, Class
     */


    /// <summary>
    /// The <see cref="TreeItem"/> data-model supports a TreeView type web component. <br/>
    /// Inherits all of the BreadcrumbItem property-fields. <br/>
    /// The <see cref="BreadcrumbItem"/> data-model supports Breadcrumb and TreeView web components. 
    /// 
    /// 
    ///  <list type = "bullet|number|table">
    ///     <listheader>
    ///         <term>Term</term>
    ///        <description>This is just a test/evaluation for using the 'List' XML comment.<br/>To see how it works.</description>
    ///    </listheader>
    ///     <item>
    ///         <term>Assembly</term>
    ///         <description>The library or executable built from a compilation.</description>
    ///     </item>
    ///     <item>
    ///         <term>Class</term>
    ///         <description>A unit of code.</description>
    ///     </item>
    /// </list>   
    /// 
    /// 
    /// </summary>
    public class TreeItem : BreadcrumbItem
    {
        //*** TreeItem Unique Identifer & Has Child Record(s) Flag **********
        /// <summary>
        /// Defines the Id DataField of the Datasource. 
        /// a unique id for a flat data structure.
        /// </summary>
        public int Id { get; set; }
        /// <summary>
        /// Defines the HasChildren DataField of the Datasource. 
        /// 'false' = has no decending child items.
        /// </summary>
        public bool HasChildren { get; set; }   // <-- NOTE: this may be only for flat data models


        //*** For Flat Data Models ******************************************
        /// <summary>
        /// Defines the ParentId DataField of the Datasource.<br/>
        /// Use this DataField when the component is bound to a flat data structure.<br/>
        /// (a self referencing id) if null then its the top parent)
        /// </summary>
        public int? ParentId { get; set; }


        //*** For Hierarchical Data Models **********************************
        /// <summary>
        /// Defines the Items DataField of the Datasource that contains the child nodes.
        /// </summary>
        public string Items { get; set; }
        /// <summary>
        /// Defines the Hierarchy Level of the Datasource that should apply bindings to.
        /// </summary>
        public string Level { get; set; }

    }

}



/*   TELERIK TREEVIEW

    Telerik Page:  https://docs.telerik.com/blazor-ui/components/treeview/data-binding/overview

Treeview Item Features: 

    *** Unique Id and Displayed Text ***
IdField           => Id
TextField         => Text          ###

    *** Item Relations *** 
HasChildrenField  => HasChildren
ParentIdField     => ParentId
ItemsField        => Items
Level             -

    *** Graphics *** 
ImageUrlField     => ImageUrl      ###
IconField         => Icon          ###
IconClassField    => IconClass     ###

    *** Naviation *** 
UrlField          => Url           ###


     NOTE:   '###' denotes are also properties of the Telerik BreadCrumb component too

     Level: Used for defining different bindings for different levels. 
            If no level is set, the bindings are taken as default for any level that does not have explicit settings. 
            You should have one TelerikTreeViewBinding without a level.
 */


/*   TELERIK BREADCRUMB

    Telerik Page:  https://docs.telerik.com/blazor-ui/components/breadcrumb/data-binding

Breadcrumb Item Features: 

    *** Displayed Text ***
TextField         => Text          ###
TitleField        => Title

    *** Functional & Text Rendering *** 
DisabledField     => Disabled
ClassField        => Class

    *** Graphics *** 
ImageUrlField     => ImageUrl      ###
IconField         => Icon          ###
IconClassField    => IconClass     ###

    *** Naviation *** 
UrlField          => Url           ###


     NOTE:   '###' denotes are also properties of the Telerik TreeView component too

 */