Class ValueFormatAttribute

Namespace: CapyKit.Attributes
Assembly: CapyKit.dll

Custom attribute for formatting values in a specific way.

[AttributeUsage(AttributeTargets.Property)]
public class ValueFormatAttribute : Attribute

Inheritance

object ← Attribute ← ValueFormatAttribute

Inherited Members

Attribute.Equals(object?), Attribute.GetCustomAttribute(Assembly, Type), Attribute.GetCustomAttribute(Assembly, Type, bool), Attribute.GetCustomAttribute(MemberInfo, Type), Attribute.GetCustomAttribute(MemberInfo, Type, bool), Attribute.GetCustomAttribute(Module, Type), Attribute.GetCustomAttribute(Module, Type, bool), Attribute.GetCustomAttribute(ParameterInfo, Type), Attribute.GetCustomAttribute(ParameterInfo, Type, bool), Attribute.GetCustomAttributes(Assembly), Attribute.GetCustomAttributes(Assembly, bool), Attribute.GetCustomAttributes(Assembly, Type), Attribute.GetCustomAttributes(Assembly, Type, bool), Attribute.GetCustomAttributes(MemberInfo), Attribute.GetCustomAttributes(MemberInfo, bool), Attribute.GetCustomAttributes(MemberInfo, Type), Attribute.GetCustomAttributes(MemberInfo, Type, bool), Attribute.GetCustomAttributes(Module), Attribute.GetCustomAttributes(Module, bool), Attribute.GetCustomAttributes(Module, Type), Attribute.GetCustomAttributes(Module, Type, bool), Attribute.GetCustomAttributes(ParameterInfo), Attribute.GetCustomAttributes(ParameterInfo, bool), Attribute.GetCustomAttributes(ParameterInfo, Type), Attribute.GetCustomAttributes(ParameterInfo, Type, bool), Attribute.GetHashCode(), Attribute.IsDefaultAttribute(), Attribute.IsDefined(Assembly, Type), Attribute.IsDefined(Assembly, Type, bool), Attribute.IsDefined(MemberInfo, Type), Attribute.IsDefined(MemberInfo, Type, bool), Attribute.IsDefined(Module, Type), Attribute.IsDefined(Module, Type, bool), Attribute.IsDefined(ParameterInfo, Type), Attribute.IsDefined(ParameterInfo, Type, bool), Attribute.Match(object?), Attribute.TypeId, object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Extension Methods

ObjectExtensions.UpdateProperties<ValueFormatAttribute>(ValueFormatAttribute, ValueFormatAttribute), ObjectExtensions.UpdateProperties(object, object)

Constructors

ValueFormatAttribute()

Default constructor. Initializes a new instance of the CapyKit.Attributes.ValueFormatAttribute class with an empty format string.

public ValueFormatAttribute()

ValueFormatAttribute(string)

Constructor. Initializes a new instance of the CapyKit.Attributes.ValueFormatAttribute class with the specified format string.

public ValueFormatAttribute(string format)

Parameters

format string

The format string used to format the value.

Properties

Format

Gets or sets the format to use for formatting the value.

public string Format { get; }

Property Value

string

Methods

GetFormatParameterizedString(int)

Gets a parameterized formatted string for the specified index.

public string GetFormatParameterizedString(int index = 0)

Parameters

index int

(Optional) Zero-based index of the item in the string to format.

Returns

string

A formatted string with the specified index and format.