Interface IExcelWorker

Namespace

Ecng.Interop

Assembly

Ecng.Interop.dll

Defines a contract for working with Excel files, providing methods to manipulate cells, styles, sheets, and formatting.

public interface IExcelWorker : IDisposable

Inherited Members

IDisposable.Dispose()

Extension Methods

AsyncHelper.FromResult<TValue>(TValue)

AsyncHelper.ToCompleteSource<TValue>(TValue)

CompareHelper.IsDefault<T>(T)

CompareHelper.IsRuntimeDefault<T>(T)

Converter.TypedTo<TFrom, TTo>(TFrom)

DelegateHelper.AddDelegate<TDelegate>(TDelegate, TDelegate)

DelegateHelper.GetInvocationList<TDelegate>(TDelegate)

DelegateHelper.RemoveAllDelegates<TDelegate>(TDelegate)

DelegateHelper.RemoveDelegate<TDelegate>(TDelegate, TDelegate)

DisposableHelper.MakeDisposable<T>(T, Action<T>)

Enumerator.IsDefined<T>(T)

Enumerator.SplitMask<T>(T)

NullableHelper.Convert<T, TResult>(T, Func<T, TResult>, Func<TResult>)

NullableHelper.IsNull<T>(T)

NullableHelper.IsNull<T>(T, bool)

TupleHelper.ToValues<T>(T)

TypeHelper.CheckOnNull<T>(T, string)

TypeHelper.DoDispose<TSource>(TSource)

TypeHelper.ToScope<T>(T, bool)

NetworkHelper.Format<T>(T, bool)

PersistableHelper.TrySerialize<T>(T, out SettingsStorage)

XamlHelper.CopyToClipboard<T>(T)

Paths.SerializeToString<T>(T, bool)

Paths.Serialize<T>(T, bool)

Paths.Serialize<T>(T, string, bool)

CompareHelper.Compare(object, object)

Converter.To(object, Type)

Converter.To<T>(object)

Enumerator.GetAttributeOfType<TAttribute>(object)

Enumerator.IsEnumBrowsable(object)

Enumerator.SplitMask2(object)

TypeHelper.HasProperty(object, string)

EntityPropertyHelper.GetPropValue(object, string, Func<object, string, object>, IDictionary<string, object>)

Extensions.GetBasicProperties(object, int)

Extensions.GetDisplayName(object)

Extensions.GetFieldDescription(object)

Extensions.GetFieldDisplayName(object)

Extensions.GetFieldIcon(object)

JsonHelper.ToJson(object, bool)

JsonHelper.ToJson(object, bool, JsonSerializerSettings)

PersistableHelper.ToStorage(object, bool)

EditorExtensions.ToItemsSource(object, Type, bool?, ListSortDirection?, Func<IItemsSourceItem, bool>, Func<object, string>, Func<object, string>)

XamlHelper.EnsureUIThread(object)

XamlHelper.ShowModel<TWindow>(object, DependencyObject)

XamlHelper.WpfCast<T>(object)

VirtualPropertyRegistry.TryGetVirtualValue(object, string, out object)

Methods

AddSheet()

Adds a new sheet to the workbook.

IExcelWorker AddSheet()

Returns

IExcelWorker

The current IExcelWorker instance for method chaining.

ContainsSheet(string)

Checks if a sheet with the specified name exists in the workbook.

bool ContainsSheet(string name)

Parameters

name string

The name of the sheet to check.

Returns

bool

true if the sheet exists; otherwise, false.

GetCell<T>(int, int)

Gets the value of a cell at the specified column and row.

T GetCell<T>(int col, int row)

Parameters

col int

The column index (1-based).

row int

The row index (1-based).

Returns

T

The value of the cell cast to type T.

Type Parameters

T

The type of the value to retrieve.

GetColumnsCount()

Gets the total number of columns in the current sheet.

int GetColumnsCount()

Returns

int

The number of columns.

GetRowsCount()

Gets the total number of rows in the current sheet.

int GetRowsCount()

Returns

int

The number of rows.

RenameSheet(string)

Renames the current sheet to the specified name.

IExcelWorker RenameSheet(string name)

Parameters

name string

The new name for the sheet.

Returns

IExcelWorker

The current IExcelWorker instance for method chaining.

SetCell<T>(int, int, T)

Sets the value of a cell at the specified column and row.

IExcelWorker SetCell<T>(int col, int row, T value)

Parameters

col int

The column index (1-based).

row int

The row index (1-based).

value T

The value to set in the cell.

Returns

IExcelWorker

The current IExcelWorker instance for method chaining.

Type Parameters

T

The type of the value to set.

SetConditionalFormatting(int, ComparisonOperator, string, string, string)

Sets conditional formatting for a column based on a condition.

IExcelWorker SetConditionalFormatting(int col, ComparisonOperator op, string condition, string bgColor, string fgColor)

Parameters

col int

The column index (1-based).

op ComparisonOperator

The ComparisonOperator to use for the condition.

condition string

The condition value as a string.

bgColor string

The background color to apply if the condition is met (e.g., hex code or name).

fgColor string

The foreground (text) color to apply if the condition is met (e.g., hex code or name).

Returns

IExcelWorker

The current IExcelWorker instance for method chaining.

SetStyle(int, string)

Sets the style of a column using a custom format string.

IExcelWorker SetStyle(int col, string format)

Parameters

col int

The column index (1-based).

format string

The format string to apply to the column.

Returns

IExcelWorker

The current IExcelWorker instance for method chaining.

SetStyle(int, Type)

Sets the style of a column based on a specified type.

IExcelWorker SetStyle(int col, Type type)

Parameters

col int

The column index (1-based).

type Type

The Type that determines the style.

Returns

IExcelWorker

The current IExcelWorker instance for method chaining.

SwitchSheet(string)

Switches the active sheet to the one with the specified name.

IExcelWorker SwitchSheet(string name)

Parameters

name string

The name of the sheet to switch to.

Returns

IExcelWorker

The current IExcelWorker instance for method chaining.