Back to all docs
API Reference / Telerik.WinControls.UI / BaseFormattingObject
New to Telerik UI for WinForms? Start a free 30-day trial

BaseFormattingObject

Class

Contains information about the formatting properties to apply.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:
C#
[Browsable(false)]
public class BaseFormattingObject : ICloneable, INotifyPropertyChanged, INotifyPropertyChangingEx, IEquatable<BaseFormattingObject>

Inheritance: objectBaseFormattingObject

Derived Classes: ConditionalFormattingObjectExpressionFormattingObject

Implements: ICloneableIEquatable<BaseFormattingObject>INotifyPropertyChangedINotifyPropertyChangingEx

Constructors

BaseFormattingObject()

Creates a new instance of the BaseFormattingObject class.

C#
public BaseFormattingObject()

BaseFormattingObject(string, bool)

Creates a new instance of the BaseFormattingObject class.

C#
public BaseFormattingObject(string name, bool applyToRow)
Parameters:namestring

Formatting object name.

applyToRowbool

Determines if the condition should be applied on a row.

Properties

ApplyOnSelectedRows

Gets or sets a value indicating whether the condition should be applied on selected rows.

C#
public bool ApplyOnSelectedRows { get; set; }

ApplyToRow

Gets or sets a value indicating that the condition should be applied on a row

C#
public bool ApplyToRow { get; set; }

CellBackColor

Gets or sets a value indicating what BackColor to apply on the cell

C#
public Color CellBackColor { get; set; }

CellFont

Gets or sets a value indicating what Font to apply on the cell.

C#
public Font CellFont { get; set; }

CellForeColor

Gets or sets a value indicating what ForeColor to apply on the cell

C#
public Color CellForeColor { get; set; }

Enabled

Determines whether the condition is enabled (can be evaluated and applied).

C#
public bool Enabled { get; set; }

Name

Gets or sets a value containing condition's name

C#
public string Name { get; set; }

RowBackColor

Gets or sets a value indicating what BackColor to apply on the row

C#
public Color RowBackColor { get; set; }

RowFont

Gets or sets a value indicating what Font to apply on the row.

C#
public Font RowFont { get; set; }

RowForeColor

Gets or sets a value indicating what ForeColor to apply on the row

C#
public Color RowForeColor { get; set; }

RowTextAlignment

Determines what TextAlignment to apply to child cells when ApplyToRow is true.

C#
public ContentAlignment RowTextAlignment { get; set; }

TextAlignment

Gets or sets a value indicating what TextAlignment to apply

C#
public ContentAlignment TextAlignment { get; set; }

Methods

Clone()

Creates a new object that is a copy of the current instance.

C#
public virtual object Clone()
Returns:

object

Implements: ICloneable.Clone()

Copy(BaseFormattingObject)

Copies the source's settings to this instance.

C#
public virtual void Copy(BaseFormattingObject source)
Parameters:sourceBaseFormattingObject

Equals(BaseFormattingObject)

Returns whether the BaseFormattingObject equals the specified format.

C#
public bool Equals(BaseFormattingObject format)
Parameters:formatBaseFormattingObject

The format.

Returns:

bool

Implements: IEquatable<BaseFormattingObject>.Equals(BaseFormattingObject)

Equals(object)

Checks whether a BaseFormattingObject is equal by content.

C#
public override bool Equals(object obj)
Parameters:objobject

The BaseFormattingObject to compare with.

Returns:

bool

true if the content is equal.

Overrides: object.Equals(object)

Evaluate(GridViewRowInfo, GridViewColumn)

Evaluates the condition or expression of the formatting object.

C#
public virtual bool Evaluate(GridViewRowInfo row, GridViewColumn column)
Parameters:rowGridViewRowInfo

RadGridView row.

columnGridViewColumn

RadGridView column.

Returns:

bool

Returns true if the formatting object should apply.

GetHashCode()

Serves as a hash function for a particular type.

C#
public override int GetHashCode()
Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

IsValueSet(string)

Determines whether a non-default value is specified for the

C#
public bool IsValueSet(string propName)
Parameters:propNamestringReturns:

bool

OnPropertyChanged(string)

Raises the PropertyChanged event.

C#
protected virtual void OnPropertyChanged(string propertyName)
Parameters:propertyNamestring

The property name.

OnPropertyChanging(string)

Raises the PropertyChanging event.

C#
protected virtual bool OnPropertyChanging(string propertyName)
Parameters:propertyNamestring

The property name.

Returns:

bool

true when the property value should be changed.

Events

PropertyChanged

Occurs when a property value changes.

C#
public event PropertyChangedEventHandler PropertyChanged

Implements: INotifyPropertyChanged.PropertyChanged

PropertyChanging

Occurs when a property value is changing.

C#
public event PropertyChangingEventHandlerEx PropertyChanging

Implements: INotifyPropertyChangingEx.PropertyChanging

In this article
DefinitionConstructorsBaseFormattingObject()BaseFormattingObject(string, bool)PropertiesApplyOnSelectedRowsApplyToRowCellBackColorCellFontCellForeColorEnabledNameRowBackColorRowFontRowForeColorRowTextAlignmentTextAlignmentMethodsClone()Copy(BaseFormattingObject)Equals(BaseFormattingObject)Equals(object)Evaluate(GridViewRowInfo, GridViewColumn)GetHashCode()IsValueSet(string)OnPropertyChanged(string)OnPropertyChanging(string)EventsPropertyChangedPropertyChanging
Not finding the help you need?
Contact Support