Skip to main content
All docs
V24.1

VGridFormatRule Members

Specifies a rule that contains a condition and appearance settings applied to a row if the condition is met.

Constructors

Name Description
VGridFormatRule() Initializes a new instance of the VGridFormatRule class.

Properties

Name Description
ApplyToRecord Gets or sets whether to apply appearance settings to all rows in the record.
ColumnFieldName This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from FormatRuleBase.
Description Gets or sets the text description of the format rule. Inherited from FormatRuleBase.
Enabled Gets or sets whether the current FormatRuleBase object is enabled. Inherited from FormatRuleBase.
IsValid Gets whether the rule can be applied.
Name Gets or sets the name of the current object. Inherited from FormatRuleBase.
RowProperties Gets or sets a row that contains values against which the rule’s condition is evaluated and to which the format is applied.
RowPropertiesApplyTo Gets or sets the row to which the format is applied if the rule’s condition is met. Allows you to evaluate the condition against one row but apply the format to another row.
RowPropertiesApplyToFieldName This property supports internal infrastructure and is not intended to be used in code.
RowPropertiesFieldName This property supports internal infrastructure and is not intended to be used in code.
Rule Gets or sets the style format rule, which defines the condition and appearance settings applied when the condition is true. Inherited from FormatRuleBase.
RuleType This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from FormatRuleBase.
StopIfTrue Gets or sets whether subsequent format rules that target a specific cell should be ignored if the current format rule evaluates to true for this cell. Inherited from FormatRuleBase.
Tag Gets or sets custom data associated with the current FormatRuleBase object. Inherited from FormatRuleBase.
VGrid Gets the Vertical Grid control that owns this rule.

Methods

Name Description
Assign(FormatRuleBase) Assigns the specified object’s property values to the current object’s corresponding properties.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
IsFit() Inherited from FormatRuleBase.
IsFit(IFormatConditionRuleValueProvider) Returns whether the current rule (FormatRuleBase.Rule) evaluates to “true” for input values provided by the specified valueProvider. Inherited from FormatRuleBase.
IsFit(BaseRow, Int32) Returns whether the current format rule evaluates to “true” for the specified cell.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
QueryAppearance(BaseRow, Int32) Returns the appearance settings to apply to a specific cell.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RuleCast<T>() Returns the FormatRuleBase.Rule object type-cast to the specified type. Inherited from FormatRuleBase.
ToString() Returns the text representation of the current FormatRuleBase object. Inherited from FormatRuleBase.
See Also