63 lines
2.9 KiB
C#
63 lines
2.9 KiB
C#
// Copyright (c) .NET Foundation. All rights reserved.
|
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
|
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using Microsoft.Extensions.Localization;
|
|
|
|
namespace Microsoft.AspNetCore.Mvc.Localization
|
|
{
|
|
/// <summary>
|
|
/// Represents a type that that does HTML-aware localization of strings, by HTML encoding arguments that are
|
|
/// formatted in the resource string.
|
|
/// </summary>
|
|
public interface IHtmlLocalizer
|
|
{
|
|
/// <summary>
|
|
/// Gets the string resource with the given name.
|
|
/// </summary>
|
|
/// <param name="name">The name of the string resource.</param>
|
|
/// <returns>The string resource as a <see cref="LocalizedHtmlString"/>.</returns>
|
|
LocalizedHtmlString this[string name] { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the string resource with the given name and formatted with the supplied arguments. The arguments will
|
|
/// be HTML encoded.
|
|
/// </summary>
|
|
/// <param name="name">The name of the string resource.</param>
|
|
/// <param name="arguments">The values to format the string with.</param>
|
|
/// <returns>The formatted string resource as a <see cref="LocalizedHtmlString"/>.</returns>
|
|
LocalizedHtmlString this[string name, params object[] arguments] { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the string resource with the given name.
|
|
/// </summary>
|
|
/// <param name="name">The name of the string resource.</param>
|
|
/// <returns>The string resource as a <see cref="LocalizedString"/>.</returns>
|
|
LocalizedString GetString(string name);
|
|
|
|
/// <summary>
|
|
/// Gets the string resource with the given name and formatted with the supplied arguments.
|
|
/// </summary>
|
|
/// <param name="name">The name of the string resource.</param>
|
|
/// <param name="arguments">The values to format the string with.</param>
|
|
/// <returns>The formatted string resource as a <see cref="LocalizedString"/>.</returns>
|
|
LocalizedString GetString(string name, params object[] arguments);
|
|
|
|
/// <summary>
|
|
/// Gets all string resources.
|
|
/// </summary>
|
|
/// <param name="includeParentCultures">
|
|
/// A <see cref="System.Boolean"/> indicating whether to include strings from parent cultures.
|
|
/// </param>
|
|
/// <returns>The strings.</returns>
|
|
IEnumerable<LocalizedString> GetAllStrings(bool includeParentCultures);
|
|
|
|
/// <summary>
|
|
/// Creates a new <see cref="IHtmlLocalizer"/> for a specific <see cref="CultureInfo"/>.
|
|
/// </summary>
|
|
/// <param name="culture">The <see cref="CultureInfo"/> to use.</param>
|
|
/// <returns>A culture-specific <see cref="IHtmlLocalizer"/>.</returns>
|
|
IHtmlLocalizer WithCulture(CultureInfo culture);
|
|
}
|
|
} |