Class TemplateFieldDefinition

Specification for a field in a bug template.

Inheritance

object

TemplateFieldDefinition

Implements

IEquatable<TemplateFieldDefinition>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Microsoft.Internal.Studios.Aruba.Infrastructure

Assembly: Aruba.Infrastructure.dll

Syntax

public class TemplateFieldDefinition : IEquatable<TemplateFieldDefinition>

Constructors

TemplateFieldDefinition()

Initializes a new instance of the TemplateFieldDefinition class.

Declaration

public TemplateFieldDefinition()

TemplateFieldDefinition(TemplateFieldDefinition)

Initializes a new instance of the TemplateFieldDefinition class.

Declaration

public TemplateFieldDefinition(TemplateFieldDefinition other)

Parameters

Type	Name	Description
TemplateFieldDefinition	other	The template field definition to copy.

Properties

DefaultValue

Gets or sets the default value for the field.

Declaration

public string DefaultValue { get; set; }

Property Value

Type	Description
string

DefaultValueToolTip

Gets the value of the tooltip to display the default value.

Declaration

[JsonIgnore]
public string DefaultValueToolTip { get; }

Property Value

Type	Description
string

DisplayName

Gets or sets the display name of the field to show in the Aruba UI.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
string

HasDefaultValue

Gets a value indicating whether the field has a default value.

Declaration

[JsonIgnore]
public bool HasDefaultValue { get; }

Property Value

Type	Description
bool

HelperText

Gets or sets the helper text for this field.

Declaration

[JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
public string HelperText { get; set; }

Property Value

Type	Description
string

Id

Gets the unique id for this instance of this field.

Declaration

[JsonIgnore]
public Guid Id { get; }

Property Value

Type	Description
Guid

IsFromParent

Gets or sets a value indicating whether this field is from a parent.

Declaration

[JsonIgnore]
public bool IsFromParent { get; set; }

Property Value

Type	Description
bool

Name

Gets or sets the field name, corresponding to the name of a field recognized by the bug service being used.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

OverrideParent

Gets or sets a value indicating whether this field should override the parent value.

Declaration

public bool OverrideParent { get; set; }

Property Value

Type	Description
bool

ParentField

Gets or sets the parent field.

Declaration

[JsonIgnore]
public TemplateFieldDefinition ParentField { get; set; }

Property Value

Type	Description
TemplateFieldDefinition

ParentTemplateId

Gets or sets the parent template id.

Declaration

[JsonIgnore]
public Guid ParentTemplateId { get; set; }

Property Value

Type	Description
Guid

UrgencyLevel

Gets or sets the urgency level specific to a template.

Declaration

[JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
public UrgencyLevel UrgencyLevel { get; set; }

Property Value

Type	Description
UrgencyLevel

ViewModel

Gets or sets the View Model object.

Declaration

[JsonIgnore]
public object ViewModel { get; set; }

Property Value

Type	Description
object

Methods

Equals(TemplateFieldDefinition)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(TemplateFieldDefinition other)

Parameters

Type	Name	Description
TemplateFieldDefinition	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

ToString()

Returns the name of the field definition.

Declaration

public override string ToString()

Returns

Type	Description
string	The name of the field definition.

Overrides

object.ToString()

Implements

IEquatable<T>