Table of Contents

Class BpaResult

Inheritance
BpaResult
Inherited Members
Namespace
TabularEditor.Shared.Scripting
Assembly
TabularEditor3.Shared.dll

Result of evaluating a single BPA rule against a model object.

public class BpaResult
Extension Methods

Constructors

BpaResult()

public BpaResult()

Properties

CanFix

Whether this violation can be auto-fixed.

public bool CanFix { get; }

Property Value

Type Description
bool

Category

public string Category { get; init; }

Property Value

Type Description
string

Description

public string Description { get; init; }

Property Value

Type Description
string

FixExpression

The fix expression for this rule (if any).

public string FixExpression { get; init; }

Property Value

Type Description
string

Object

Reference to the violating TOM object (for fix expression execution). Not serialized to JSON.

public TabularNamedObject Object { get; init; }

Property Value

Type Description
TabularNamedObject

ObjectName

public string ObjectName { get; init; }

Property Value

Type Description
string

ObjectType

public string ObjectType { get; init; }

Property Value

Type Description
string

RuleId

public string RuleId { get; init; }

Property Value

Type Description
string

RuleName

public string RuleName { get; init; }

Property Value

Type Description
string

Severity

public int Severity { get; init; }

Property Value

Type Description
int

SeverityLabel

public string SeverityLabel { get; init; }

Property Value

Type Description
string