Class
BaseFormattingObject

Contains information about the formatting properties to apply.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

cs-api-definition
[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.

Declaration

cs-api-definition
public BaseFormattingObject()

BaseFormattingObject(string, bool)

Creates a new instance of the BaseFormattingObject class.

Declaration

cs-api-definition
public BaseFormattingObject(string name, bool applyToRow)

Parameters

name

string

Formatting object name.

applyToRow

bool

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.

Declaration

cs-api-definition
public bool ApplyOnSelectedRows { get; set; }

Property Value

bool

ApplyToRow

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

Declaration

cs-api-definition
public bool ApplyToRow { get; set; }

Property Value

bool

CellBackColor

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

Declaration

cs-api-definition
public Color CellBackColor { get; set; }

Property Value

Color

CellFont

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

Declaration

cs-api-definition
public Font CellFont { get; set; }

Property Value

Font

CellForeColor

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

Declaration

cs-api-definition
public Color CellForeColor { get; set; }

Property Value

Color

Enabled

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

Declaration

cs-api-definition
public bool Enabled { get; set; }

Property Value

bool

Name

Gets or sets a value containing condition's name

Declaration

cs-api-definition
public string Name { get; set; }

Property Value

string

RowBackColor

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

Declaration

cs-api-definition
public Color RowBackColor { get; set; }

Property Value

Color

RowFont

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

Declaration

cs-api-definition
public Font RowFont { get; set; }

Property Value

Font

RowForeColor

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

Declaration

cs-api-definition
public Color RowForeColor { get; set; }

Property Value

Color

RowTextAlignment

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

Declaration

cs-api-definition
public ContentAlignment RowTextAlignment { get; set; }

Property Value

ContentAlignment

TextAlignment

Gets or sets a value indicating what TextAlignment to apply

Declaration

cs-api-definition
public ContentAlignment TextAlignment { get; set; }

Property Value

ContentAlignment

Methods

Clone()

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

Declaration

cs-api-definition
public virtual object Clone()

Returns

object

Implements ICloneable.Clone()

Copy(BaseFormattingObject)

Copies the source's settings to this instance.

Declaration

cs-api-definition
public virtual void Copy(BaseFormattingObject source)

Parameters

source

BaseFormattingObject

Equals(BaseFormattingObject)

Returns whether the BaseFormattingObject equals the specified format.

Declaration

cs-api-definition
public bool Equals(BaseFormattingObject format)

Parameters

format

BaseFormattingObject

The format.

Returns

bool

Implements IEquatable<BaseFormattingObject>.Equals(BaseFormattingObject)

Equals(object)

Checks whether a BaseFormattingObject is equal by content.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

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.

Declaration

cs-api-definition
public virtual bool Evaluate(GridViewRowInfo row, GridViewColumn column)

Parameters

row

GridViewRowInfo

RadGridView row.

column

GridViewColumn

RadGridView column.

Returns

bool

Returns true if the formatting object should apply.

GetHashCode()

Serves as a hash function for a particular type.

Declaration

cs-api-definition
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

Declaration

cs-api-definition
public bool IsValueSet(string propName)

Parameters

propName

string

Returns

bool

OnPropertyChanged(string)

Raises the PropertyChanged event.

Declaration

cs-api-definition
protected virtual void OnPropertyChanged(string propertyName)

Parameters

propertyName

string

The property name.

OnPropertyChanging(string)

Raises the PropertyChanging event.

Declaration

cs-api-definition
protected virtual bool OnPropertyChanging(string propertyName)

Parameters

propertyName

string

The property name.

Returns

bool

true when the property value should be changed.

Events

PropertyChanged

Occurs when a property value changes.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged

PropertyChanging

Occurs when a property value is changing.

Declaration

cs-api-definition
public event PropertyChangingEventHandlerEx PropertyChanging

Event Value

PropertyChangingEventHandlerEx

Implements INotifyPropertyChangingEx.PropertyChanging