Document Solutions for Excel, .NET Edition | Document Solutions
GrapeCity.Documents.Excel Namespace / IRange Interface
Properties Methods

In This Topic
    IRange Interface Members
    In This Topic

    The following tables list the members exposed by IRange.

    Public Properties
     NameDescription
    PropertyAddIndent Gets or sets the property which controls indentation of text when horizontal or vertical alignment is set to distributed.  
    PropertyAddressGets a System.String value that represents the range reference in the absolute A1 format.  
    PropertyAreasReturns an instance of IAreas which represents an array of IRanges where each IRange returned by IAreas represents one cell or range.  
    PropertyBackgroundImage 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.  
    PropertyBackgroundImageLayout Gets or sets the cell background image layout, default is Stretch.  
    PropertyBindingPath 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.  
    PropertyBordersReturns an instance of IBorders which represents the cell borders of the cell or range represented by this IRange.  
    PropertyCellPadding Gets or sets the cell padding for range. SpreadJS only.  
    PropertyCellsReturns the IRange object that represents the cells in the specified range.  
    PropertyCellType Gets or sets the cell type for specified range in the sheet.  
    PropertyColumn Returns the zero based column number of the first column of this IRange.  
    PropertyColumnCount Returns the column count of the first range.  
    PropertyColumnsReturns the IRange object that represents the columns in the specified range.  
    PropertyColumnWidth Gets or sets the width of the individual columns represented in this range in characters.  
    PropertyColumnWidthInPixel Gets or sets the width of the individual columns represented in this range in pixels.  
    PropertyComment Returns an instance of IComment which may be used to get and set Comment properties of the cells.  
    PropertyCommentThreaded Returns an instance of ICommentThreaded which may be used to get and set ICommentThreaded properties of the cells.  
    PropertyCount Returns the number of objects in the collection.  
    PropertyCurrentArrayGets whether the specified cell is part of an array, returns an IRange object that represents the entire array.  
    PropertyDefaultValue 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.  
    PropertyDisplayFormat Gets a DisplayFormat object that represents the display settings for the specified range.  
    PropertyEntireColumnReturns a new instance of IRange which represents the same range of cells, but expanded to include all rows.  
    PropertyEntireMergeAreaReturns an IRange representing the area of the current IRange which is iteratively grown as needed until it includes no partial merged cells.  
    PropertyEntireRowReturns a new instance of IRange which represents the same range of cells, but expanded to include all columns.  
    PropertyFontReturns an instance of IFont which may be used to get and set font properties of the cells represented by this IRange.  
    PropertyFormatConditions Returns a FormatConditions collection that represents all the conditional formats for the specified range.  
    PropertyFormulaGets or sets the formula of the cells represented by this IRange in A1-style notation.  
    PropertyFormula2Gets or sets the formula of the cells represented by this IRange in A1-style array notation.  
    PropertyFormula2LocalGets or sets the localized formula of the cells represented by this IRange in A1-style array notation.  
    PropertyFormula2R1C1Gets or sets the formula of the cells represented by this IRange in R1C1-style array notation.  
    PropertyFormula2R1C1LocalGets or sets the localized formula in array notation of the cells represented by this IRange in R1C1-style array notation.  
    PropertyFormulaArray Gets or sets the array formula of a range.  
    PropertyFormulaArrayR1C1 Gets or sets the array formula of a range, using ReferenceStyle.R1C1.  
    PropertyFormulaHidden Gets or sets whether the formula will be hidden when the worksheet is protected  
    PropertyFormulaLocalGets or sets the localized formula of the cells represented by this IRange in A1-style notation.  
    PropertyFormulaR1C1Gets or sets the formula of the cells represented by this IRange in R1C1-style notation.  
    PropertyFormulaR1C1LocalGets or sets the localized formula of the cells represented by this IRange in R1C1-style notation.  
    PropertyHasArray Determines if the specified cell is part of an array formula.  
    PropertyHasFormula Returns true if the cell or range contains any formulas; otherwise, false is returned.  
    PropertyHasValidation Returns true if any of the cells represented by this range have data validation associated with them.  
    PropertyHeight Gets the height, in points, of the range.  
    PropertyHeightInPixel Gets the height, in pixels, of the range.  
    PropertyHidden Gets or sets the property which specifies whether rows or columns should be hidden.  
    PropertyHorizontalAlignmentGets or sets the HorizontalAlignment of a cell or range.  
    PropertyHyperlinks Returns an instance of IHyperLinks which may be used to get and set HyperLinks properties.  
    PropertyIgnoredError Gets or sets the error type of the range to be ignored.  
    PropertyIndentLevel Gets or sets the indent level of the specified cell(s).  
    PropertyInteriorReturns the IInterior which represents the interior (background) color and pattern of the specified cell(s).  
    PropertyIsRichText Indicates whether the cell string value is a rich text.  
    PropertyItemOverloaded. Returns a new instance of IRange which is offset from this IRange.  
    PropertyLabelOptions Gets or sets the setting for watermark. SpreadJS only.  
    PropertyLastColumn Returns the zero based column number of the last column of the first range.  
    PropertyLastRow Returns the zero based row number of the last row of the first range.  
    PropertyLocked Gets or sets the property which specifies whether cells should be locked.  
    PropertyMergeAreaReturns 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.  
    PropertyMergeCells Gets or sets the property which specifies whether cells are merged.  
    PropertyNumberFormat Gets or sets the number format of the cells in the range.  
    PropertyOrientation Gets or sets the text orientation of a cell or range, which may be from -90 to 90 degrees, or 255(vertical text).  
    PropertyOutlineLevel Gets or sets the current outline level of the specified row or column.  
    PropertyReadingOrder Gets or sets the reading order for the specified object.  
    PropertyRichTextGets the rich text object associate with the top-left cell of this range.  
    PropertyRow Returns the zero based row number of the first row.  
    PropertyRowCount Returns the row count of the first range.  
    PropertyRowHeight Gets or sets the height of the individual rows represented by this range in points.  
    PropertyRowHeightInPixel Gets or sets the height of the individual rows represented by this range in pixels.  
    PropertyRowsReturns the IRange object that represents the rows in the specified range.  
    PropertyShowDetail 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).  
    PropertyShrinkToFit 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.  
    PropertySparklineGroups Returns an instance of ISparklineGroups which may be used to get and set SparklineGroups properties of the cells  
    PropertyStyleGets or sets the named style IStyle associated with the cells represented by this IRange.  
    PropertySummary Determines if the range is an outlining summary row or column.  
    PropertyTag Gets or sets the tag value for specified range in the sheet. SpreadJS only.  
    PropertyTextGets the value of the cell represented by this IRange as a formatted string.  
    PropertyUsedRangeReturns an IRange representing the used range in the current range.  
    PropertyUseStandardHeightDetermines if the row height of the IRange object equals the standard height of the sheet.  
    PropertyUseStandardWidthDetermines if the column width of the IRange object equals the standard width of the sheet.  
    PropertyValidation Returns an instance of IValidation which may be used to get and set validation properties of the cells represented by this IRange.  
    PropertyValidationIsSameReturns true if the validation options of all cells represented by this IRange are the same; otherwise, false is returned.  
    PropertyValueGets the value of the specified range as a System.String, System.Double, System.Boolean, object[,] (Object(,) in Visual Basic) or a null reference (Nothing in Visual Basic) (Nothing in Visual Basic); or sets the value of the specified cell as a System.String, System.Double, System.Int16, System.Int32, System.Int64, System.Boolean, System.DateTime, System.TimeSpan, object[,] (Object(,) in Visual Basic) or a null reference (Nothing in Visual Basic) (Nothing in Visual Basic).  
    PropertyVerticalAlignmentGets or sets the VerticalAlignment of a cell or range.  
    PropertyWatermark Gets or sets the watermark for range. SpreadJS only.  
    PropertyWidth Gets the width, in points, of the range.  
    PropertyWidthInPixel Gets the width, in pixels, of the range.  
    PropertyWorksheetReturns the parent Worksheet of this range.  
    PropertyWrapText Get or sets the flag which indicates whether word wrap is enabled in a cell.  
    Top
    Public Methods
     NameDescription
    MethodActivate Activates a single cell, which must be inside the current selection.  
    MethodAddComment Adds comments to the current IRange.  
    MethodAddCommentThreaded Adds a threaded comment to the current IRange.  
    MethodAutoFilter Filters a list using the AutoFilter.  
    MethodAutoFitOverloaded.  Changes the width of the columns in the range or the height of the rows in the range to achieve the best fit.  
    MethodCalculate Calculates formulas of the range as needed.  
    MethodCharactersReturns 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 System.InvalidOperationException is thrown.  
    MethodClear Clears formulas, values, and all formatting from the current IRange.  
    MethodClearComments Clears the comments from the current IRange  
    MethodClearCommentsThreaded Clears the threaded comment from the current IRange  
    MethodClearContents Clears formulas and values from the current IRange.  
    MethodClearFormats Clears all formatting from the current IRange.  
    MethodClearHyperlinks Clears all hyperLinks from the current IRange.  
    MethodClearOutline Clears the outline for the specified range.  
    MethodCopyOverloaded.  Copies the range to the specified range.  
    MethodCut Cuts the range to the specified range.  
    MethodDeleteDeletes 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.  
    MethodDirty Designates all the formulas of the range to be recalculated when the next calculation occurs.  
    MethodFind Finds specific information in a range.  
    MethodFromJson Generates the range data from the JSON string.  
    MethodGenerateGetPivotDataFunction Generate the corresponding function "GETPIVOTDATA" for the cells in the pivot table.  
    MethodGetAddressReturns a System.String value that represents the range reference. If all parameters are omitted, the return value is equal to the Address property.  
    MethodGetDependentsOverloaded.  Gets the dependent ranges of the left top cell of the range.  
    MethodGetPrecedentsOverloaded.  Gets the precedent ranges of the left top cell of the range.  
    MethodGetUsedRangeGets an IRange representing the used range in the current range.  
    MethodGroup Increments the OutlineLevel of the specified rows or columns.  
    MethodInsertInserts 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.  
    MethodIntersectOverloaded. Returns an IRange object that represents the intersection of two ranges.

    If range2 is from a different worksheet, an exception is thrown.  
    MethodMerge Merges the cells in the represented range into a single merged cell.  
    MethodOffset Returns an IRange object that represents the offset of this range.  
    MethodRemoveSubtotal Removes subtotals from a list.  
    MethodReplace Search in formulas and replace. Using this method doesn't change either the selection or the active cell.  
    MethodSelect Selects the object.  
    MethodSortOverloaded.  Sorts the cells represented by this range according to the specified options.  
    MethodSpecialCellsGets a IRange object that represents all the cells that match the specified type and value.  
    MethodSubtotal Creates subtotals for the range.  
    MethodToImageOverloaded.  Saves the range to the specified image file.  
    MethodToJson Generates a JSON string from the range.  
    MethodUngroup Decrements the OutlineLevel of the specified rows or columns.  
    MethodUnionOverloaded. Returns an IRange object that represents the union of two ranges.

    If range2 is from a different worksheet, an exception is thrown.  
    MethodUnMerge Converts merged cells in the represented range to normal cells.  
    Top
    See Also

    Reference

    IRange Interface
    GrapeCity.Documents.Excel Namespace