DS.Documents.Excel Assembly

GrapeCity.Documents.Excel.IRange

IRange Interface

Represents the IRange object.

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public interface IRange

Public Interface IRange

Properties

Name	Description
AddIndent	Gets or sets the property which controls indentation of text when horizontal or vertical alignment is set to distributed.
Address	Gets a string value that represents the range reference in the absolute A1 format.
Areas	Returns an instance of IAreas which represents an array of IRanges where each IRange returned by IAreas represents one cell or range.
BackgroundImage	Gets or sets the cell background image. Supported image types include: PNG, JPG, ICO, SVG, GIF. This would be visible only in SpreadJS and Exporting to PDF/HTML/IMG.
BackgroundImageLayout	Gets or sets the cell background image layout, default is Stretch.
BindingPath	Gets or sets the binding path of the current cell or column. If range is normal range, gets or sets the binding path of the top-left cell of range. If range is EntireColumn, gets or sets the binding path of the left column binding path of range. If range is EntireRow, gets or sets null.
Borders	Returns an instance of IBorders which represents the cell borders of the cell or range represented by this IRange.
CellPadding	Gets or sets the cell padding for range. SpreadJS only.
CellType	Gets or sets the cell type for specified range in the sheet.
Cells	Returns the IRange object that represents the cells in the specified range.
Column	Returns the zero based column number of the first column of the first range.
ColumnCount	Returns the column count of the first range.
ColumnWidth	Gets or sets the width of the individual columns represented in this range in characters.
ColumnWidthInPixel	Gets or sets the width of the individual columns represented in this range in pixels.
Columns	Returns the IRange object that represents the columns in the specified range.
Comment	Returns an instance of IComment which may be used to get and set Comment properties of the cells.
CommentThreaded	Returns an instance of ICommentThreaded which may be used to get and set ICommentThreaded properties of the cells.
Count	Returns the number of objects in the collection.
CurrentArray	Gets whether the specified cell is part of an array, returns an IRange object that represents the entire array.
Decoration	Gets or sets the cell decoration. SpreadJS only.
DefaultValue	Gets or sets the default value of the cell, it can be the value data or the formula string. It works when the cell has no data.
DisplayFormat	Gets a DisplayFormat object that represents the display settings for the specified range.
EntireColumn	Returns a new instance of IRange which represents the same range of cells, but expanded to include all rows.
EntireMergeArea	Returns an IRange representing the area of the current IRange which is iteratively grown as needed until it includes no partial merged cells.
EntireRow	Returns a new instance of IRange which represents the same range of cells, but expanded to include all columns.
Font	Returns an instance of IFont which may be used to get and set font properties of the cells represented by this IRange.
FormatConditions	Returns a FormatConditions collection that represents all the conditional formats for the specified range.
Formula	Gets or sets the formula of the cells represented by this IRange in A1-style notation.
Formula2	Gets or sets the formula of the cells represented by this IRange in A1-style array notation.
Formula2Local	Gets or sets the localized formula of the cells represented by this IRange in A1-style array notation.
Formula2R1C1	Gets or sets the formula of the cells represented by this IRange in R1C1-style array notation.
Formula2R1C1Local	Gets or sets the localized formula in array notation of the cells represented by this IRange in R1C1-style array notation.
FormulaArray	Gets or sets the array formula of a range.
FormulaArrayR1C1	Gets or sets the array formula of a range, using ReferenceStyle.R1C1.
FormulaHidden	Gets or sets whether the formula will be hidden when the worksheet is protected.
FormulaLocal	Gets or sets the localized formula of the cells represented by this IRange in A1-style notation.
FormulaR1C1	Gets or sets the formula of the cells represented by this IRange in R1C1-style notation.
FormulaR1C1Local	Gets or sets the localized formula of the cells represented by this IRange in R1C1-style notation.
HasArray	Determines if the specified cell is part of an array formula.
HasFormula	Returns true if the cell or range contains any formulas; otherwise, false is returned.
HasValidation	Returns true if any of the cells represented by this range have data validation associated with them.
Height	Gets the height, in points, of the range.
HeightInPixel	Gets the height, in pixels, of the range.
Hidden	Gets or sets the property which specifies whether rows or columns should be hidden.
HorizontalAlignment	Gets or sets the HorizontalAlignment of a cell or range.
Hyperlinks	Returns an instance of IHyperLinks which may be used to get and set HyperLinks properties.
IgnoredError	Gets or sets the error type of the range to be ignored.
IndentLevel	Gets or sets the indent level of the specified cell(s).
Interior	Returns the IInterior which represents the interior (background) color and pattern of the specified cell(s).
IsRichText	Indicates whether the cell string value is a rich text.
this[int]	Returns a new instance of IRange by index which represents a cell.
this[int, int]	Returns a new instance of IRange which is offset from this IRange.
LabelOptions	Gets or sets the setting for watermark. SpreadJS only.
LastColumn	Returns the zero based column number of the last column of the first range.
LastRow	Returns the zero based row number of the last row of the first range.
Locked	Gets or sets the property which specifies whether cells should be locked.
MergeArea	Returns an IRange representing the merged range containing the specified cell. If the specified cell isn't in a merged range, this property returns the specified cell.
MergeCells	Gets or sets the property which specifies whether cells are merged.
NumberFormat	Gets or sets the number format of the cells in the range.
Orientation	Gets or sets the text orientation of a cell or range, which may be from -90 to 90 degrees, or 255(vertical text).
OutlineLevel	Gets or sets the current outline level of the specified row or column.
ReadingOrder	Gets or sets the reading order for the specified object.
RichText	Gets the rich text object associate with the top-left cell of this range.
Row	Returns the zero based row number of the first row of the first range.
RowCount	Returns the row count of the first range.
RowHeight	Gets or sets the height of the individual rows represented by this range in points.
RowHeightInPixel	Gets or sets the height of the individual rows represented by this range in pixels.
Rows	Returns the IRange object that represents the rows in the specified range.
ShowDetail	Gets or sets whether to show the detail (Returns True if the outline is expanded for the specified range, so that the detail of the column or row is visible). The specified range must be a single summary column or row in an outline (read or write).
ShrinkToFit	Gets or sets the property which specifies whether cells will be drawn in a smaller font if needed to display the contents of the cell.
SparklineGroups	Returns an instance of ISparklineGroups which may be used to get and set SparklineGroups properties of the cells
Style	Gets or sets the named style IStyle associated with the cells represented by this IRange.
Summary	Determines if the range is an outlining summary row or column.
Tag	Gets or sets the tag value for specified range in the sheet. SpreadJS only.
Text	Gets the value of the cell represented by this IRange as a formatted string.
UseStandardHeight	Determines if the row height of the IRange object equals the standard height of the sheet.
UseStandardWidth	Determines if the column width of the IRange object equals the standard width of the sheet.
UsedRange	Returns an IRange representing the used range in the current range.
Validation	Returns an instance of IValidation which may be used to get and set validation properties of the cells represented by this IRange.
ValidationIsSame	Returns true if the validation options of all cells represented by this IRange are the same; otherwise, false is returned.
Value	Gets the value of the specified range as a string, double, bool, object[,] (`Object`(,) in Visual Basic) or null (`Nothing` in Visual Basic); or sets the value of the specified cell as a string, double, short, int, long, bool, DateTime, TimeSpan, object[,] (`Object`(,) in Visual Basic) or null (`Nothing` in Visual Basic).
VerticalAlignment	Gets or sets the VerticalAlignment of a cell or range.
Watermark	Gets or sets the watermark for range. SpreadJS only.
Width	Gets the width, in points, of the range.
WidthInPixel	Gets the width, in pixels, of the range.
Worksheet	Returns the parent Worksheet of this range.
WrapText	Get or sets the flag which indicates whether word wrap is enabled in a cell.

Methods

Name	Description
Activate()	Activates a single cell, which must be inside the current selection.
AddComment(string)	Adds comments to the current IRange.
AddCommentThreaded(string, string)	Adds a threaded comment to the current IRange.
AutoFilter(bool, int, object, AutoFilterOperator, object, bool)	Filters a list using the AutoFilter.
AutoFilter(int, object, AutoFilterOperator, object, bool)	Filters a list using the AutoFilter.
AutoFit()	Changes the width of the columns in the range or the height of the rows in the range to achieve the best fit.
AutoFit(bool)	Changes the width of the columns in the range or the height of the rows in the range to achieve the best fit. `considerMergedCell` Indicates whether to consider merged cells in a single row.
Calculate()	Calculates formulas of the range as needed.
Characters(int, int)	Returns a ITextRun object that represents a range of characters within the cell text, this method can only be called when the value of cell is a string, or else InvalidOperationException is thrown.
Clear()	Clears formulas, values, and all formatting from the current IRange.
ClearComments()	Clears the comments from the current IRange.
ClearCommentsThreaded()	Clears the threaded comment from the current IRange.
ClearContents()	Clears formulas and values from the current IRange.
ClearFormats()	Clears all formatting from the current IRange.
ClearHyperlinks()	Clears all hyperLinks from the current IRange.
ClearOutline()	Clears the outline for the specified range.
Copy(IRange)	Copies the range to the specified range.
Copy(IRange, PasteOption)	Copies the range to the specified range.
Copy(IRange, PasteType)	Copies the range to the specified range.
Cut(IRange)	Cuts the range to the specified range.
Delete(DeleteShiftDirection)	Deletes a cell or a range of cells from the worksheet and shifts other cells to replace deleted cells. Specifies which way to shift the cells.
Dirty()	Designates all the formulas of the range to be recalculated when the next calculation occurs.
Find(object, IRange, FindOptions)	Finds specific information in a range.
FromJson(string)	Generates the range data from the JSON string.
GenerateGetPivotDataFunction(IRange)	Generate the corresponding function "GETPIVOTDATA" for the cells in the pivot table.
GetAddress(bool, bool, ReferenceStyle, IRange)	Returns a string value that represents the range reference. If all parameters are omitted, the return value is equal to the Address property.
GetDependents()	Gets the dependent ranges of the left top cell of the range.
GetDependents(bool)	Gets the dependent ranges of all the cells of the range.
GetPrecedents()	Gets the precedent ranges of the left top cell of the range.
GetPrecedents(bool)	Gets the precedent ranges of all the cells of the range.
GetUsedRange(UsedRangeType)	Gets an IRange representing the used range in the current range.
GoalSeek(double, IRange)	Attempts to achieve the specified goal, from the calculated result of the formula in the cell represented by this IRange, by modifying the specified changingCell. If you know the result that you want from a formula, but are not sure what input value the formula needs to get that result, use the Goal Seek feature.
Group()	Increments the OutlineLevel of the specified rows or columns.
ImportData(IEnumerable, DataImportOptions)	Imports data from a data source (up to 2D) to the range.
ImportData(DataTable, DataImportOptions)	Imports data from a table to the range.
ImportData<T>(IEnumerable<T>, DataImportOptions)	Imports data from a data source (up to 2D) to the range.
Insert(InsertShiftDirection)	Inserts a cell or a range of cells into the worksheet and shifts other cells away to make space. Specifies which way to shift the cells.
Intersect(IRange)	Returns an IRange object that represents the intersection of two ranges. If range2 is from a different worksheet, an exception is thrown.
Intersect(params IRange[])	Returns an IRange object that represents the intersection of several ranges. If one or more ranges from a different worksheet are specified, an exception is thrown.
Merge(bool)	Merges the cells in the represented range into a single merged cell.
Offset(int, int)	Returns an IRange object that represents the offset of this range.
RemoveSubtotal()	Removes subtotals from a list.
Replace(object, object, ReplaceOptions)	Search in formulas and replace. Using this method doesn't change either the selection or the active cell.
Select()	Selects the object.
Sort(IRange, SortOrder, SortOrientation, bool)
Sort(SortOrientation, bool, params IValueSortField[])	Sorts the cells represented by this range according to the specified options.
SpecialCells(SpecialCellType, SpecialCellsValue?)	Gets a IRange object that represents all the cells that match the specified type and value.
Subtotal(int, ConsolidationFunction, IEnumerable<int>, bool, bool, SummaryRow)	Creates subtotals for the range.
ToImage(Stream, ImageType)	Saves the range to the specified image stream.
ToImage(Stream, ImageType, ImageSaveOptions)	Saves the range to the specified image stream using options.
ToImage(string)	Saves the range to the specified image file.
ToImage(string, ImageSaveOptions)	Saves the range to the specified image file using options.
ToJson()	Generates a JSON string from the range.
UnMerge()	Converts merged cells in the represented range to normal cells.
Ungroup()	Decrements the OutlineLevel of the specified rows or columns.
Union(IRange)	Returns an IRange object that represents the union of two ranges. If range2 is from a different worksheet, an exception is thrown.
Union(params IRange[])	Returns an IRange object that represents the union of several ranges. If one or more ranges from a different worksheet are specified, an exception is thrown.

IRange Interface
Namespace: GrapeCity.Documents.Excel
Assembly: DS.Documents.Excel.dll
Syntax
Properties
Methods