SpreadsheetGear 2012
IRange Interface Members
Properties  Methods 

The following tables list the members exposed by IRange.

Public Properties
 NameDescription
 PropertyAddIndentGets or sets the property which controls indentation of text when horizontal or vertical alignment is set to distributed.  
 PropertyAddIndentDefinedReturns true if the AddIndent property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyAddressReturns the cell or range address of the cells represented by this IRange using ReferenceStyle.A1.  
 PropertyAllowEditReturns true if all of the cells represented by a range may be edited.  
 PropertyAreaCountReturns the number of areas in this IRange.  
 PropertyAreasReturns an instance of IAreas which represents an array of IRanges where each IRange returned by IAreas represents one cell or range.  
 PropertyBordersReturns an instance of IBorders which represents the cell borders of the cell or range represented by this IRange.  
 PropertyCellCountReturns the number of cells represented by this range.  
 PropertyCellsReturns the cells represented by this instance of IRange.  
 PropertyColumnReturns the zero based column number of the first column of this IRange.  
 PropertyColumnCountReturns the number of columns in this IRange.  
 PropertyColumnsReturns a new instance of IRange which represents the same range of cells but which may be used to determine the number of columns in the range or to AutoFit the columns in the range.  
 PropertyColumnWidthGets or sets the width of the individual columns represented this range in characters.  
 PropertyColumnWidthDefinedReturns true if the ColumnWidth property of all columns represented by this IRange is the same, otherwise false is returned.  
 PropertyCommentReturns an instance of IComment representing the comment which is associated the single cell represented by this range, or null if there is no comment.  
 PropertyCountDeprecated - use CellCount, RowCount or ColumnCount.  
 PropertyCurrentArrayReturns the range of cells containing the array formula of the top-left cell of this IRange, or null if the top-left cell is not an array formula.  
 PropertyCurrentRegionReturns an expanded range of contiguous non-empty cells.  
 PropertyEndDownReturns a single cell at the end of the current contiguous non-empty range, or at the start of the next non-empty range, starting with the top-left cell of this range.  
 PropertyEndLeftReturns a single cell at the start of the current contiguous non-empty range, or at the end of the previous non-empty range, starting with the top-left cell of this range.  
 PropertyEndRightReturns a single cell at the end of the current contiguous non-empty range, or at the start of the next non-empty range, starting with the top-left cell of this range.  
 PropertyEndUpReturns a single cell at the start of the current contiguous non-empty range, or at the end of the previous non-empty range, starting with the top-left cell of this 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.  
 PropertyEntryReturns the text which is displayed in the workbook view's formula bar.  
 PropertyFontReturns an instance of IFont which may be used to get and set font properties of the cells represented by this IRange.  
 PropertyFormatConditionsReturns a collection which represents the conditional formatting options of this range.  
 PropertyFormatConditionsDefinedReturns true if the conditional formatting options of all cells represented by this IRange are the same, otherwise false is returned.  
 PropertyFormulaGets the formula, or sets the value or formula, of the cells represented by this IRange.  
 PropertyFormulaArrayGets or sets the array formula for a range.  
 PropertyFormulaHiddenGets or sets the property which specifies whether formulas should be hidden.  
 PropertyFormulaHiddenDefinedReturns true if the FormulaHidden property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyFormulaR1C1Gets or sets the value or formula of the cells represented by this IRange using ReferenceStyle.R1C1.  
 PropertyHasArrayReturns true if the cell or range contains any array formulas, otherwise false is returned.  
 PropertyHasArrayDefinedReturns true if the HasArray property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyHasFormulaReturns true if the cell or range contains any formulas, otherwise false is returned.  
 PropertyHasFormulaDefinedReturns true if the HasFormula property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyHasValidationReturns true if any of the cells represented by this range have data validation associated with them.  
 PropertyHeightReturns the height of the range in points.  
 PropertyHiddenGets or sets the property which specifies whether rows or columns should be hidden.  
 PropertyHorizontalAlignmentGets or sets the horizontal alignment of a cell or range.  
 PropertyHorizontalAlignmentDefinedReturns true if the HorizontalAlignment property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyHyperlinksReturns a hyperlink collection representing the hyperlinks which are attached to this range.  
 PropertyIndentLevelGets 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).  
 PropertyIsEntireColumnsReturns true if the current range represents one or more entire columns.  
 PropertyIsEntireRowsReturns true if the current range represents one or more entire rows.  
 PropertyIsVolatileOrCircularFormulaReturns true if the single cell range is, or depends on, a volatile function or circular reference.  
 PropertyItemOverloaded. Returns a new instance of IRange which is offset from this IRange.  
 PropertyLockedGets or sets the property which specifies whether cells should be locked.  
 PropertyLockedDefinedReturns true if the Locked property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyMergeAreaReturns an IRange representing the merged cell area if the cell represented by this IRange is part of a merged cell range, otherwise the original IRange is returned.  
 PropertyMergeCellsGets or sets the property which specifies whether cells are merged.  
 PropertyMergeCellsDefinedReturns true if the MergeCells property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyNameReturns the first defined name which refers to the cells represented by this range, or null if no defined name refers to the range.  
 PropertyNumberFormatGets or sets the number format of the cells in the range.  
 PropertyNumberFormatDefinedReturns true if the NumberFormat property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyNumberFormatTypeReturns the number format type of the top-left cell of this range.  
 PropertyOrientationGets or sets the text orientation of a cell or range, which may be from -90 to 90 degrees or SpreadsheetGear.Orientation.Vertical.  
 PropertyOrientationDefinedReturns true if the Orientation property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyOutlineLevelGets or sets the outline level of a range of rows or columns, which provides the ability to group and summarize information.  
 PropertyOutlineLevelDefinedReturns true if the OutlineLevel property of all rows or columns represented by this IRange is the same, otherwise false is returned.  
 PropertyPageBreakAdds or removes manual page breaks for a range.  
 PropertyPrefixCharacterReturns '\'' if text was entered into a cell with a leading apostrophe, otherwise '\0' is returned.  
 PropertyPrefixCharacterDefinedReturns true if the PrefixCharacter property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyRangeReturns the cells represented by this instance of IRange.  
 PropertyRowReturns the zero based row number of the first row.  
 PropertyRowCountReturns the number of rows in this IRange.  
 PropertyRowHeightGets or sets the height of the individual rows represented by this range in points.  
 PropertyRowHeightDefinedReturns true if the RowHeight property of all rows represented by this IRange is the same, otherwise false is returned.  
 PropertyRowsReturns a new instance of IRange which represents the same range of cells but which may be used to determine the number of rows in the range or to AutoFit the rows in the range.  
 PropertyShowDetailGets or sets the property which specifies whether the detail corrresponding to the outline level of the represented row or column will be shown (expanded) or hidden (collapsed).  
 PropertyShrinkToFitGets or sets the property which specifies whether cells will be drawn in a smaller font if needed to display the contents of the cell.  
 PropertyShrinkToFitDefinedReturns true if the ShrinkToFit property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyStyleGets or sets the named cell style associated with the cells represented by this IRange.  
 PropertyStyleDefinedReturns true if the Style property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyTextReturns the value of the cell represented by this IRange as a formatted string.  
 PropertyValidationReturns an instance of IValidation which may be used to get and set validation properties of the cells represented by this IRange.  
 PropertyValidationDefinedReturns 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, SpreadsheetGear.ValueError, object[,] or null; or sets the value of the specified cell as a System.String, System.Double, System.Int32, System.Int64, System.Int16, System.Char, System.Boolean, System.DateTime, SpreadsheetGear.ValueError, System.Decimal, System.DBNull, object[,] or null.  
 PropertyValueTypeReturns the value type of the top-left cell of this range.  
 PropertyVerticalAlignmentGets or sets the vertical alignment of a cell or range.  
 PropertyVerticalAlignmentDefinedReturns true if the VerticalAlignment property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyWidthReturns the width of the range in points.  
 PropertyWorkbookSetReturns the parent IWorkbookSet of this range.  
 PropertyWorksheetReturns the parent IWorksheet of this range.  
 PropertyWrapTextGet or sets the flag which indicates whether word wrap is enabled in a cell.  
 PropertyWrapTextDefinedReturns true if the WrapText property of all cells represented by this IRange is the same, otherwise false is returned.  
Top
Public Methods
 NameDescription
 MethodActivateSets the active cell of the worksheet associated with this IRange to the top-left cell of this IRange.  
 MethodAddCommentAdds a single comment with the specified text to the single cell represented by this range.  
 MethodAutoFillAutomatically fills the destination range given the starting values from this range and the specified AutoFillType.  
 MethodAutoFilterOverloaded. Adds autofilter dropdowns to the columns of the specified range if none exist, or removes autofilter dropdowns if they do exist.  
 MethodAutoFitAutomatically sets the width of the specified columns or the height of the specified rows.  
 MethodClearClears formulas, values and all formatting from the current IRange.  
 MethodClearCommentsClears all comments associated with any cells in this range.  
 MethodClearContentsClears formulas and values from the current IRange.  
 MethodClearFormatsClears all formatting from the current IRange.  
 MethodClearOutlineClears the specified represented row or column outline levels, or all outline levels of the associated worksheet if this range does not represent rows or columns.  
 MethodCopyOverloaded. Copies the cells, rows and/or columns of the current IRange to the destination IRange.  
 MethodCopyDownCopies values, formulas and formats in the top row of the range to subsequent rows.  
 MethodCopyRightCopies values, formulas and formats in the left column of the range to subsequent columns.  
 MethodDataSeriesFill this range with a data series based on the specified type and options.  
 MethodDeleteOverloaded. Deletes cells, rows or columns, shifting remaining cells left or up and fixing up formulas.  
 MethodFillDownCopies from the top row of this range to the remaining rows.  
 MethodFillLeftCopies from the right column of this range to the preceding columns.  
 MethodFillRightCopies from the left column of this range to the remaining columns.  
 MethodFillUpCopies from the bottom row of this range to the preceding rows.  
 MethodFindSearches for the specified text according to the specified options, and returns an IRange representing the found cell or null if no cell is found.  
 MethodGetAddressReturns a string representing the address of the range.  
 MethodGetAreaReturns the zero based instance of IRange specified by index.  
 MethodGetCharactersReturns an instance of ICharacters which represents a range of characters belonging to a text cell.  
 MethodGetEnumerator (Inherited from System.Collections.IEnumerable)
 MethodGoalSeekAttempts to achieve the specified goal, from the calculated result of the formula in the cell represented by this IRange, by modifying the specified changingCell using a simple iterative linear search.  
 MethodGroupIncrements the OutlineLevel of the specified rows or columns.  
 MethodInsertOverloaded. Inserts rows or columns by shifting rows down or columns right and fixing up formulas and formats.  
 MethodIntersectReturns a new range which consists of the intersection of this range and range2, or null if the ranges do not intersect.  
 MethodMergeMerges the cells in the represented range into a single merged cell.  
 MethodOffsetReturns a copy of the current IRange which is offset by the specified number of rows and columns.  
 MethodReplaceAttempts to replace the specified text according to the specified options, returning the number of replacements if successful or zero if not successful.  
 MethodSaveAsSaves this range using the specified filename and FileFormat, and updates the FullName property.  
 MethodSaveToMemorySaves this range to a newly created memory buffer in the specified FileFormat.  
 MethodSaveToStreamSaves this range to a stream in the specified FileFormat.  
 MethodSelectSets the current selection of the worksheet associated with the this range to the cells in this range.  
 MethodSortSorts the cells represented by this range according to the specified options.  
 MethodSubtractReturns a new range which consists of this range with range2 removed, or null if the resulting range is empty.  
 MethodTableSets up this range as a data table calculation range with the specified row input cell, column input cell or both.  
 MethodUngroupDecrements the OutlineLevel of the specified rows or columns.  
 MethodUnionReturns a new range which consists of the union of this range and range2.  
 MethodUnMergeConverts merged cells in the represented range to normal cells.  
Top
See Also

Reference

IRange Interface
SpreadsheetGear Namespace
Cells Property

Send Feedback