Class BaseFormattingObject

Contains information about the formatting properties to apply.

Inheritance
System.Object
BaseFormattingObject
ConditionalFormattingObject
ExpressionFormattingObject
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class BaseFormattingObject : ICloneable, INotifyPropertyChanged, INotifyPropertyChangingEx, IEquatable<BaseFormattingObject>

Constructors

BaseFormattingObject()

Creates a new instance of the BaseFormattingObject class.

Declaration
public BaseFormattingObject()

BaseFormattingObject(String, Boolean)

Creates a new instance of the BaseFormattingObject class.

Declaration
public BaseFormattingObject(string name, bool applyToRow)
Parameters
System.String name

Formatting object name.
System.Boolean applyToRow

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
public bool ApplyOnSelectedRows { get; set; }
Property Value
System.Boolean

ApplyToRow

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

Declaration
public bool ApplyToRow { get; set; }
Property Value
System.Boolean

CellBackColor

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

Declaration
public Color CellBackColor { get; set; }
Property Value
System.Drawing.Color

CellFont

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

Declaration
public Font CellFont { get; set; }
Property Value
System.Drawing.Font

CellForeColor

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

Declaration
public Color CellForeColor { get; set; }
Property Value
System.Drawing.Color

Enabled

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

Declaration
public bool Enabled { get; set; }
Property Value
System.Boolean

Name

Gets or sets a value containing condition's name

Declaration
public string Name { get; set; }
Property Value
System.String

RowBackColor

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

Declaration
public Color RowBackColor { get; set; }
Property Value
System.Drawing.Color

RowFont

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

Declaration
public Font RowFont { get; set; }
Property Value
System.Drawing.Font

RowForeColor

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

Declaration
public Color RowForeColor { get; set; }
Property Value
System.Drawing.Color

RowTextAlignment

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

Declaration
public ContentAlignment RowTextAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

TextAlignment

Gets or sets a value indicating what TextAlignment to apply

Declaration
public ContentAlignment TextAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

Methods

Clone()

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

Declaration
public virtual object Clone()
Returns
System.Object

Implements
System.ICloneable.Clone()

Copy(BaseFormattingObject)

Copies the source's settings to this instance.

Declaration
public virtual void Copy(BaseFormattingObject source)
Parameters
BaseFormattingObject source

Equals(Object)

Checks whether a BaseFormattingObject is equal by content.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The BaseFormattingObject to compare with.
Returns
System.Boolean

true if the content is equal.
Overrides
System.Object.Equals(System.Object)

Equals(BaseFormattingObject)

Returns whether the BaseFormattingObject equals the specified format.

Declaration
public bool Equals(BaseFormattingObject format)
Parameters
BaseFormattingObject format

The format.
Returns
System.Boolean

Implements
System.IEquatable<T>.Equals(T)

Evaluate(GridViewRowInfo, GridViewColumn)

Evaluates the condition or expression of the formatting object.

Declaration
public virtual bool Evaluate(GridViewRowInfo row, GridViewColumn column)
Parameters
GridViewRowInfo row

RadGridView row.
GridViewColumn column

RadGridView column.
Returns
System.Boolean

Returns true if the formatting object should apply.

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

IsValueSet(String)

Determines whether a non-default value is specified for the

Declaration
public bool IsValueSet(string propName)
Parameters
System.String propName

Returns
System.Boolean

OnPropertyChanged(String)

Raises the PropertyChanged event.

Declaration
protected virtual void OnPropertyChanged(string propertyName)
Parameters
System.String propertyName

The property name.

OnPropertyChanging(String)

Raises the PropertyChanging event.

Declaration
protected virtual bool OnPropertyChanging(string propertyName)
Parameters
System.String propertyName

The property name.
Returns
System.Boolean

true when the property value should be changed.

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

PropertyChanging

Occurs when a property value is changing.

Declaration
public event PropertyChangingEventHandlerEx PropertyChanging
Event Type
PropertyChangingEventHandlerEx

Implements

Extension Methods