Document Solutions for Excel, Java Edition | Document Solutions
com.grapecity.documents.excel Package / IRange Interface
Methods

In This Topic
    IRange Interface Members
    In This Topic

    The following tables list the members exposed by IRange.

    Public Methods
     NameDescription
     MethodActivates a single cell, which must be inside the current selection.  
     MethodAdds comments to the current range.  
     MethodOverloaded. Adds a threaded comment to the range.  
     MethodOverloaded. Filters a list using the AutoFilter.  
     MethodOverloaded. Changes the width of the columns in the range or the height of the rows in the range to achieve the best fit.  
     MethodCalculates formulas of the range as needed.  
     MethodReturns a ITextRun object that represents a range of characters within the cell text.  
     MethodClears formulas, values, and all formatting from the current range.  
     MethodClears the comments from the current range  
     MethodClears the threaded comments from the current range.  
     MethodClears formulas and values from the current range.  
     MethodClears all formatting from the current range.  
     MethodClears all hyperLinks from the current range.  
     MethodClears the outline for the specified range.  
     MethodOverloaded. Copies the range to the specified range  
     MethodCuts the range to the specified range.  
     MethodOverloaded. Deletes a cell or a range of cells from the worksheet and shifts other cells to replace deleted cells.  
     MethodDesignates all the formulas of the range to be recalculated when the next calculation occurs.  
     MethodOverloaded. Finds specific information in a range.  
     MethodGenerates the range data from the json string.  
     MethodOverloaded. Generate the corresponding function "GETPIVOTDATA" for the cells in the pivot table.  
     MethodOverloaded. Returns a new instance of IRange which is offset from this range.  
     MethodGets the property which controls indentation of text when horizontal or vertical alignment is set to distributed.  
     MethodOverloaded. Returns a String value that represents the range reference.  
     MethodReturns an instance of IAreas which represents an array of rangeswhere each range returned by areas represents one cell or range.  
     MethodGets the cell background image.  
     MethodGets the cell background image layout, default is Stretch.  
     MethodGets the binding path of the current cell or column. If range is normal range, returns the binding path of the top-left cell of range. If range is EntireColumn, returns the binding path of the left column binding path of range. If range is EntireRow, returns null.  
     MethodReturns an instance of IBorders which represents the cell borders ofthe cell or range represented by this IRange.  
     MethodGets the cell padding for range.  
     MethodReturns the IRange object that represents the cells in the specifiedrange.  
     MethodGets the cell type for specified range in the sheet.  
     MethodReturns the zero based column number of the first column of this IRange.  
     MethodReturns the column count of the first range.  
     MethodReturns the IRange object that represents the columns in thespecified range.  
     MethodGets the width of the individual columns represented in this range in characters.  
     MethodGets the width of the individual columns represented in this range in pixels.  
     MethodReturns an instance of IComment which may be used to get and setComment properties of the cells.  
     Method  
     MethodReturns the number of objects in the collection.  
     MethodGets whether the specified cell is part of an array, returns an IRange object that represents the entire array.  
     MethodGets the cell decoration for range. SpreadJS only.  
     MethodGets the default value of the cell, it can be the value data or the formula string. It works when the cell has no data.  
     MethodOverloaded. Gets the dependent ranges of the left top cell of the range.  
     MethodGets a DisplayFormat object that represents the display settings for the specified range.  
     MethodReturns a new instance of IRange which represents the same range ofcells, but expanded to include all rows.  
     MethodReturns an IRange representing the area of the current range which isiteratively grown as needed until it includes no partial merged cells.  
     MethodReturns a new instance of IRange which represents the same range ofcells, but expanded to include all columns.  
     MethodReturns an instance of IFont which may be used to get and set fontproperties of the cells represented by this IRange.  
     MethodReturns a FormatConditions collection that represents all the conditional formats for the specified range.  
     MethodGets the formula of the cells represented by this range in A1-style notation.  
     MethodGets the formula of the cells represented by this range in A1-style array notation.  
     MethodGets the localized formula of the cells represented by this range in A1-style array notation.  
     MethodGets the formula of the cells represented by this range in R1C1-style array notation.  
     MethodGets the localized formula of the cells represented by this range in R1C1-style array notation.  
     MethodGets the array formula of a range.  
     MethodGets the array formula of a range using ReferenceStyle.R1C1.  
     MethodGets or Sets whether the formula will be hidden when the worksheet is protected  
     MethodGets the localized formula of the cells represented by this range in A1-style notation.  
     MethodGets the formula of the cells represented by this range in R1C1-style notation.  
     MethodGets the localized formula of the cells represented by this range in R1C1-style notation.  
     MethodDetermines if the specified cell is part of an array formula.  
     MethodReturns true if the cell or range contains any formulas; otherwise, false is returned.  
     MethodReturns true if any of the cells represented by this range have data validation associated with them.  
     MethodGets the height, in points, of the range.  
     MethodGets the height, in pixels, of the range.  
     MethodGets the property which specifies whether rows or columns should be hidden.  
     MethodGets the HorizontalAlignment of a cell or range.  
     MethodReturns an instance of IValidation which may be used to get and setHyperLinks properties.  
     MethodGets the error type of the range to be ignored.  
     MethodGets the indent level of the specified cell(s).  
     MethodReturns the IInterior which represents the interior (background)color and pattern of the specified cell(s).  
     MethodGets the setting for watermark.  
     MethodReturns the zero based column number of the last column of the first range.  
     MethodReturns the zero based row number of the last row of the first range.  
     MethodGets the property which specifies whether cells should be locked.  
     MethodReturns an IRange representing the merged range containing thespecified cell. If the specified cell isn't in a merged range, this property returns the specified cell.  
     MethodGets the property which specifies whether cells are merged.  
     MethodGets the number format of the cells in the range.  
     MethodGets the text orientation of a cell or range, which may be from -90 to 90 degrees, or 255(vertical text).  
     MethodGets the current outline level of the specified row or column.  
     MethodOverloaded. Gets the precedent ranges of the left top cell of the range.  
     MethodGets or Sets the reading order for the specified object.  
     MethodGets the rich text object associate with the top-left cell of this range.  
     MethodReturns the zero based row number of the first row.  
     MethodReturns the row count of the first range.  
     MethodGets the height of the individual rows represented by this range in points.  
     MethodGets the height of the individual rows represented by this range in pixels.  
     MethodReturns the IRange object that represents the rows in the specifiedrange.  
     MethodGets whether to show the detail (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.

    The following statements are true: 1.The range must be in a single summary row or column. 2.This property returns False if any of the children of the row or column are hidden. 3.Setting this property to True is equivalent to unhiding all the children of the summary row or column. 4.Setting this property to False is equivalent to hiding all the children of the summary row or column.

     
     MethodGets the property which specifies whether cells will be drawn in a smaller font if needed to display the contents of the cell.  
     MethodReturns an instance of ISparklineGroups which may be used to get andset SparklineGroups properties of the cells  
     MethodGets the named style IStyle associated with the cells represented bythis IRange.  
     MethodDetermines if the range is an outlining summary row or column.  
     MethodGets the tag value of the specified range in the sheet.  
     MethodGets the value of the cell represented by this IRange as a formatted string.  
     MethodOverloaded. Returns an IRange representing the used range in the current range.  
     MethodGets whether the row height of the IRange object equals the standardheight of the sheet.  
     MethodGets whether the column width of the IRange object equals thestandard width of the sheet.  
     MethodReturns an instance of IValidation which may be used to get and setvalidation properties of the cells represented by this IRange.  
     MethodReturns true if the validation options of all cells represented by this IRange are the same; otherwise, false is returned.  
     MethodGets the value of the specified range as a string, double, boolean, java.util.Date, Object[][] or null;  
     MethodGets the VerticalAlignment of a cell or range.  
     MethodGets the watermark for range. SpreadJS only.  
     MethodGets the width, in points, of the range.  
     MethodGets the width, in pixels, of the range.  
     MethodReturns the parent IWorksheet of this range.  
     MethodGet the flag which indicates whether word wrap is enabled in a cell.  
     MethodAttempts 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.  
     MethodIncrements the OutlineLevel of the specified rows or columns.  
     MethodOverloaded. Imports data from a data source (up to 2D) to the range.  
     MethodOverloaded. Inserts a cell or a range of cells into the worksheet and shifts other cells away to make space.  
     MethodOverloaded. Returns an IRange object that represents the intersection of two ranges.
    If range2 is from a different worksheet, an exception is thrown.  
     MethodIndicates whether the cell string value is a rich text.  
     MethodOverloaded. Merges the cells in the represented range into a single merged cell.  
     MethodReturns an IRange object that represents the offset of this range.  
     MethodRemoves subtotals from a list.  
     MethodOverloaded. Search in formulas and replace. Using this method doesn't change either the selection or the active cell.  
     MethodSelects the object.  
     MethodSets the property which controls indentation of text when horizontal or vertical alignment is set to distributed.  
     MethodSets 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.  
     MethodSets the cell background image layout.  
     MethodSets the binding path of the current cell or column. If range is normal range, sets the binding path of the top-left cell of range. If range is EntireColumn, sets the binding path of the left column binding path of range. If range is EntireRow, do nothing.  
     MethodSets the cell padding for range.  
     MethodSets the cell type for specified range in the sheet.  
     MethodSets the width of the individual columns represented in this range in characters.  
     MethodSets the width of the individual columns represented in this range in pixels.  
     MethodSets the cell decoration for range. SpreadJS only.  
     MethodSets the default value of the cell, it can be the value data or the formula string. It works when the cell has no data.  
     MethodSets the formula of the cells represented by this range in A1-style notation.  
     MethodSets the formula of the cells represented by this range in A1-style array notation.  
     MethodSets the localized formula of the cells represented by this range in A1-style array notation.  
     MethodSets the formula of the cells represented by this range in R1C1-style array notation.  
     MethodSets the localized formula of the cells represented by this range in R1C1-style array notation.  
     MethodSets the array formula of a range.  
     MethodSets the array formula of a range using ReferenceStyle.R1C1.  
     MethodSets whether the formula will be hidden when the worksheet is protected  
     MethodSets the localized formula of the cells represented by this range in A1-style notation.  
     MethodSets the formula of the cells represented by this range in R1C1-style notation.  
     MethodSets the localized formula of the cells represented by this range in R1C1-style notation.  
     MethodSets the property which specifies whether rows or columns should be hidden.  
     MethodSets the HorizontalAlignment of a cell or range.  
     MethodSets the error type of the range to be ignored.  
     MethodSets the indent level of the specified cell(s).  
     MethodSets the property which specifies whether cells should be locked.  
     MethodSets the property which specifies whether cells are merged.  
     MethodSets the number format of the cells in the range.  
     MethodSets the text orientation of a cell or range, which may be from -90 to 90 degrees, or 255(vertical text).  
     MethodSets the current outline level of the specified row or column.  
     MethodSets the reading order for the specified object.  
     MethodSets the height of the individual rows represented by this range in points.  
     MethodSets the height of the individual rows represented by this range in pixels.  
     MethodSets whether to show the detail (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.

    The following statements are true: 1.The range must be in a single summary row or column. 2.This property returns False if any of the children of the row or column are hidden. 3.Setting this property to True is equivalent to unhiding all the children of the summary row or column. 4.Setting this property to False is equivalent to hiding all the children of the summary row or column.

     
     MethodSets the property which specifies whether cells will be drawn in a smaller font if needed to display the contents of the cell.  
     MethodSets the named style IStyle associated with the cells represented bythis IRange.  
     MethodSets the tag value of the specified range in the sheet.  
     MethodSets whether the row height of the IRange object equals the standardheight of the sheet.  
     MethodSets whether the column width of the IRange object equals thestandard width of the sheet.  
     MethodSets the value of the specified cell as a string, double, int, boolean, java.util.Date, java.util.Calendar, Object[][] or null.  
     MethodSets the VerticalAlignment of a cell or range.  
     MethodSets the watermark for range. SpreadJS only.  
     MethodSets the flag which indicates whether word wrap is enabled in a cell.  
     MethodOverloaded. Sorts the cells represented by this range according to the specified options.  
     MethodOverloaded. Gets a IRange object that represents all the cells that match the specified type and value.  
     MethodOverloaded. Creates subtotals for the range.  
     MethodOverloaded. Saves the range to the specified image file.  
     MethodGenerates a json string from the range.  
     MethodDecrements the OutlineLevel of the specified rows or columns.  
     MethodOverloaded. Returns an IRange object that represents the union of two ranges.
    If range2 is from a different worksheet, an exception is thrown.  
     MethodConverts merged cells in the represented range to normal cells.  
    Top
    See Also