SpreadsheetGear The Performance Spreadsheet Component Company 
IRange Interface Members
See Also  Properties  Methods 
SpreadsheetGear Namespace : IRange Interface


The following tables list the members exposed by IRange.

Public Properties

 NameDescription
 PropertyAddIndent Gets or sets the cell's AddIndent boolean flag.  
 PropertyAddIndentDefined Returns true if the AddIndent property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyAddress Returns the cell or range address of the cells represented by this IRange.  
 PropertyAllowEdit Returns true if all of the cells represented by a range may be edited.  
 PropertyAreaCount Returns the number of areas in this IRange.  
 PropertyAreas Returns an instance of IAreas which represents an array of IRanges where each IRange returned by IAreas represents one cell or range.  
 PropertyBorders Returns an instance of IBorders which represents the cell borders of the cell or range represented by this IRange.  
 PropertyCells Returns the cells represented by this instance of IRange.  
 PropertyColumn Returns the zero based column number of the first column of this IRange.  
 PropertyColumnCount Returns the number of columns in this IRange.  
 PropertyColumns Returns 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.  
 PropertyColumnWidth Gets or sets the width of the individual columns represented this range in characters.  
 PropertyColumnWidthDefined Returns true if the ColumnWidth property of all columns represented by this IRange is the same, otherwise false is returned.  
 PropertyComment Returns an instance of IComment representing the comment which is associated the single cell represented by this range, or null if there is no comment.  
 PropertyCountReturns the number of cells, rows, or columns in a range.  
 PropertyCurrentArray Returns 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.  
 PropertyCurrentRegion Returns an expanded range of contiguous non-empty cells.  
 PropertyEndDown Returns 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.  
 PropertyEndLeft Returns 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.  
 PropertyEndRight Returns 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.  
 PropertyEndUp Returns 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.  
 PropertyEntireColumn Returns a new instance of IRange which represents the same range of cells, but expanded to include all rows.  
 PropertyEntireMergeArea Returns an IRange representing the area of the current IRange which is iteratively grown as needed until it includes no partial merged cells.  
 PropertyEntireRow Returns a new instance of IRange which represents the same range of cells, but expanded to include all columns.  
 PropertyEntry Returns the text which is displayed in the workbook view's formula bar.  
 PropertyFont Returns an instance of IFont which may be used to get and set font properties of the cells represented by this IRange.  
 PropertyFormatConditions Returns a collection which represents the conditional formatting options of this range.  
 PropertyFormatConditionsDefined Returns true if the conditional formatting options of all cells represented by this IRange are the same, otherwise false is returned.  
 PropertyFormula Gets or sets the value or formula of the cells represented by this IRange.  
 PropertyFormulaArray Gets or sets the array formula for a range.  
 PropertyFormulaHidden Gets or sets the property which specifies whether formulas should be hidden.  
 PropertyFormulaHiddenDefined Returns true if the FormulaHidden property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyFormulaR1C1 Gets or sets the value or formula of the cells represented by this IRange using ReferenceStyle.R1C1.  
 PropertyHasArray Returns true if the cell or range contains any array formulas, otherwise false is returned.  
 PropertyHasArrayDefined Returns true if the HasArray property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyHasFormula Returns true if the cell or range contains any formulas, otherwise false is returned.  
 PropertyHasFormulaDefined Returns true if the HasFormula property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyHasValidation Returns true if any of the cells represented by this range have data validation associated with them.  
 PropertyHeight Returns the height of the range in points.  
 PropertyHidden Gets or sets the property which specifies whether rows or columns should be hidden.  
 PropertyHorizontalAlignment Gets or sets the horizontal alignment of a cell or range.  
 PropertyHorizontalAlignmentDefined Returns true if the HorizontalAlignment property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyHyperlinks Returns a hyperlink collection representing the hyperlinks which are attached to this range.  
 PropertyIndentLevel Gets or sets the indent level of the specified cell(s).  
 PropertyInterior Returns the IInterior which represents the interior (background) color and pattern of the specified cell(s).  
 PropertyIsEntireColumns Returns true if the current range represents one or more entire columns.  
 PropertyIsEntireRows Returns true if the current range represents one or more entire rows.  
 PropertyIsVolatileOrCircularFormula Returns true if the single cell range is, or depends on, a volatile function or circular reference.  
 PropertyItemOverloaded.   
 PropertyLocked Gets or sets the property which specifies whether cells should be locked.  
 PropertyLockedDefined Returns true if the Locked property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyMergeArea Returns 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.  
 PropertyMergeCells Gets or sets the property which specifies whether cells are merged.  
 PropertyMergeCellsDefined Returns true if the MergeCells property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyName Returns the first defined name which refers to the cells represented by this range, or null if no defined name refers to the range.  
 PropertyNumberFormat Gets or sets the number format of the cells in the range.  
 PropertyNumberFormatDefined Returns true if the NumberFormat property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyNumberFormatType Returns the number format type of the top-left cell of this range.  
 PropertyOrientation Gets or sets the text orientation of a cell or range, which may be from -90 to 90 degrees or SpreadsheetGear.Orientation.Vertical.  
 PropertyOrientationDefined Returns true if the Orientation property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyOutlineLevel Gets or sets the outline level of a range of rows or columns, which provides the ability to group and summarize information.  
 PropertyOutlineLevelDefined Returns 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.  
 PropertyPrefixCharacter Returns '\'' if text was entered into a cell with a leading apostrophe, otherwise '\0' is returned.  
 PropertyPrefixCharacterDefined Returns true if the PrefixCharacter property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyRange Returns the cells represented by this instance of IRange.  
 PropertyRowReturns the zero based row number of the first row.  
 PropertyRowCount Returns the number of rows in this IRange.  
 PropertyRowHeight Gets or sets the height of the individual rows represented by this range in points.  
 PropertyRowHeightDefined Returns true if the RowHeight property of all rows represented by this IRange is the same, otherwise false is returned.  
 PropertyRows Returns 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.  
 PropertyShowDetail Gets 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).  
 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.  
 PropertyShrinkToFitDefined Returns true if the ShrinkToFit property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyText Returns the value of the cell represented by this IRange as a formatted string.  
 PropertyValidation Returns an instance of IValidation which may be used to get and set validation properties of the cells represented by this IRange.  
 PropertyValidationDefined Returns true if the validation options of all cells represented by this IRange are the same, otherwise false is returned.  
 PropertyValue Gets 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.Boolean, System.DateTime, SpreadsheetGear.ValueError, System.Decimal, System.DBNull, object[,] or null.  
 PropertyValueType Returns the value type of the top-left cell of this range.  
 PropertyVerticalAlignment Gets or sets the vertical alignment of a cell or range.  
 PropertyVerticalAlignmentDefined Returns true if the VerticalAlignment property of all cells represented by this IRange is the same, otherwise false is returned.  
 PropertyWidth Returns the width of the range in points.  
 PropertyWorkbookSetReturns the parent IWorkbookSet of this range.  
 PropertyWorksheetReturns the parent IWorksheet of this range.  
 PropertyWrapText Get or sets the flag which indicates whether word wrap is enabled in a cell.  
 PropertyWrapTextDefined Returns true if the WrapText property of all cells represented by this IRange is the same, otherwise false is returned.  
Top

Public Methods

 NameDescription
 MethodActivate Sets the active cell of the worksheet associated with this IRange to the top-left cell of this IRange.  
 MethodAddComment Adds a single comment with the specified text to the single cell represented by this range.  
 MethodAutoFit Automatically sets the width of the specified columns or the height of the specified rows.  
 MethodClear Clears formulas, values and all formatting from the current IRange.  
 MethodClearComments Clears all comments associated with any cells in this range.  
 MethodClearContents Clears formulas and values from the current IRange.  
 MethodClearFormats Clears all formatting from the current IRange.  
 MethodClearOutline Clears 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.   
 MethodCopyDown Copies values, formulas and formats in the top row of the range to subsequent rows.  
 MethodCopyFromDataTable Copies the specified DataTable to this range.  
 MethodCopyRight Copies values, formulas and formats in the left column of the range to subsequent columns.  
 MethodDeleteOverloaded.   
 MethodFind Searches for the specified text according to the specified options, and returns an IRange representing the found cell or null if no cell is found.  
 MethodGetAddress Returns a string representing the address of the range.  
 MethodGetArea Returns the zero based instance of IRange specified by index.  
 MethodGetCharacters Returns an instance of ICharacters which represents a range of characters belonging to a text cell.  
 MethodGetDataSet Returns a newly created data set from the cells referred to by this IRange.  
 MethodGetDataTable Returns a newly created data table from the cells referred to by this IRange.  
 MethodGroup Increments the OutlineLevel of the specified rows or columns.  
 MethodInsertOverloaded.   
 MethodIntersect Returns a new range which consists of the intersection of this range and range2, or null if the ranges do not intersect.  
 MethodMerge Merges the cells in the represented range into a single merged cell.  
 MethodOffset Returns a copy of the current IRange which is offset by the specified number of rows and columns.  
 MethodReplace Attempts to replace the specified text according to the specified options, returning the number of replacements if successful or zero if not successful.  
 MethodSelect Sets the current selection of the worksheet associated with the this range to the cells in this range.  
 MethodSort Sorts the cells represented by this range according to the specified options.  
 MethodSubtract Returns a new range which consists of this range with range2 removed, or null if the resulting range is empty.  
 MethodUngroup Decrements the OutlineLevel of the specified rows or columns.  
 MethodUnion Returns a new range which consists of the union of this range and range2.  
 MethodUnMerge Converts merged cells in the represented range to normal cells.  
Top

See Also