Rule

References
public sealed class Rule : IEquatable<Rule>
A rule for modifying the distribution of proxies in the

Properties

Argument

#
public string Argument { get; }
Gets the argument (if any) for this rule.

Kind

#
public RuleKind Kind { get; }
Gets the rule kind.

Selector

#
public Selector Selector { get; }
Gets the selector text for proxies. It's a wildcard string which will be matched against 'Chapter.Section.Name' format.

Methods

CreateCiteRule

#
public static Rule CreateCiteRule(string ruleSet)
Create a CITE rule.
Parameters:
ruleSet (string)Ruleset to cite. Either "default" or some existing *.rules filename.

CreateHideRule

#
public static Rule CreateHideRule(Selector selector)
Create a HIDE rule.
Parameters:
selector (Selector)Selector pattern for proxies to hide.

CreateMoveRule

#
public static Rule CreateMoveRule(Selector selector, Selector target)
Create a MOVE rule.
Parameters:
selector (Selector)Selector pattern for proxies to move.
target (Selector)Target selector.

CreateNote

#
public static Rule CreateNote(string comment)
Create a comment.
Parameters:
comment (string)

CreateRankRule

#
public static Rule CreateRankRule(Selector selector, Rank rank)
Create a RANK rule.
Parameters:
selector (Selector)Selector pattern for proxies to rank.
rank (Rank)New rank.

CreateShowRule

#
public static Rule CreateShowRule(Selector selector)
Create a SHOW rule.
Parameters:
selector (Selector)Selector pattern for proxies to show.

CreateSlotRule

#
public static Rule CreateSlotRule(Selector selector, int slot)
Create a SLOT rule.
Parameters:
selector (Selector)Selector pattern for proxies to reslot.
slot (int)New slot index.

CreateSortRule

#
public static Rule CreateSortRule(Selector selector, string sortKey)
Create a SORT rule.
Parameters:
selector (Selector)Selector pattern for proxies to resort.
sortKey (string)New sorting key.

CreateTintRule

#
public static Rule CreateTintRule(Selector selector, string colourHint)
Create a TINT rule.
Parameters:
selector (Selector)Selector for tabs.
colourHint (string)Description of colour.

Equals

#
public bool Equals(Rule other)
Parameters:
other (Rule)

ToString

#
public override string ToString()
Returns a string that represents the current object.
Returns: A string that represents the current object.
Overrides: Object.ToString

TryParse

#
public static Rule TryParse(string command, out string failureReason)
Try and parse a textual command into a genuine rule.
Parameters:
command (string)Command string.
failureReason (out string)Failure reason in case of failed parsing.
Returns: Panel rule if parsing is successful.