AppearanceObjectEx Class

Represents an appearance object with extended settings.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v18.1.dll

Declaration

C#

public class AppearanceObjectEx :
    AppearanceObject

VB.NET

Public Class AppearanceObjectEx
    Inherits AppearanceObject

Related API Members

The following members accept/return AppearanceObjectEx objects:

• BaseRow.Appearance
• FormatConditionRuleAppearanceBase.Appearance
• FormatConditionRuleDataBar.Appearance
• FormatConditionRuleDataBar.AppearanceNegative
• GridColumn.AppearanceCell
• StyleFormatConditionBase.Appearance
• StyleFormatConditionBase.AppearanceDescription
• TreeListColumn.AppearanceCell

Remarks

The AppearanceObjectEx is derived from the AppearanceObject class and extends its functionality. It introduces the AppearanceOptionsEx.HighPriority option which allows a higher priority to be specified for the appearance object. Currently, only the appearance settings provided by the columns (in XtraTreeList, XtraGrid, XtraVerticalGrid) and style conditions (in XtraGrid) are represented by the AppearanceObjectEx objects.

When an AppearanceObject’s style setting (for example, BackColor, ForeColor, Font and TextOptions.HAlignment) is set to a non-default value, the corresponding Options.Use… option (for instance, Options.UseBackColor, Options.UseForeColor, Options.UseFont and Options.UseTextOptions) is automatically set to true in the following cases:

• The AppearanceObject belongs to a control/component (or its element), and this control/component has been completely loaded (see the control’s IsLoading property to check the load status);
• The AppearanceObject belongs to a grid column/band or tree list column/band, and the column/band belongs to a grid/tree list control;
• The AppearanceObject is standalone, that is, it does not belong to any control or component.

In other cases, the Options.Use… options are not automatically enabled. You may need to enable these options manually for the style settings to be in effect.

For more information on appearances, see the Appearances document.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AppearanceObjectEx class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-change-appearance-priority-in-gridcontrol-e4869/CS/AppearancePrioritySample/MyGridControl/MyGridViewInfo.cs#L17

GridRowInfo bi,
DevExpress.Utils.AppearanceObjectEx column,
DevExpress.Utils.AppearanceObject focusedCell,

how-to-prevent-the-rowcellstyle-event-from-overriding-the-format-conditions-appearance-e1998/CS/GridView_PriorityRowCellStyle/CustomGridControl.cs#L124

{
    AppearanceObjectEx condition = null;
    AppearanceObject priorityStyle = ((CustomGridView)View).GetPriorityRowCellStyle(cell, cell.Appearance);

VB.NET

how-to-change-appearance-priority-in-gridcontrol-e4869/VB/AppearancePrioritySample/MyGridControl/MyGridViewInfo.vb#L16

Protected Overrides Function GetRowMixAppearances(ByVal cellInfo As GridCellInfo, ByVal state As GridRowCellState, ByVal bi As GridRowInfo, ByVal column As DevExpress.Utils.AppearanceObjectEx, ByVal focusedCell As DevExpress.Utils.AppearanceObject, ByVal conditionCell As DevExpress.Utils.AppearanceObjectEx) As DevExpress.Utils.AppearanceObject()
    Dim apps() As DevExpress.Utils.AppearanceObject = MyBase.GetRowMixAppearances(cellInfo, state, bi, column, focusedCell, conditionCell)

how-to-prevent-the-rowcellstyle-event-from-overriding-the-format-conditions-appearance-e1998/VB/GridView_PriorityRowCellStyle/CustomGridControl.vb#L165

If (cell.State And GridRowCellState.FocusedCell) = 0 OrElse (Not View.IsEditing) Then
    Dim condition As AppearanceObjectEx = Nothing
    Dim priorityStyle As AppearanceObject = (CType(View, CustomGridView)).GetPriorityRowCellStyle(cell, cell.Appearance)

Inheritance

Object

AppearanceObject

AppearanceObjectEx