113 lines
4.3 KiB
C#
113 lines
4.3 KiB
C#
using System;
|
|
using Umbraco.Core.Exceptions;
|
|
|
|
namespace Umbraco.Core.PropertyEditors
|
|
{
|
|
/// <summary>
|
|
/// Marks a ConfigurationEditor property as a configuration field, and a class as a configuration field type.
|
|
/// </summary>
|
|
/// <remarks>Properties marked with this attribute are discovered as fields.</remarks>
|
|
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Class)]
|
|
public class ConfigurationFieldAttribute : Attribute
|
|
{
|
|
private Type _type;
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="ConfigurationField"/> class.
|
|
/// </summary>
|
|
public ConfigurationFieldAttribute(Type type)
|
|
{
|
|
Type = type;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="ConfigurationField"/> class.
|
|
/// </summary>
|
|
/// <param name="key">The unique identifier of the field.</param>
|
|
/// <param name="name">The friendly name of the field.</param>
|
|
/// <param name="view">The view to use to render the field editor.</param>
|
|
public ConfigurationFieldAttribute(string key, string name, string view)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(key)) throw new ArgumentNullOrEmptyException(nameof(key));
|
|
Key = key;
|
|
|
|
if (string.IsNullOrWhiteSpace(name)) throw new ArgumentNullOrEmptyException(nameof(name));
|
|
Name = name;
|
|
|
|
if (string.IsNullOrWhiteSpace(view)) throw new ArgumentNullOrEmptyException(nameof(view));
|
|
View = view;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="ConfigurationField"/> class.
|
|
/// </summary>
|
|
/// <param name="name">The friendly name of the field.</param>
|
|
/// <param name="view">The view to use to render the field editor.</param>
|
|
/// <remarks>When no key is specified, the <see cref="ConfigurationEditor"/> will derive a key
|
|
/// from the name of the property marked with this attribute.</remarks>
|
|
public ConfigurationFieldAttribute(string name, string view)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(name)) throw new ArgumentNullOrEmptyException(nameof(name));
|
|
Name = name;
|
|
|
|
if (string.IsNullOrWhiteSpace(view)) throw new ArgumentNullOrEmptyException(nameof(view));
|
|
View = view;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the key of the field.
|
|
/// </summary>
|
|
/// <remarks>When null or empty, the <see cref="ConfigurationEditor"/> should derive a key
|
|
/// from the name of the property marked with this attribute.</remarks>
|
|
public string Key { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the friendly name of the field.
|
|
/// </summary>
|
|
public string Name { get; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the view to use to render the field editor.
|
|
/// </summary>
|
|
public string View { get; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the description of the field.
|
|
/// </summary>
|
|
public string Description { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets a value indicating whether the field editor should be displayed without its label.
|
|
/// </summary>
|
|
public bool HideLabel
|
|
{
|
|
get => HideLabelSettable.ValueOrDefault(false);
|
|
set => HideLabelSettable.Set(value);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the settable underlying <see cref="HideLabel"/>.
|
|
/// </summary>
|
|
public Settable<bool> HideLabelSettable { get; } = new Settable<bool>();
|
|
|
|
/// <summary>
|
|
/// Gets or sets the type of the field.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>By default, fields are created as <see cref="ConfigurationField"/> instances,
|
|
/// unless specified otherwise through this property.</para>
|
|
/// <para>The specified type must inherit from <see cref="ConfigurationField"/>.</para>
|
|
/// </remarks>
|
|
public Type Type
|
|
{
|
|
get => _type;
|
|
set
|
|
{
|
|
if (!typeof(ConfigurationField).IsAssignableFrom(value))
|
|
throw new ArgumentException("Type must inherit from ConfigurationField.", nameof(value));
|
|
_type = value;
|
|
}
|
|
}
|
|
}
|
|
}
|