Class CellStyle

Represents cell style.

Inheritance

System.Object

CellStyle

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.Windows.Documents.Spreadsheet.PropertySystem

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class CellStyle

Properties

BottomBorder

Gets or sets the bottom border.

Declaration

public CellBorder BottomBorder { get; set; }

Property Value

CellBorder The bottom border.

BuiltInId

Gets the built in id.

Declaration

public int? BuiltInId { get; }

Property Value

System.Nullable<System.Int32> The built in id.

Category

Gets the category.

Declaration

public CellStyleCategory Category { get; }

Property Value

CellStyleCategory The category.

DiagonalDownBorder

Gets or sets the diagonal down border.

Declaration

public CellBorder DiagonalDownBorder { get; set; }

Property Value

CellBorder The diagonal down border.

DiagonalUpBorder

Gets or sets the diagonal up border.

Declaration

public CellBorder DiagonalUpBorder { get; set; }

Property Value

CellBorder The diagonal up border.

Fill

Gets or sets the fill.

Declaration

public IFill Fill { get; set; }

Property Value

IFill The fill value.

FontFamily

Gets or sets the font family.

Declaration

public ThemableFontFamily FontFamily { get; set; }

Property Value

ThemableFontFamily The font family.

FontSize

Gets or sets the size of the font.

Declaration

public double FontSize { get; set; }

Property Value

System.Double The size of the font.

ForeColor

Gets or sets the fore color.

Declaration

public ThemableColor ForeColor { get; set; }

Property Value

ThemableColor The fore color.

Format

Gets or sets the format.

Declaration

public CellValueFormat Format { get; set; }

Property Value

CellValueFormat The format.

HorizontalAlignment

Gets or sets the horizontal alignment.

Declaration

public RadHorizontalAlignment HorizontalAlignment { get; set; }

Property Value

RadHorizontalAlignment The horizontal alignment.

IncludeAlignment

Gets or sets a value indicating whether the alignment property group is included.

Declaration

public bool IncludeAlignment { get; set; }

Property Value

System.Boolean The value indicating whether the alignment property group is included.

IncludeBorder

Gets or sets a value indicating whether the border property group is included.

Declaration

public bool IncludeBorder { get; set; }

Property Value

System.Boolean The value indicating whether the border property group is included.

IncludeFill

Gets or sets a value indicating whether the fill property group is included.

Declaration

public bool IncludeFill { get; set; }

Property Value

System.Boolean The value indicating whether the fill property group is included.

IncludeFont

Gets or sets a value indicating whether the font property group is included.

Declaration

public bool IncludeFont { get; set; }

Property Value

System.Boolean The value indicating whether the font property group is included.

IncludeNumber

Gets or sets a value indicating whether the number property group is included.

Declaration

public bool IncludeNumber { get; set; }

Property Value

System.Boolean The value indicating whether the number property group is included.

IncludeProtection

Gets or sets a value indicating whether the protection property group is included.

Declaration

public bool IncludeProtection { get; set; }

Property Value

System.Boolean The value indicating whether the protection property group is included.

Indent

Gets or sets the indent.

Declaration

public int Indent { get; set; }

Property Value

System.Int32 The indent.

IsBold

Gets or sets a value indicating whether the text affected by the style is bold.

Declaration

public bool IsBold { get; set; }

Property Value

System.Boolean The value indicating whether the text affected by the style is bold..

IsItalic

Gets or sets a value indicating whether the text affected by the style is italic.

Declaration

public bool IsItalic { get; set; }

Property Value

System.Boolean The value indicating whether the text affected by the style is italic.

IsLocked

Gets or sets a value indicating whether the cell affected by the style is locked.

Declaration

public bool IsLocked { get; set; }

Property Value

System.Boolean The value indicating whether the cell affected by the style is locked.

IsRemovable

Gets a value indicating whether the style is removable.

Declaration

public bool IsRemovable { get; }

Property Value

System.Boolean The value indicating whether the style is removable.

IsRemoved

Gets a value indicating whether the style is removed.

Declaration

public bool IsRemoved { get; }

Property Value

System.Boolean The value indicating whether the style is removed.

IsUpdateInProgress

Gets a value indicating whether an update is in progress.

Declaration

public bool IsUpdateInProgress { get; }

Property Value

System.Boolean The value indicating whether an update is in progress.

IsWrapped

Gets or sets a value indicating whether the text affected by the style is wrapped.

Declaration

public bool IsWrapped { get; set; }

Property Value

System.Boolean The value indicating whether the text affected by the style is wrapped.

LeftBorder

Gets or sets the left border.

Declaration

public CellBorder LeftBorder { get; set; }

Property Value

CellBorder The left border.

Name

Gets the name.

Declaration

public string Name { get; }

Property Value

System.String The name of the style.

RightBorder

Gets or sets the right border.

Declaration

public CellBorder RightBorder { get; set; }

Property Value

CellBorder The right border.

TextRotation

Gets or sets the text rotation degree in the range -90 to 90.

Declaration

public int TextRotation { get; set; }

Property Value

System.Int32

TopBorder

Gets or sets the top border.

Declaration

public CellBorder TopBorder { get; set; }

Property Value

CellBorder The top border.

Underline

Gets or sets the underline.

Declaration

public UnderlineType Underline { get; set; }

Property Value

UnderlineType The underline.

VerticalAlignment

Gets or sets the vertical alignment.

Declaration

public RadVerticalAlignment VerticalAlignment { get; set; }

Property Value

RadVerticalAlignment The vertical alignment.

Workbook

Gets the workbook.

Declaration

public Workbook Workbook { get; }

Property Value

Workbook The workbook.

Methods

BeginUpdate()

Begins the update.

Declaration

public void BeginUpdate()

CopyPropertiesFrom(CellStyle)

Copies the style properties from another style.

Declaration

public void CopyPropertiesFrom(CellStyle fromStyle)

Parameters

CellStyle fromStyle From style.

CreateTempStyle()

Creates temporary style.

Declaration

public static CellStyle CreateTempStyle()

Returns

CellStyle The temporary style.

EndUpdate()

Ends the update.

Declaration

public void EndUpdate()

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration

public override bool Equals(object obj)

Parameters

System.Object obj The object to compare with the current object.

Returns

System.Boolean True if the specified System.Object is equal to the current System.Object; otherwise, false.

Overrides

System.Object.Equals(System.Object)

GetAllProperties()

Gets all properties.

Declaration

public static IEnumerable<IPropertyDefinition> GetAllProperties()

Returns

System.Collections.Generic.IEnumerable<IPropertyDefinition> All properties.

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()

GetIsPropertyIncluded(IPropertyDefinition)

Gets a value indicating if the property is included in the style.

Declaration

public bool GetIsPropertyIncluded(IPropertyDefinition propertyDefinition)

Parameters

IPropertyDefinition propertyDefinition The property definition.

Returns

System.Boolean The value indicating if the property is included in the style.

GetIsStylePropertyGroupIncluded(StylePropertyGroup)

Gets a value indicating whether the property group is included in cell style.

Declaration

public bool GetIsStylePropertyGroupIncluded(StylePropertyGroup stylePropertyGroup)

Parameters

StylePropertyGroup stylePropertyGroup The style property group.

Returns

System.Boolean The value indicating whether the property group is included in cell style.

GetPropertyValue<T>(IPropertyDefinition<T>)

Gets the property value.

Declaration

public T GetPropertyValue<T>(IPropertyDefinition<T> propertyDefinition)

Parameters

IPropertyDefinition<T> propertyDefinition The property definition.

Returns

T The property value.

Type Parameters

T The type of the T.

HasSameProperties(CellStyle)

Determines whether the specified other style has same properties.

Declaration

public bool HasSameProperties(CellStyle otherStyle)

Parameters

CellStyle otherStyle The other style.

Returns

System.Boolean True if has same properties.

IsPropertyValueSet<T>(IPropertyDefinition<T>)

Determines whether a value has been set for the specified property.

Declaration

public bool IsPropertyValueSet<T>(IPropertyDefinition<T> propertyDefinition)

Parameters

IPropertyDefinition<T> propertyDefinition The property definition.

Returns

System.Boolean True if has been set.

Type Parameters

T The type of the T.

IsSupportedProperty(IPropertyDefinition)

Determines whether the specified property definition is supported by the style.

Declaration

public static bool IsSupportedProperty(IPropertyDefinition propertyDefinition)

Parameters

IPropertyDefinition propertyDefinition The property definition.

Returns

System.Boolean True if supported.

OnChanged()

Called when the style is changed.

Declaration

protected virtual void OnChanged()

SetIsStylePropertyGroupIncluded(StylePropertyGroup, Boolean)

Sets a value indicating whether the property group is included in cell style.

Declaration

public void SetIsStylePropertyGroupIncluded(StylePropertyGroup stylePropertyGroup, bool value)

Parameters

StylePropertyGroup stylePropertyGroup The style property group.

System.Boolean value The value indicating whether the property group is included in cell style.

Events

Changed

Occurs when the style is changed.

Declaration

public event EventHandler<StyleChangedEventArgs> Changed

Event Type

System.EventHandler<StyleChangedEventArgs>