Webiant Logo Webiant Logo
  1. No results found.

    Try your search with a different keyword or use * as a wildcard.

INopHtmlHelper.cs

using Microsoft.AspNetCore.Html;

namespace Nop.Web.Framework.UI;

/// 
/// Represents a HTML helper
/// 
public partial interface INopHtmlHelper
{
    /// 
    /// Add title element to the ]]>
    /// 
    /// Title part
    void AddTitleParts(string part);

    /// 
    /// Append title element to the ]]>
    /// 
    /// Title part
    void AppendTitleParts(string part);

    /// 
    /// Generate all title parts
    /// 
    /// A value indicating whether to insert a default title
    /// Title part
    /// A task that represents the asynchronous operation
    /// The task result contains generated HTML string
    Task GenerateTitleAsync(bool addDefaultTitle = true, string part = "");

    /// 
    /// Add meta description element to the ]]>
    /// 
    /// Meta description part
    void AddMetaDescriptionParts(string part);

    /// 
    /// Append meta description element to the ]]>
    /// 
    /// Meta description part
    void AppendMetaDescriptionParts(string part);

    /// 
    /// Generate all description parts
    /// 
    /// Meta description part
    /// A task that represents the asynchronous operation
    /// The task result contains generated HTML string
    Task GenerateMetaDescriptionAsync(string part = "");

    /// 
    /// Add meta keyword element to the ]]>
    /// 
    /// Meta keyword part
    void AddMetaKeywordParts(string part);

    /// 
    /// Append meta keyword element to the ]]>
    /// 
    /// Meta keyword part
    void AppendMetaKeywordParts(string part);

    /// 
    /// Generate all keyword parts
    /// 
    /// Meta keyword part
    /// A task that represents the asynchronous operation
    /// The task result contains generated HTML string
    Task GenerateMetaKeywordsAsync(string part = "");

    /// 
    /// Add script element
    /// 
    /// A location of the script element
    /// Script path (minified version)
    /// Script path (full debug version). If empty, then minified version will be used
    /// A value indicating whether to exclude this script from bundling
    void AddScriptParts(ResourceLocation location, string src, string debugSrc = "", bool excludeFromBundle = false);

    /// 
    /// Append script element
    /// 
    /// A location of the script element
    /// Script path (minified version)
    /// Script path (full debug version). If empty, then minified version will be used
    /// A value indicating whether to exclude this script from bundling
    void AppendScriptParts(ResourceLocation location, string src, string debugSrc = "", bool excludeFromBundle = false);

    /// 
    /// Generate all script parts
    /// 
    /// A location of the script element
    /// Generated HTML string
    IHtmlContent GenerateScripts(ResourceLocation location);

    /// 
    /// Add inline script element
    /// 
    /// A location of the script element
    /// Script
    void AddInlineScriptParts(ResourceLocation location, string script);

    /// 
    /// Append inline script element
    /// 
    /// A location of the script element
    /// Script
    void AppendInlineScriptParts(ResourceLocation location, string script);

    /// 
    /// Generate all inline script parts
    /// 
    /// A location of the script element
    /// Generated HTML string
    IHtmlContent GenerateInlineScripts(ResourceLocation location);

    /// 
    /// Add CSS element
    /// 
    /// Script path (minified version)
    /// Script path (full debug version). If empty, then minified version will be used
    /// A value indicating whether to exclude this style sheet from bundling
    void AddCssFileParts(string src, string debugSrc = "", bool excludeFromBundle = false);

    /// 
    /// Append CSS element
    /// 
    /// Script path (minified version)
    /// Script path (full debug version). If empty, then minified version will be used
    /// A value indicating whether to exclude this style sheet from bundling
    void AppendCssFileParts(string src, string debugSrc = "", bool excludeFromBundle = false);

    /// 
    /// Generate all CSS parts
    /// 
    /// Generated HTML string
    IHtmlContent GenerateCssFiles();

    /// 
    /// Add canonical URL element to the ]]>
    /// 
    /// Canonical URL part
    /// Whether to use canonical URLs with query string parameters
    void AddCanonicalUrlParts(string part, bool withQueryString = false);

    /// 
    /// Append canonical URL element to the ]]>
    /// 
    /// Canonical URL part
    void AppendCanonicalUrlParts(string part);

    /// 
    /// Generate all canonical URL parts
    /// 
    /// Generated HTML string
    IHtmlContent GenerateCanonicalUrls();

    /// 
    /// Add any custom element to the ]]> element
    /// 
    /// The entire element. For example, ]]>
    void AddHeadCustomParts(string part);

    /// 
    /// Append any custom element to the ]]> element
    /// 
    /// The entire element. For example, ]]>
    void AppendHeadCustomParts(string part);

    /// 
    /// Generate all custom elements
    /// 
    /// Generated HTML string
    IHtmlContent GenerateHeadCustom();

    /// 
    /// Add CSS class to the ]]> element
    /// 
    /// CSS class
    void AddPageCssClassParts(string part);

    /// 
    /// Append CSS class to the ]]> element
    /// 
    /// CSS class
    void AppendPageCssClassParts(string part);

    /// 
    /// Generate all title parts
    /// 
    /// CSS class
    /// Generated string
    string GeneratePageCssClasses(string part = "");

    /// 
    /// Specify "edit page" URL
    /// 
    /// URL
    void AddEditPageUrl(string url);

    /// 
    /// Get "edit page" URL
    /// 
    /// URL
    string GetEditPageUrl();

    /// 
    /// Specify system name of admin menu item that should be selected (expanded)
    /// 
    /// System name
    void SetActiveMenuItemSystemName(string systemName);

    /// 
    /// Get system name of admin menu item that should be selected (expanded)
    /// 
    /// System name
    string GetActiveMenuItemSystemName();

    /// 
    /// Get the route name associated with the request rendering this page
    /// 
    /// A value indicating whether to build the name using engine information unless otherwise specified
    /// Route name
    string GetRouteName(bool handleDefaultRoutes = false);
}