Class BestPracticeCollection

Inheritance
object
BestPracticeCollection
Implements
Inherited Members
Namespace: TabularEditor.Shared.BPA
Assembly: TabularEditor3.Shared.dll
Syntax
public sealed class BestPracticeCollection : IEnumerable<BestPracticeRule>, IEnumerable

Constructors

BestPracticeCollection()

Declaration
public BestPracticeCollection()

Properties

AllowEdit

Declaration
public bool AllowEdit { get; set; }
Property Value
Type Description
bool

FilePath

Declaration
public string FilePath { get; }
Property Value
Type Description
string

Internal

Declaration
public bool Internal { get; set; }
Property Value
Type Description
bool

this[string]

Declaration
public BestPracticeRule this[string ruleId] { get; }
Parameters
Type Name Description
string ruleId
Property Value
Type Description
BestPracticeRule

Name

Declaration
public string Name { get; set; }
Property Value
Type Description
string

Rules

Declaration
public List<BestPracticeRule> Rules { get; }
Property Value
Type Description
List<BestPracticeRule>

Url

Declaration
public string Url { get; set; }
Property Value
Type Description
string

Methods

Add(BestPracticeRule)

Declaration
public void Add(BestPracticeRule rule)
Parameters
Type Name Description
BestPracticeRule rule

AddFromJsonFile(string)

Declaration
public void AddFromJsonFile(string filePath)
Parameters
Type Name Description
string filePath

Contains(string)

Declaration
public bool Contains(string Id)
Parameters
Type Name Description
string Id
Returns
Type Description
bool

GetCollectionFromFile(string, string)

Declaration
public static BestPracticeCollection GetCollectionFromFile(string basePath, string fileName)
Parameters
Type Name Description
string basePath
string fileName
Returns
Type Description
BestPracticeCollection

GetCollectionFromJson(string, string)

Declaration
public static BestPracticeCollection GetCollectionFromJson(string url, string json)
Parameters
Type Name Description
string url
string json
Returns
Type Description
BestPracticeCollection

GetCollectionFromUrlAsync(string)

Declaration
public static Task<BestPracticeCollection> GetCollectionFromUrlAsync(string url)
Parameters
Type Name Description
string url
Returns
Type Description
Task<BestPracticeCollection>

GetCurrentModelCollection(Model)

Declaration
public static BestPracticeCollection GetCurrentModelCollection(Model model)
Parameters
Type Name Description
Model model
Returns
Type Description
BestPracticeCollection

GetEnumerator()

Declaration
public IEnumerator<BestPracticeRule> GetEnumerator()
Returns
Type Description
IEnumerator<BestPracticeRule>

GetUrlAsync(string)

Declaration
public static Task<string> GetUrlAsync(string url)
Parameters
Type Name Description
string url
Returns
Type Description
Task<string>

Save(string)

Declaration
public bool Save(string basePath)
Parameters
Type Name Description
string basePath
Returns
Type Description
bool

SerializeToJson()

Declaration
public string SerializeToJson()
Returns
Type Description
string

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods