API Reference
Class
ExcelRange
Lightweight object model wrapper for an A1 range.
Inheritance
- Object
- ExcelRange
Usage
Explore 80 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 80
- Method ExcelRange.ApplyAutoFilter
- Method ExcelRange.Clear
- Method ExcelRange.ClearAutoFilter
- Method ExcelRange.Currency
- Method ExcelRange.Date
- Method ExcelRange.DateTime
- Method ExcelRange.DurationHours
- Method ExcelRange.Error
- Method ExcelRange.HeaderStyle
- Method ExcelRange.Integer
- Method ExcelRange.Merge
- Method ExcelRange.MutedText
- Method ExcelRange.Number
- Method ExcelRange.Percent
- Method ExcelRange.SetBaseline
- Method ExcelRange.SetBold
- Method ExcelRange.SetFillColor
- Method ExcelRange.SetFontColor
- Method ExcelRange.SetFontName
- Method ExcelRange.SetFontSize
- Method ExcelRange.SetGradientFill
- Method ExcelRange.SetItalic
- Method ExcelRange.SetNumberFormat
- Method ExcelRange.SetShrinkToFit
- Method ExcelRange.SetStrikethrough
- Method ExcelRange.SetSubscript
- Method ExcelRange.SetSuperscript
- Method ExcelRange.SetTextRotation
- Method ExcelRange.SetUnderline
- Method ExcelRange.SetVerticalTextAlignment
- Method ExcelRange.SortByColumn
- Method ExcelRange.Success
- Method ExcelRange.Text
- Method ExcelRange.Time
- Method ExcelRange.TransformTextCase
- Method ExcelRange.Unmerge
- Method ExcelRange.Warning
- Method ExcelRangeConditionalFormattingBuilder.AboveAverage
- Method ExcelRangeConditionalFormattingBuilder.BeginsWith
- Method ExcelRangeConditionalFormattingBuilder.BeginsWithText
- Method ExcelRangeConditionalFormattingBuilder.BelowAverage
- Method ExcelRangeConditionalFormattingBuilder.Between
- Method ExcelRangeConditionalFormattingBuilder.Blanks
- Method ExcelRangeConditionalFormattingBuilder.Bottom
- Method ExcelRangeConditionalFormattingBuilder.CellIs
- Method ExcelRangeConditionalFormattingBuilder.Clear
- Method ExcelRangeConditionalFormattingBuilder.ColorScale
- Method ExcelRangeConditionalFormattingBuilder.ContainsText
- Method ExcelRangeConditionalFormattingBuilder.DataBar
- Method ExcelRangeConditionalFormattingBuilder.DuplicateValues
- Method ExcelRangeConditionalFormattingBuilder.EndsWith
- Method ExcelRangeConditionalFormattingBuilder.EndsWithText
- Method ExcelRangeConditionalFormattingBuilder.Errors
- Method ExcelRangeConditionalFormattingBuilder.Formula
- Method ExcelRangeConditionalFormattingBuilder.GreaterThan
- Method ExcelRangeConditionalFormattingBuilder.IconSet
- Method ExcelRangeConditionalFormattingBuilder.LessThan
- Method ExcelRangeConditionalFormattingBuilder.NonBlanks
- Method ExcelRangeConditionalFormattingBuilder.NonErrors
- Method ExcelRangeConditionalFormattingBuilder.NotContainsText
- Method ExcelRangeConditionalFormattingBuilder.TimePeriod
- Method ExcelRangeConditionalFormattingBuilder.Top
- Method ExcelRangeConditionalFormattingBuilder.UniqueValues
- Method ExcelRangeDataValidationBuilder.Clear
- Method ExcelRangeDataValidationBuilder.CustomFormula
- Method ExcelRangeDataValidationBuilder.Date
- Method ExcelRangeDataValidationBuilder.DateBetween
- Method ExcelRangeDataValidationBuilder.Decimal
- Method ExcelRangeDataValidationBuilder.DecimalBetween
- Method ExcelRangeDataValidationBuilder.List
- Method ExcelRangeDataValidationBuilder.ListNamedRange
- Method ExcelRangeDataValidationBuilder.ListRange
- Method ExcelRangeDataValidationBuilder.Messages
- Method ExcelRangeDataValidationBuilder.TextLength
- Method ExcelRangeDataValidationBuilder.Time
- Method ExcelRangeDataValidationBuilder.WholeNumber
- Method ExcelRangeDataValidationBuilder.WholeNumberBetween
- Method ExcelSheet.Range
- Method ExcelTable.AsRange
- Method ExcelTable.Column
Methods
public ExcelRange ApplyAutoFilter(Dictionary<UInt32, IEnumerable<String>>? filterCriteria = null) #Returns:
ExcelRangeApplies AutoFilter to the range using optional zero-based column criteria.
Parameters
- filterCriteria System.Collections.Generic.Dictionary<System.UInt32, System.Collections.Generic.IEnumerable<System.String>>? = null
public ExcelRange Clear(ExcelClearOptions options = All) #Returns:
ExcelRangeClears selected data and metadata from the range.
Parameters
- options OfficeIMO.Excel.ExcelClearOptions = All
public ExcelMutationResult CopyTo(String destinationTopLeft, ExcelMutationPlanOptions? options = null, CancellationToken cancellationToken = default) #Returns:
ExcelMutationResultCopies this range to a destination top-left cell.
Parameters
- destinationTopLeft System.String
- options OfficeIMO.Excel.ExcelMutationPlanOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public ExcelTable CreateTable(String name, Boolean hasHeader = true, ExcelTableStyle style = TableStyleMedium2, Boolean includeAutoFilter = true) #Returns:
ExcelTableCreates an Excel table over the range.
Parameters
- name System.String
- hasHeader System.Boolean = true
- style OfficeIMO.Excel.ExcelTableStyle = TableStyleMedium2
- includeAutoFilter System.Boolean = true
public ExcelRangeVisualSnapshot CreateVisualSnapshot(ExcelImageExportOptions? options = null) #Returns:
ExcelRangeVisualSnapshotCreates a format-neutral visual snapshot for this range.
Parameters
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public ExcelRange Currency(Int32 decimals = 2, CultureInfo? culture = null) #Returns:
ExcelRangeApplies a currency number format.
Parameters
- decimals System.Int32 = 2
- culture System.Globalization.CultureInfo? = null
public ExcelRange Date(String pattern = "yyyy-mm-dd") #Returns:
ExcelRangeApplies a date number format.
Parameters
- pattern System.String = "yyyy-mm-dd"
public ExcelRange DateTime(String pattern = "yyyy-mm-dd hh:mm:ss") #Returns:
ExcelRangeApplies a date/time number format.
Parameters
- pattern System.String = "yyyy-mm-dd hh:mm:ss"
public ExcelMutationResult Delete(ExcelCellShiftDirection direction, ExcelMutationPlanOptions? options = null, CancellationToken cancellationToken = default) #Returns:
ExcelMutationResultTransactionally deletes this cell block.
Parameters
- direction OfficeIMO.Excel.ExcelCellShiftDirection
- options OfficeIMO.Excel.ExcelMutationPlanOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public OfficeImageExportResult ExportImage(OfficeImageExportFormat format, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
OfficeImageExportResultExports this range as a supported raster format or SVG.
Parameters
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public ExcelMutationResult Insert(ExcelCellShiftDirection direction, ExcelMutationPlanOptions? options = null, CancellationToken cancellationToken = default) #Returns:
ExcelMutationResultTransactionally inserts a cell block at this range.
Parameters
- direction OfficeIMO.Excel.ExcelCellShiftDirection
- options OfficeIMO.Excel.ExcelMutationPlanOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public ExcelRange Integer() #Returns:
ExcelRangeApplies a whole-number format with thousands separators.
public ExcelMutationResult MoveTo(String destinationTopLeft, ExcelMutationPlanOptions? options = null, CancellationToken cancellationToken = default) #Returns:
ExcelMutationResultMoves this range to a destination top-left cell.
Parameters
- destinationTopLeft System.String
- options OfficeIMO.Excel.ExcelMutationPlanOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public ExcelRange Number(Int32 decimals = 2) #Returns:
ExcelRangeApplies a decimal number format.
Parameters
- decimals System.Int32 = 2
public ExcelRange Percent(Int32 decimals = 0) #Returns:
ExcelRangeApplies a percent number format.
Parameters
- decimals System.Int32 = 0
SaveAsJpeg 2 overloads
public OfficeImageExportResult SaveAsJpeg(String path, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultSaves this range as JPEG.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public OfficeImageExportResult SaveAsJpeg(Stream stream, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultWrites this range as JPEG.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
SaveAsJpegAsync 2 overloads
public Task<OfficeImageExportResult> SaveAsJpegAsync(String path, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously saves this range as JPEG.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Task<OfficeImageExportResult> SaveAsJpegAsync(Stream stream, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously writes this range as JPEG.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsPng 2 overloads
public OfficeImageExportResult SaveAsPng(String path, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultSaves this range as a PNG file.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public OfficeImageExportResult SaveAsPng(Stream stream, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultWrites this range as PNG to a stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
SaveAsPngAsync 2 overloads
public Task<OfficeImageExportResult> SaveAsPngAsync(String path, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously saves this range as a PNG file.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Task<OfficeImageExportResult> SaveAsPngAsync(Stream stream, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously writes this range as PNG to a stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsSvg 2 overloads
public OfficeImageExportResult SaveAsSvg(String path, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultSaves this range as an SVG file.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public OfficeImageExportResult SaveAsSvg(Stream stream, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultWrites this range as SVG to a stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
SaveAsSvgAsync 2 overloads
public Task<OfficeImageExportResult> SaveAsSvgAsync(String path, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously saves this range as an SVG file.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Task<OfficeImageExportResult> SaveAsSvgAsync(Stream stream, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously writes this range as SVG to a stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsTiff 2 overloads
public OfficeImageExportResult SaveAsTiff(String path, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultSaves this range as TIFF.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public OfficeImageExportResult SaveAsTiff(Stream stream, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultWrites this range as TIFF.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
SaveAsTiffAsync 2 overloads
public Task<OfficeImageExportResult> SaveAsTiffAsync(String path, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously saves this range as TIFF.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Task<OfficeImageExportResult> SaveAsTiffAsync(Stream stream, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously writes this range as TIFF.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsWebp 2 overloads
public OfficeImageExportResult SaveAsWebp(String path, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultSaves this range as lossless WebP.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public OfficeImageExportResult SaveAsWebp(Stream stream, ExcelImageExportOptions? options = null) #Returns:
OfficeImageExportResultWrites this range as lossless WebP.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
SaveAsWebpAsync 2 overloads
public Task<OfficeImageExportResult> SaveAsWebpAsync(String path, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously saves this range as lossless WebP.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Task<OfficeImageExportResult> SaveAsWebpAsync(Stream stream, ExcelImageExportOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously writes this range as lossless WebP.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public ExcelRange SetBaseline() #Returns:
ExcelRangeRestores every cell in the range to the normal baseline.
public ExcelRange SetBold(Boolean bold = true) #Returns:
ExcelRangeSets or clears bold font style for every cell in the range.
Parameters
- bold System.Boolean = true
public ExcelRange SetFillColor(String hexColor) #Returns:
ExcelRangeApplies a fill color to every cell in the range.
Parameters
- hexColor System.String
public ExcelRange SetFontColor(String hexColor) #Returns:
ExcelRangeApplies a font color to every cell in the range.
Parameters
- hexColor System.String
public ExcelRange SetFontName(String fontName) #Returns:
ExcelRangeApplies a font family name to every cell in the range.
Parameters
- fontName System.String
public ExcelRange SetFontSize(Double fontSize) #Returns:
ExcelRangeApplies a font size in points to every cell in the range.
Parameters
- fontSize System.Double
public ExcelRange SetGradientFill(String fromHexColor, String toHexColor, Double degree = 0) #Returns:
ExcelRangeApplies a two-color linear gradient fill to every cell in the range.
Parameters
- fromHexColor System.String
- toHexColor System.String
- degree System.Double = 0
public ExcelRange SetItalic(Boolean italic = true) #Returns:
ExcelRangeSets or clears italic font style for every cell in the range.
Parameters
- italic System.Boolean = true
public ExcelRange SetNumberFormat(String numberFormat) #Returns:
ExcelRangeApplies a number format to every cell in the range.
Parameters
- numberFormat System.String
public ExcelRange SetShrinkToFit(Boolean shrinkToFit = true) #Returns:
ExcelRangeSets or clears shrink-to-fit text alignment for every cell in the range.
Parameters
- shrinkToFit System.Boolean = true
public ExcelRange SetStrikethrough(Boolean strikethrough = true) #Returns:
ExcelRangeSets or clears strikethrough font style for every cell in the range.
Parameters
- strikethrough System.Boolean = true
public ExcelRange SetSuperscript() #Returns:
ExcelRangeFormats every cell in the range as superscript.
public ExcelRange SetTextRotation(Int32 rotation) #Returns:
ExcelRangeSets Excel text rotation for every cell in the range.
Parameters
- rotation System.Int32
SetUnderline 2 overloads
public ExcelRange SetUnderline(Boolean underline = true) #Returns:
ExcelRangeSets or clears single underline font style for every cell in the range.
Parameters
- underline System.Boolean = true
public ExcelRange SetUnderline(ExcelUnderlineStyle underlineStyle) #Returns:
ExcelRangeSets the native Excel underline style for every cell in the range.
Parameters
- underlineStyle OfficeIMO.Excel.ExcelUnderlineStyle
public ExcelRange SetVerticalTextAlignment(ExcelVerticalTextAlignment alignment) #Returns:
ExcelRangeSets the native Excel baseline, superscript, or subscript alignment for every cell in the range.
Parameters
- alignment OfficeIMO.Excel.ExcelVerticalTextAlignment
public ExcelRange SortByColumn(Int32 columnOffset, Boolean ascending = true, Boolean hasHeader = true) #Returns:
ExcelRangeSorts the range by a 1-based column offset.
Parameters
- columnOffset System.Int32
- ascending System.Boolean = true
- hasHeader System.Boolean = true
ToImage 2 overloads
public ExcelRangeImageExportBuilder ToImage() #Returns:
ExcelRangeImageExportBuilderStarts a fluent image export for this range.
public ExcelRangeImageExportBuilder ToImage(ExcelImageExportOptions options) #Returns:
ExcelRangeImageExportBuilderStarts a fluent image export using a cloned options snapshot.
Parameters
- options OfficeIMO.Excel.ExcelImageExportOptions
public Byte[] ToJpeg(ExcelImageExportOptions? options = null) #Returns:
Byte[]Renders this range to dependency-free JPEG bytes.
Parameters
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public Byte[] ToPng(ExcelImageExportOptions? options = null) #Returns:
Byte[]Renders this range to dependency-free PNG bytes.
Parameters
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public String ToSvg(ExcelImageExportOptions? options = null) #Returns:
StringRenders this range to dependency-free SVG text.
Parameters
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public Byte[] ToTiff(ExcelImageExportOptions? options = null) #Returns:
Byte[]Renders this range to dependency-free TIFF bytes.
Parameters
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public Byte[] ToWebp(ExcelImageExportOptions? options = null) #Returns:
Byte[]Renders this range to dependency-free lossless WebP bytes.
Parameters
- options OfficeIMO.Excel.ExcelImageExportOptions? = null
public ExcelRange TransformTextCase(OfficeTextCase textCase, CultureInfo? culture = null) #Returns:
ExcelRangeChanges stored text casing in text cells while preserving cell and rich-run formatting. Formulas and non-text values are left unchanged.
Parameters
- textCase OfficeIMO.Drawing.OfficeTextCase
- culture System.Globalization.CultureInfo? = null
public ExcelMutationResult TransposeTo(String destinationTopLeft, ExcelMutationPlanOptions? options = null, CancellationToken cancellationToken = default) #Returns:
ExcelMutationResultCopies this range to a destination with rows and columns transposed.
Parameters
- destinationTopLeft System.String
- options OfficeIMO.Excel.ExcelMutationPlanOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public ExcelRangeDataValidationBuilder Validation { get; } #Builds data validation rules for the range.
public ExcelRangeDataValidationBuilder Validate { get; } #Builds data validation rules for the range.
public ExcelRangeConditionalFormattingBuilder ConditionalFormatting { get; } #Builds conditional formatting rules for the range.
public ExcelRangeConditionalFormattingBuilder ConditionalFormat { get; } #Builds conditional formatting rules for the range.