API Reference
Class
RuleOverview
A compact view of a rule for listing and export purposes.
Inheritance
- Object
- RuleOverview
Constructors
public RuleOverview(String Name, String DisplayName, RuleSourceType Type, Boolean Enabled, IReadOnlyList<Category> Categories, String Summary, String EnumMemberName, String EnumQualifiedName) #A compact view of a rule for listing and export purposes.
Parameters
- Name System.String
- The canonical rule name used by the engine.
- DisplayName System.String
- A friendly display name (may equal Name).
- Type TestimoX.Definitions.RuleSourceType
- Source type: CSharp or PowerShell.
- Enabled System.Boolean
- Whether the rule is enabled by default.
- Categories System.Collections.Generic.IReadOnlyList{TestimoX.Definitions.Category}
- Associated categories, if any.
- Summary System.String
- Short summary from guidance/description when available.
- EnumMemberName System.String
- Enum member name (e.g., "AdminInactive") when available.
- EnumQualifiedName System.String
- Qualified enum reference (e.g., "CSharpRule.AdminInactive").
Methods
public RuleOverview <Clone>$() #Returns:
RuleOverviewpublic Void Deconstruct(out String Name, out String DisplayName, out RuleSourceType Type, out Boolean Enabled, out IReadOnlyList<Category> Categories, out String Summary, out String EnumMemberName, out String EnumQualifiedName) #Returns:
VoidParameters
- Name String
- DisplayName String
- Type RuleSourceType
- Enabled Boolean
- Categories IReadOnlyList<Category>
- Summary String
- EnumMemberName String
- EnumQualifiedName String
public override Int32 GetHashCode() #Returns:
Int32public override String ToString() #Returns:
StringInherited Methods
Properties
public String Name { get; set; } #The canonical rule name used by the engine.
public String DisplayName { get; set; } #A friendly display name (may equal Name).
public RuleSourceType Type { get; set; } #Source type: CSharp or PowerShell.
public Boolean Enabled { get; set; } #Whether the rule is enabled by default.
public IReadOnlyList<Category> Categories { get; set; } #Associated categories, if any.
public String Summary { get; set; } #Short summary from guidance/description when available.
public String EnumMemberName { get; set; } #Enum member name (e.g., "AdminInactive") when available.
public String EnumQualifiedName { get; set; } #Qualified enum reference (e.g., "CSharpRule.AdminInactive").