Class BestPracticeCollection

Inheritance

object

BestPracticeCollection

Implements

IEnumerable<BestPracticeRule>

IEnumerable

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace

TabularEditor.Shared.BPA

Assembly

TabularEditor3.Shared.dll

public sealed class BestPracticeCollection : IEnumerable<BestPracticeRule>, IEnumerable

Extension Methods

ScriptHelper.Output(object)

Constructors

BestPracticeCollection()

public BestPracticeCollection()

Properties

AllowEdit

public bool AllowEdit { get; set; }

Property Value

Type	Description
bool

FilePath

public string FilePath { get; }

Property Value

Type	Description
string

Internal

public bool Internal { get; set; }

Property Value

Type	Description
bool

this[string]

public BestPracticeRule this[string ruleId] { get; }

Parameters

Type	Name	Description
string	ruleId

Property Value

Type	Description
BestPracticeRule

Name

public string Name { get; set; }

Property Value

Type	Description
string

Rules

public List<BestPracticeRule> Rules { get; }

Property Value

Type	Description
List<BestPracticeRule>

Url

public string Url { get; set; }

Property Value

Type	Description
string

Methods

Add(BestPracticeRule)

public void Add(BestPracticeRule rule)

Parameters

Type	Name	Description
BestPracticeRule	rule

AddFromJsonFile(string)

public void AddFromJsonFile(string filePath)

Parameters

Type	Name	Description
string	filePath

Contains(string)

public bool Contains(string Id)

Parameters

Type	Name	Description
string	Id

Returns

Type	Description
bool

GetCollectionFromFile(string, string)

public static BestPracticeCollection GetCollectionFromFile(string basePath, string fileName)

Parameters

Type	Name	Description
string	basePath
string	fileName

Returns

Type	Description
BestPracticeCollection

GetCollectionFromJson(string, string)

public static BestPracticeCollection GetCollectionFromJson(string url, string json)

Parameters

Type	Name	Description
string	url
string	json

Returns

Type	Description
BestPracticeCollection

GetCollectionFromUrlAsync(string)

public static Task<BestPracticeCollection> GetCollectionFromUrlAsync(string url)

Parameters

Type	Name	Description
string	url

Returns

Type	Description
Task<BestPracticeCollection>

GetCurrentModelCollection(Model)

public static BestPracticeCollection GetCurrentModelCollection(Model model)

Parameters

Type	Name	Description
Model	model

Returns

Type	Description
BestPracticeCollection

GetEnumerator()

public IEnumerator<BestPracticeRule> GetEnumerator()

Returns

Type	Description
IEnumerator<BestPracticeRule>

GetUrlAsync(string)

public static Task<string> GetUrlAsync(string url)

Parameters

Type	Name	Description
string	url

Returns

Type	Description
Task<string>

Save(string)

public bool Save(string basePath)

Parameters

Type	Name	Description
string	basePath

Returns

Type	Description
bool

SerializeToJson()

public string SerializeToJson()

Returns

Type	Description
string

ToString()

public override string ToString()

Returns

Type	Description
string