Class SelectionBase

Represents base for the selection classes.

Inheritance

System.Object

SelectionBase

CellSelection

RowColumnSelectionBase

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Spreadsheet.Model

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class SelectionBase

Properties

CellRanges

Gets the cell ranges.

Declaration

public IEnumerable<CellRange> CellRanges { get; }

Property Value

System.Collections.Generic.IEnumerable<CellRange> The cell ranges.

Worksheet

Gets the worksheet.

Declaration

public Worksheet Worksheet { get; }

Property Value

Worksheet The worksheet.

Methods

BeginUpdate()

Begins the update.

Declaration

protected void BeginUpdate()

Clear(ClearType)

Clears the properties using the specified type of clear.

Declaration

public void Clear(ClearType type)

Parameters

ClearType type The type of clear.

ClearBorders()

Clears the borders.

Declaration

public void ClearBorders()

ClearFill()

Clears the fill.

Declaration

public void ClearFill()

ClearFontFamily()

Clears the font family.

Declaration

public void ClearFontFamily()

ClearFontSize()

Clears the size of the font.

Declaration

public void ClearFontSize()

ClearForeColor()

Clears the font color.

Declaration

public void ClearForeColor()

ClearFormat()

Clears the format.

Declaration

public void ClearFormat()

ClearHorizontalAlignment()

Clears the horizontal alignment.

Declaration

public void ClearHorizontalAlignment()

ClearIndent()

Clears the indent.

Declaration

public void ClearIndent()

ClearIsBold()

Clears the bold property.

Declaration

public void ClearIsBold()

ClearIsItalic()

Clears the italic property.

Declaration

public void ClearIsItalic()

ClearIsLocked()

Clears the is locked property.

Declaration

public void ClearIsLocked()

ClearIsWrapped()

Clears the text wrapping.

Declaration

public void ClearIsWrapped()

ClearStyleName()

Clears the name of the style.

Declaration

public void ClearStyleName()

ClearTextRotation()

Clears the text rotation.

Declaration

public void ClearTextRotation()

ClearUnderline()

Clears the underline.

Declaration

public void ClearUnderline()

ClearVerticalAlignment()

Clears the vertical alignment.

Declaration

public void ClearVerticalAlignment()

DecreaseIndent()

Decreases the indent.

Declaration

public void DecreaseIndent()

EndUpdate()

Ends the update.

Declaration

protected void EndUpdate()

ExecuteForEachRange(Action<CellRange>)

Executes for each range.

Declaration

protected void ExecuteForEachRange(Action<CellRange> action)

Parameters

System.Action<CellRange> action The action.

ExecuteForEachRange(IEnumerable<CellRange>, Action<CellRange>, Predicate<CellRange>)

Executes for each range.

Declaration

protected bool ExecuteForEachRange(IEnumerable<CellRange> cellRanges, Action<CellRange> action, Predicate<CellRange> canExecute = null)

Parameters

System.Collections.Generic.IEnumerable<CellRange> cellRanges The cell ranges.

System.Action<CellRange> action The action.

System.Predicate<CellRange> canExecute The can execute.

Returns

System.Boolean

ExecuteForEachRangeInsideBeginEndUpdate(Action<CellRange>)

Executes for each range inside begin end update.

Declaration

protected void ExecuteForEachRangeInsideBeginEndUpdate(Action<CellRange> action)

Parameters

System.Action<CellRange> action The action.

ExecuteForEachRangeInsideBeginEndUpdate(IEnumerable<CellRange>, Action<CellRange>, Predicate<CellRange>)

Executes for each range inside begin end update.

Declaration

protected bool ExecuteForEachRangeInsideBeginEndUpdate(IEnumerable<CellRange> cellRanges, Action<CellRange> action, Predicate<CellRange> canExecute = null)

Parameters

System.Collections.Generic.IEnumerable<CellRange> cellRanges The cell ranges.

System.Action<CellRange> action The action.

System.Predicate<CellRange> canExecute The can execute.

Returns

System.Boolean

GetBorders()

Gets the borders.

Declaration

public CellBorders GetBorders()

Returns

CellBorders The cell borders.

GetFill()

Gets the fill.

Declaration

public RangePropertyValue<IFill> GetFill()

Returns

RangePropertyValue<IFill> The fill value for the selection.

GetFontFamily()

Gets the font family.

Declaration

public RangePropertyValue<ThemableFontFamily> GetFontFamily()

Returns

RangePropertyValue<ThemableFontFamily> The font family for the selection.

GetFontSize()

Gets the size of the font.

Declaration

public RangePropertyValue<double> GetFontSize()

Returns

RangePropertyValue<System.Double> The font size for the selection.

GetForeColor()

Gets the font color.

Declaration

public RangePropertyValue<ThemableColor> GetForeColor()

Returns

RangePropertyValue<ThemableColor> The font color for the selection.

GetFormat()

Gets the format.

Declaration

public RangePropertyValue<CellValueFormat> GetFormat()

Returns

RangePropertyValue<CellValueFormat> The format for the selection.

GetHorizontalAlignment()

Gets the horizontal alignment.

Declaration

public RangePropertyValue<RadHorizontalAlignment> GetHorizontalAlignment()

Returns

RangePropertyValue<RadHorizontalAlignment> The horizontal alignment for the selection.

GetIndent()

Gets the indent.

Declaration

public RangePropertyValue<int> GetIndent()

Returns

RangePropertyValue<System.Int32> The indent for the selection.

GetIsBold()

Gets the value indicating whether the font is bold.

Declaration

public RangePropertyValue<bool> GetIsBold()

Returns

RangePropertyValue<System.Boolean> The value indicating whether the font is bold for the selection.

GetIsItalic()

Gets the value indicating whether the font is italic.

Declaration

public RangePropertyValue<bool> GetIsItalic()

Returns

RangePropertyValue<System.Boolean> The value indicating whether the font is italic for the selection.

GetIsLocked()

Gets the value indicating whether the selection is locked.

Declaration

public RangePropertyValue<bool> GetIsLocked()

Returns

RangePropertyValue<System.Boolean> The value indicating whether the selection is locked.

GetIsWrapped()

Gets a value indicating whether text wrapping is used.

Declaration

public RangePropertyValue<bool> GetIsWrapped()

Returns

RangePropertyValue<System.Boolean> The value indicating whether text wrapping is used.

GetPropertyValue<T>(Func<CellRange, RangePropertyValue<T>>, IEnumerable<CellRange>, T)

Gets the property value.

Declaration

protected RangePropertyValue<T> GetPropertyValue<T>(Func<CellRange, RangePropertyValue<T>> getRangePropertyValue, IEnumerable<CellRange> cellRanges, T defaultValue)

Parameters

System.Func<CellRange, RangePropertyValue<T>> getRangePropertyValue The get range property value.

System.Collections.Generic.IEnumerable<CellRange> cellRanges The cell ranges.

T defaultValue The default value.

Returns

RangePropertyValue<T>

Type Parameters

T The type of the T.

GetStyleName()

Gets the name of the style.

Declaration

public RangePropertyValue<string> GetStyleName()

Returns

RangePropertyValue<System.String> The name of the style for the selection.

GetTextRotation()

Gets the text rotation.

Declaration

public RangePropertyValue<int> GetTextRotation()

Returns

RangePropertyValue<System.Int32> The text rotation degree for the selection in range -90 to 90.

GetTopLeftCellIndex()

Gets the index of the top left cell.

Declaration

protected CellIndex GetTopLeftCellIndex()

Returns

CellIndex

GetUnderline()

Gets the underline.

Declaration

public RangePropertyValue<UnderlineType> GetUnderline()

Returns

RangePropertyValue<UnderlineType> The underline property for the selection.

GetVerticalAlignment()

Gets the vertical alignment.

Declaration

public RangePropertyValue<RadVerticalAlignment> GetVerticalAlignment()

Returns

RangePropertyValue<RadVerticalAlignment> The vertical alignment for the selection.

IncreaseIndent()

Increases the indent.

Declaration

public void IncreaseIndent()

SetBorders(CellBorders)

Sets the borders.

Declaration

public virtual void SetBorders(CellBorders value)

Parameters

CellBorders value The value.

SetFill(IFill)

Sets the fill.

Declaration

public void SetFill(IFill value)

Parameters

IFill value The value.

SetFontFamily(ThemableFontFamily)

Sets the font family.

Declaration

public void SetFontFamily(ThemableFontFamily value)

Parameters

ThemableFontFamily value The value.

SetFontSize(Double)

Sets the size of the font.

Declaration

public void SetFontSize(double value)

Parameters

System.Double value The value.

SetForeColor(ThemableColor)

Sets the font color.

Declaration

public void SetForeColor(ThemableColor value)

Parameters

ThemableColor value The value.

SetFormat(CellValueFormat)

Sets the format.

Declaration

public void SetFormat(CellValueFormat value)

Parameters

CellValueFormat value The value.

SetHorizontalAlignment(RadHorizontalAlignment)

Sets the horizontal alignment.

Declaration

public void SetHorizontalAlignment(RadHorizontalAlignment value)

Parameters

RadHorizontalAlignment value The value.

SetIndent(Int32)

Sets the indent.

Declaration

public void SetIndent(int value)

Parameters

System.Int32 value The value.

SetIsBold(Boolean)

Sets the value indicating whether the font is bold.

Declaration

public void SetIsBold(bool value)

Parameters

System.Boolean value The value.

SetIsItalic(Boolean)

Sets the value indicating whether the font is italic.

Declaration

public void SetIsItalic(bool value)

Parameters

System.Boolean value The value.

SetIsLocked(Boolean)

Sets the value indicating whether the selection is locked.

Declaration

public void SetIsLocked(bool value)

Parameters

System.Boolean value The value.

SetIsWrapped(Boolean)

Sets a value indicating whether text wrapping is used.

Declaration

public void SetIsWrapped(bool value)

Parameters

System.Boolean value The value.

SetStyleName(String)

Sets the name of the style.

Declaration

public void SetStyleName(string value)

Parameters

System.String value The value.

SetTextRotation(Int32)

Sets the text rotation.

Declaration

public void SetTextRotation(int value)

Parameters

System.Int32 value The rotation degree in the range -90 to 90.

SetUnderline(UnderlineType)

Sets the underline.

Declaration

public void SetUnderline(UnderlineType value)

Parameters

UnderlineType value The value.

SetVerticalAlignment(RadVerticalAlignment)

Sets the vertical alignment.

Declaration

public void SetVerticalAlignment(RadVerticalAlignment value)

Parameters

RadVerticalAlignment value The value.