Back to Devexpress

GridFormatRule Members

windowsforms-devexpress-dot-xtragrid-dot-gridformatrule-dot-underscore-members.md

latest8.4 KB
Original Source

GridFormatRule Members

Specifies a single style format rule for a grid control’s View.

Constructors

NameDescription
GridFormatRule()Initializes a new instance of a GridFormatRule class.
GridFormatRule(FormatConditionRuleBase)Initializes a new instance of a GridFormatRule class with the specified style format rule.

Properties

NameDescription
ApplyToRowGets or sets whether the format is applied to an entire row.
CollectionGets the collection that owns the current GridFormatRule object.
ColumnGets or sets a column that provides values to test against the current format rule. By default, the format is applied to this column.
ColumnApplyToGets or sets a column, to which the format should be applied instead of the column specified by the GridFormatRule.Column property.
ColumnApplyToNameThis member supports the internal infrastructure, and is not intended to be used directly from your code.
ColumnFieldNameThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from FormatRuleBase.
ColumnNameThis member supports the internal infrastructure, and is not intended to be used directly from your code.
DescriptionGets or sets the text description of the format rule. Inherited from FormatRuleBase.
EnabledGets or sets whether the current FormatRuleBase object is enabled. Inherited from FormatRuleBase.
IsValidGets whether the current GridFormatRule object is properly customized.
NameGets or sets the name of the current object. Inherited from FormatRuleBase.
RuleGets or sets the style format rule, which defines the condition and appearance settings applied when the condition is true. Inherited from FormatRuleBase.
RuleTypeThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from FormatRuleBase.
StopIfTrueGets 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.
TagGets or sets custom data associated with the current FormatRuleBase object. Inherited from FormatRuleBase.

Methods

NameDescription
Assign(FormatRuleBase)Copies settings from the specified object to the current object.
Equals(Object, Object) staticDetermines 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.
GetFilterCriteria(Int32)Returns the filter criterion that corresponds to the format condition of this rule. Inherited from FormatRuleBase.
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(GridColumn, Int32)Returns whether the current format rule evaluates to “true” for the specified cell.
IsFit(Object, Int32)Returns whether the current format rule evaluates to “true” for the specified cell value in the specified row.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
QueryAppearance(GridColumn, Int32)Returns the appearance settings to apply to a specific cell.
ReferenceEquals(Object, Object) staticDetermines 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

GridFormatRule Class

DevExpress.XtraGrid Namespace