[]
        
(Showing Draft Content)

C1.Win.C1List.ListBase.C1ListBase

C1ListBase Class

The abstract base class for C1List.

Namespace: C1.Win.C1List.ListBase
Assembly: C1.Win.C1List.4.8.dll
Syntax
public abstract class C1ListBase : Frame, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, ISupportInitialize

Constructors

Name Description
C1ListBase()

Properties

Name Description
AddItemCols

Returns or sets the column number for the AddItem mode.

AddItemSeparator

Determines the separation string for columns when using the AddItem method in AddItem mode.

AllowColMove

Enables/disables interactive column movement.

AllowHorizontalSplit

Specifies if a user is allowed to create horizontal splits.

AllowRowSizing

Specifies if a user is allowed to resize the rows in the list.

AllowVerticalSplit

Specifies if a user is allowed to create vertical splits.

AlternatingRows

Determines if a list or split displays odd-numbered rows in one style and even-numbered rows in another.

Bookmark

Returns or sets the bookmark identifying the current row in the list.

CaptionStyle

Returns or sets the Style object that controls the appearance of the caption area.

CellTips

Determines whether the list displays a pop-up text window when the cursor is idle.

CellTipsDelay

Determines the amount of time before the cell tip window is displayed.

CellTipsWidth

Returns or sets the width of the cell tip window.

Col

Gets or sets the column position of the current cell in the current split.

ColumnCaptionHeight

Returns or sets the height of the column headers.

ColumnFooterHeight

Returns or sets the height of the column footers.

ColumnFooters

Specifies whether footers are displayed.

ColumnHeaders

Specifies whether headers are displayed.

ColumnWidth

Returns or sets the column width for each column in the control.

Columns

Returns a collection of C1DataColumn objects.

CurrentCellVisible

Gets or sets a value indicating the visibility of the current cell in a split.

DataMode

Specifies the normal or additem mode.

DataView

Returns or sets the method by which the list will display data.

DeadAreaBackColor

Controls the background color of the dead area in the list.

DefColWidth

Specifies column width for auto-created columns.

DestinationCol

Indicates which list column will be the destination after cell movement.

DestinationRow

Indicates which list row will be the destination after cell movement.

DestinationSplit

Indicates which list split will be the destination after cell movement.

DisplayMember

Returns or sets the DataSource field used for incremental search.

EmptyRows

Returns or sets a value that determines how the list displays rows below the last data row.

EvenRowStyle

Returns or sets the Style object that controls the appearance of an even-numbered row.

ExtendRightColumn

Returns or sets whether the last column will extend to fill the dead area of the list.

FetchRowStyles

Specifies whether the FetchRowStyle event will be fired.

FlatStyle

Determines the appearance of the list.

FocusedSplit

Gets the Split that has focus.

FooterStyle

Returns the Style object that controls the appearance of column footers.

HScrollBar

Returns the HBar object that controls the appearance of the horizontal scrollbar.

HeadingStyle

Returns the Style object that controls the appearance of column heading.

HighLightRowStyle

Returns the Style object that controls the appearance of hight light row.

HotTracking

Controls whether rows are automatically highlighted as the mouse is moved over the C1List control.

IntegralHeight

Controls whether partial rows are displayed.

ItemHeight

Returns or sets the height of all list rows.

LeftCol

Returns or sets the zero-based index of the leftmost column in a list or split.

ListCount

Returns the total row number for the control.

OddRowStyle

Returns or sets the Style object that controls the appearance of an odd-numbered row.

PartialRightColumn

True if rightmost column can be clipped to the edge of a split.

RightToLeft

When True, applies right to left text functionality.

Row

Returns or sets the position of current list row relative to the first displayed row.

RowDivider

Determines the style of the border drawn between list rows.

RowSubDividerColor

Returns or sets the color of a RowSubDivider.

ScrollTips

Determines whether the list displays a pop-up text window when the scrollbar thumb is dragged.

SelectedCols

Returns the SelectedColumnCollection object.

SelectedIndex

Returns or sets the bookmark of the currently selected item.

SelectedIndices

Returns the SelectedRowCollection object.

SelectedStyle

Returns the Style object that controls the appearance of selected cells.

SelectedText

Gets or sets the text of the current selected row specified by the DisplayMember property.

SelectedValue

Gets or sets the value of the member property specified by the ValueMember property.

SelectionMode

Returns or sets the type of selection allowed in the list.

Split

Returns current split number.

SplitIndex

Gets or sets the index of the current Split within the SplitCollection.

Splits

Returns a Collection of Split objects.

SpringMode

Specifies whether the columns will resize when the list is resized.

Style

Returns or sets the normal Style object for the list.

Styles

Returns a collection of named Style objects.

TopIndex

Returns or sets a value containing the bookmark for the first visible row in a list or split.

VScrollBar

Returns or sets the VBar object that controls the appearance of the vertical scrollbar.

ValueMember

Specifies the field name for binding purposes.

ValueTranslate
VisibleCols

Returns the number of visible columns in the current split.

VisibleRows

Returns the number of visible rows in the list.

WillChangeToIndex

Returns the bookmark identifying the will-be selected item in a control.

WillChangeToText

Returns the string identifying the text for the item to be selected.

WillChangeToValue

Returns the object identifying the value to be selected.

Methods

Name Description
AddCellStyle(CellStyleFlag, Style)

Controls the font and color of cells within a list, column, or split according to value.

AddItem(string)

Add a new item to the end in the AddItem(string) mode.

AddItemTitles(string)

Sets the column titles in the AddItem(string) mode.

AddRegexCellStyle(CellStyleFlag, Style, string)

Controls the font and color of cells within a list, column, or split according to their contents.

CaptureImage()
CellContaining(int, int, out int, out int)

Returns the cell position for a set of coordinates.

ClearCellStyle(CellStyleFlag)

Removes a cell condition established with a previous call to the AddCellStyle(CellStyleFlag, Style) method.

ClearItems()

Clear all of the items in the AddItem(string) mode.

ClearRegexCellStyle(CellStyleFlag)

Removes a cell condition established with a previous call to the AddRegexCellStyle(CellStyleFlag, Style, string) method.

ClearRegexCellStyle(CellStyleFlag, string)

Removes a cell condition established with a previous call to the AddRegexCellStyle(CellStyleFlag, Style, string) method.

ClearSelCols()

Deselects all selected columns in the current split.

ClearSelected()

Clears all selected rows.

ColContaining(int)

Returns the column index containing the specified coordinate.

Dispose(bool)

Clean up any resources being used.

EndInit()

Signals the object that initialization is complete.

ExportToDelimitedFile(string, RowSelectorEnum)

Exports the specified rows from the list to the specified file as delimited ASCII text.

ExportToDelimitedFile(string, RowSelectorEnum, string)

Exports the specified rows from the list to the specified file as delimited ASCII text.

ExportToDelimitedFile(string, RowSelectorEnum, string, string)

Exports the specified rows from the list to the specified file as delimited ASCII text.

ExportToDelimitedFile(string, RowSelectorEnum, string, string, string)

Exports the specified rows from the list to the specified file as delimited ASCII text.

ExportToDelimitedFile(string, RowSelectorEnum, string, string, string, bool)

Exports the specified rows from the list to the specified file as delimited ASCII text.

GetDisplayText(int, int)

Gets the display text for the specified row and column.

GetItemText(int, int)

Gets the cell text for any cell.

GetItemText(int, string)

Gets the cell text for any cell.

GetSelected(int)

Checks whether the given row is selected.

HoldFields()

Holds the current column/field layout.

IndexFromPoint(Point)

Returns the row index for a given point.

InitializeStyles()
InsertHorizontalSplit(int)

Inserts a horizontal split at the specified index.

InsertItem(string, int)

Inserts a new item at the index position in the AddItem(string) mode.

InsertVerticalSplit(int)

Inserts a vertical split at the specified index.

OnAfterSort(FilterEventArgs)

Raises the AfterSort event.

OnColMove(ColMoveEventArgs)

Raises the ColMoveEvent.

OnColResize(ColResizeEventArgs)

Raises the ColResize event.

OnColSelected(ColEventArgs)

Raises the ColSelected event.

OnDataSourceChanged(EventArgs)

Raises the DataSourceChanged event.

OnDisplayMemberChanged(EventArgs)

Raises the DisplayMemberChanged event.

OnError(ErrorEventArgs)

Raises the Error event

OnFetchCellStyle(FetchCellStyleEventArgs)

Raises the FetchCellStyle event.

OnFetchCellTips(FetchCellTipsEventArgs)

Raises the FetchCellTips event.

OnFetchRowStyle(FetchRowStyleEventArgs)

Raises the FetchRowStyle event.

OnFetchScrollTips(FetchScrollTipsEventArgs)

Raises the FetchScrollTips event.

OnFontChanged(EventArgs)
OnFootClick(ColEventArgs)

Raises the FootClick event.

OnFormatText(FormatTextEventArgs)

Raises the FromatText event.

OnHeadClick(ColEventArgs)

Raises the HeadClick event.

OnLayoutReady(EventArgs)
OnLeftColChange(SplitEventArgs)

Raises the LeftColChange event.

OnListCountChanged()

Calls when binding list changed.

OnOwnerDrawCell(OwnerDrawCellEventArgs)

Raises the OwnerDrawCell event.

OnPaint(PaintEventArgs)
OnRowChange(EventArgs)

Raises the RowChange event.

OnRowColChange(RowColChangeEventArgs)

Raises the RowColChange event.

OnRowResize(CancelEventArgs)

Raises the RowResize event.

OnScroll1(CancelEventArgs)
OnSelChange(CancelEventArgs)

Raises the SelChang event.

OnSelectedValueChanged(EventArgs)

Raises the SelectedValueChanged event.

OnSplitChange(EventArgs)

Raises the SplitChange event.

OnSplitRemoved(EventArgs)

Raised when horizontal or vertical splits are removed.

OnTopIndexChange(SplitEventArgs)

Raises the TopIndexChange event.

OnUnboundColumnFetch(UnboundColumnFetchEventArgs)

Raises the UnboundColumnFetch event.

OnValueMemberChanged(EventArgs)

Raises the ValueMemberChanged event.

PointAt(int, int)

Returns one of the PointAtEnum constants, which indicates the kind of list element beneath the specified coordinate pair.

Rebind()

Re-establishes the connection with the bound data source.

Rebind(bool)

Reinitializes list with data from its data source.

RemoveHorizontalSplit(int)

Removes a horizontal split at the specified index.

RemoveItem(int)

Removes the item at the given position in the AddItem(string) mode.

RemoveVerticalSplit(int)

Removes a vertical split at the specified index.

ResetColumnCaptionHeight()

Restore the ColumnCaptionHeight property to its default value.

ResetColumnFooterHeight()

Restore the ColumnFooterHeight property to its default value.

ResetItemHeight()
ResumeBinding()

Resumes data binding notification from the datasource.

RowContaining(int)

Returns the zero-based index of the display row containing the specified coordinate.

RowTop(int)

Returns the Y coordinate of the top of a visible row.

ScrollCtl(int, int)

Scrolls the list data area by the specified number of rows and columns.

SetAddItemData(int, int, string)

Updates the cell data for the AddItem mode.

SetDataSource(object, BindingMemberInfo, bool)
SetSelected(int, bool)

Selects or unselects a row from the code.

ShouldSerializeColumnCaptionHeight()

Indicates whether the ColumnCaptionHeight has a default value.

ShouldSerializeColumnFooterHeight()

Indicates whether the ColumnFooterHeight has a default value.

ShouldSerializeItemHeight()
Sort(int, SortDirEnum)

Sorts a specific column for the control.

Sort(string, SortDirEnum)

Sorts a specific column for the control.

SplitContaining(int, int)

Returns the Index value of the split containing the specified coordinate pair.

SuspendBinding()

Temporary suspension of data binding notifications from the datasource.

canCreateSplits()

Events

Name Description
AfterSort

Fires after a column is sorted by clicking the column header.

ColFootClick

Fires when the footer of the control is clicked.

ColHeadClick

Fires when the headers of the control is clicked.

ColMove

Fires when the user has finished moving the selected columns.

ColResize

Fires after the user has finished resizing a column.

ColSelected

Fires when a column is selected.

DataSourceChanged

Fires when a bound data source is changed or requeried.

DisplayMemberChanged

Occurs when the DisplayMember property changes.

Error

Fires when a data access error occurs.

FetchCellStyle

Fires when the list is about to display cell data in a column whose FetchStyle property is set to True.

FetchCellTips

Fires when the control has focus and the cursor is idle for a small amount of time (defined by the CellTipsDelay property) over a data cell, column header, column footer, split header or control caption bar.

FetchRowStyle

Fires whenever the list is about to display a row of data and the FetchRowStyles property is True.

FetchScrollTips

Fires whenever the list has focus and the scrollbar thumb is moved using the mouse.

FormatText

Fires when the list is about to display cell data in a column whose NumberFormat property is set.

LayoutReady

Fires when asynchronous downloading of a control layout file has been completed.

LeftColChange

Fires when the first visible column of a list or split is changed.

OnScroll

Fires when the user scrolls the list horizontally or vertically using the scroll bars.

OwnerDrawCell

Fires just before the cell is to be painted when the column's OwnerDraw is true.

RowChange

Fires when the user changes a row in the list.

RowResize

Fires when the user has finished resizing a list row.

SelChange

Fires when the user selects a different range of rows or columns.

SelectedValueChanged

Occurs when the SelectedValue property changes.

SplitChange

Occurs whenever a Split changes focus.

SplitRemoved

Occurs whenever horizontal or vertical splits are removed.

TopIndexChange

Fires when the first displayed row of a control or split is changed.

UnboundColumnFetch

Fires when the control needs to display the value of a cell in an unbound column.

ValueMemberChanged

Occurs when the ValueMember property changes.