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:

• ITabSearchResult.Range

• ITabSelection.Range

• ITabSheet.Cell

• ITabSheet.Cells

• ITabSheet.Column

• ITabSheet.Columns

• ITabSheet.ParseCell

• ITabSheet.ParseCellEx

• ITabSheet.ParseRange

• ITabSheet.ParseRangeEx

• ITabSheet.Row

• ITabSheet.Rows

• ITabSheet.Table

Properties

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

Methods

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

See also:

Tab Assembly Interfaces