ITabRange

Assembly: Tab.

Namespace: Prognoz.Platform.Interop.Tab;

Description

The ITabRange interface contains properties and methods that are used to work with table cells and cell ranges.

Inheritance hierarchy

ITabRange

Comments

Cell ranges are used to set up parameters of data areas, formula areas, charts, maps, and to set up visual formatting for tables of various repository objects and development environment components.

To get cell range, use the following properties and methods:

Properties

  Property name Brief description
The Address property returns cell range address as a string.

The AppliedFormatConditions property returns a list of formatting conditions,  that are applied for a cell or cell range.

The Bottom property returns the index of the bottom row of the range.
The ColumnPixelWidth property determines the width of range columns in pixels.
The ColumnWidth property determines the width of range columns in millimeters.
The Count property returns the number of cells in the range.
The DistinctCells property returns a composite range, which does not contain overlapping parts.
The EntireColumn property returns a range consisting only of the columns included in the current range.
The EntireRows property returns a range consisting only of the rows included in the current range.
The Footnotes property returns collection of footnotes in the current range.
The FormatConditions property returns the object containing a collection of cell conditional formats.
The FormattedText property returns cell value taking into account predefined data view format.
The Formula property determines the formula of the cell range, but returns the formula of one cell only.
The Height property returns range height in millimeters.
The Hidden property determines visibility of rows or columns depending on usage.
The IsCell property returns whether the range consists of a single cell.
The IsColumn property returns the value that is used to define whether the range is a single column.
The IsRow property returns the value that is used to define whether the range is a single row.
The IsRtfText property determines whether formatting and text are stored in RTF format.
Outdated. Use the IsRtfText property.
The Item property is not yet implemented.
The Left property returns the index of the leftmost column of the range.
The Location property returns the top left point of the range.
The Merged property returns the value that is used to define whether the range is a merged one.
The Part property returns a part of the range, the index of which is passed as the input parameter.
The PartCount property returns the number of parts in the range.
The PixelLocation property returns the upper left point of the range in pixels obtained taken into account pixel resizing of rows and columns.
The Prefix property determines the table cell prefix.
The RealColumnWidth property returns the real width of hidden columns.
The RealRowHeight property returns the actual height of hidden rows.
The Right property returns the index of the rightmost column of the range.
The RowHeight property determines the height of range rows in millimeters.
The RowPixelHeight property determines the height of range rows in pixels.
The Style property determines the style of the range cells to be displayed.
The StyleForDraw property returns the cell style that takes into account overlapping of other ranges' styles.
The StyleIndex property sets a style from the collection of styles.
The Suffix property determines suffix of the table cell.
The TabSheet property returns the table containing the given range.
The Text property determines text of the cell range.
The Top property returns the index of the top row of the range.
The Type property returns range type.
The Value property determines value of the cell range.
The Width property returns range width in millimeters.

Methods

  Method name Brief description
The AdjustHeight method automatically adjusts height of range cells to fit cells' contents.

The AdjustHeightEx method automatically adjusts height of range rows to fit cells' contents if the custom size is not set.

The AdjustWidth method automatically adjusts width of range columns to fit cells' contents.
The AutoFill method automatically fills selected range based on data of the current range.
The Clear method clears all the data and formatting of the cell range.
The ClearContent method clears all the data of the range, preserving formatting of the range.
The ClearFormat method clears range formatting preserving range data.
The ClearPart method clears the selected elements of the cell range.
The Combine method changes the current range.
The Clone method creates a copy of the cell range.
The Copy method copies the range data to clipboard.
The CopyToStream method copies range data to the specified stream.
The CreateIterator method creates an iterator that is used to navigate the table cells containing values.
The Cut method cuts the range data to clipboard.
The Delete method deletes the set cell range.
The DependenceCells method finds cells, which determine the selected cell.
The DependentCells method finds cells that depend on the given cell.
The Expand method expands the size of the current range to the size of the united range into which it is included.
The Insert method inserts the cell range.
The FillDown method fills all the range with values from the first row of the range.
The FillLeft method fills all the range with values from the last column of the range.
The FillRight method fills all the range with values from the first column of the range.
The FillUp method fills all the range with values from the last row of the range.
The Merge method merges all range cells in one cell.
The Offset method returns the cell range, shifted according to the defined parameters.
The ParseValue method converts value of the selected row according to its type and sets this value for the range.
The Paste method pastes data from clipboard to the current cell range.
The PasteFromStream method pastes data from the specified stream to the current range.
The PasteFromStreamEx method inserts data from the specified stream to the current range according to the set insert parameters.
The Recalc method calculates data in the current range.
The SortColumns method sorts the column range depending on the values contained in the row with the RowIndex index.
The SortRows method sorts the row range depending on the values contained the column with the ColumnIndex index.
The ToArray method creates a two-dimension array.
The ToDouble2DArray method transforms range into two dimension array of real numbers.
The ToDoubleArray method converts a range into a float array.
The ToDoubleArrayEx method transforms the range into integer array with the ability to apply additional transformation parameters.
The ToIntegerArray method converts a range into an integer array.
The Unmerge method cancels merging range cells.

See also:

Tab Assembly Interfaces