[]
        
(Showing Draft Content)

C1.Android.Grid.GridBase

GridBase Class

Control used to display and edit tabular information.

Inheritance
GridBase
Implements
IComponent
IDisposable
Namespace: C1.Android.Grid
Assembly: C1.Android.Grid.dll
Syntax
public class GridBase : ViewGroup, IDependencyObject, IComponent, IDisposable

Constructors

Name Description
GridBase(Context)

Initializes a new instance of the GridBase class.

GridBase(Context, IAttributeSet)

Initializes a new instance of the GridBase class.

Fields

Name Description
AllowDraggingProperty
AllowMergingProperty
AllowRefreshingProperty
AllowResizingProperty
BackgroundColorProperty
BorderColorProperty
BorderWidthProperty
CellPaddingProperty
ColumnHeaderBackgroundColorProperty
ColumnHeaderGridLinesVisibilityProperty
ColumnHeaderSelectedBackgroundColorProperty
ColumnHeaderSelectedTextColorProperty
ColumnHeaderTextColorProperty
ColumnHeaderTextSizeProperty
ColumnHeaderTypefaceProperty
CursorBackgroundColorProperty
CursorTextColorProperty
EditorBackgroundColorProperty
EditorTextColorProperty
FrozenColumnsProperty
FrozenLinesColorProperty
FrozenRowsProperty
GridLinesColorProperty
GridLinesVisibilityProperty
GridLinesWidthProperty
HeaderGridLinesColorProperty
HeadersVisibilityProperty
HorizontalScrollBarVisibilityProperty
IsAnimatedProperty
IsReadOnlyProperty
KeyActionEnterProperty
KeyActionTabProperty
RowBackgroundColorProperty
RowHeaderBackgroundColorProperty
RowHeaderGridLinesVisibilityProperty
RowHeaderSelectedBackgroundColorProperty
RowHeaderSelectedTextColorProperty
RowHeaderTextColorProperty
RowHeaderTextSizeProperty
RowHeaderTypefaceProperty
RowTextColorProperty
SelectionAdornerBorderColorProperty
SelectionAdornerColorProperty
SelectionBackgroundColorProperty
SelectionModeProperty
SelectionTextColorProperty
ShowMarqueeProperty
ShowSelectionMenuProperty
TextColorProperty
TextSizeProperty
TopLeftCellBackgroundColorProperty
TopLeftHeaderGridLinesVisibilityProperty
TypefaceProperty
VerticalScrollBarVisibilityProperty
ZoomModeProperty

Properties

Name Description
ActiveEditor

Gets the cell editor that is currently active.

AllowDragging

Gets or sets a value that indicates whether users are allowed to move rows and columns to new positions.

AllowMerging

Gets or sets a value that indicates which parts of the grid support cell merging.

AllowRefreshing

Gets or sets a value indicating whether the grid can be refreshed by pulling.

AllowResizing

Gets or sets a value that indicates whether users are allowed to resize rows and columns.

BackgroundColor

Gets or sets a the background color of the calendar.

BorderColor

Gets or sets the System.Nullable<> that is used to paint the border.

BorderWidth

Gets or sets the width of the border.

CellFactory

Gets or sets the factory of cells.

CellPadding

Gets or sets the cell padding.

ColumnHeaderBackgroundColor

Gets or sets the System.Nullable<> of the column header background.

ColumnHeaderGridLinesVisibility

Gets or sets a value that indicates which grid lines separating column header cells are shown.

ColumnHeaderSelectedBackgroundColor

Gets or sets the System.Nullable<> that is used to paint column header background for selected cells.

ColumnHeaderSelectedTextColor

Gets or sets the System.Nullable<> that is used to paint column header text for selected cells.

ColumnHeaderTextColor

Gets or sets the System.Nullable<> of the column header text and glyphs.

ColumnHeaderTextSize

Gets or sets the font size applied to column header cells.

ColumnHeaderTypeface

Gets or sets the typeface applied to column header cells.

CursorBackgroundColor

Gets or sets the System.Nullable<> that is used to paint the background of cursor cell.

CursorRange

Gets the GridCellRange that corresponds to the cursor cell.

CursorTextColor

Gets or sets the System.Nullable<> that is used to paint the text of cursor cell.

DefaultColumnHeadersRowHeight

Gets or sets the default height of the rows used to display column headers.

EditorBackgroundColor

Gets or sets the System.Nullable<> that is used to paint the background of cells in edit mode.

EditorRange

Gets the GridCellRange that corresponds to the cell currently being edited.

EditorTextColor

Gets or sets the System.Nullable<> that is used to paint the foreground of cells in edit mode.

FrozenColumns

Gets or sets the number of frozen columns.

FrozenLinesColor

Gets or sets the System.Nullable<> that is used to paint the lines between frozen and scrollable areas of the grid.

FrozenRows

Gets or sets the number of frozen rows.

GridLinesColor

Gets or sets the System.Nullable<> that is used to paint the lines between cells.

GridLinesVisibility

Gets or sets a value that indicates which grid lines separating inner cells are shown.

GridLinesWidth

Gets or sets the width of the lines between cells.

HeaderGridLinesColor

Gets or sets the System.Nullable<> that is used to paint the lines between row and column header cells.

HeadersGridLinesVisibility

Gets or sets a value that indicates which grid lines separating header cells are shown.

HeadersVisibility

Gets or sets a value that indicates the visibility of row and column headers.

HorizontalScrollBarVisibility

Gets or sets the horizontal scroll bar visibility.

IsAnimated

Gets or sets whether the control is animated during navigation.

IsReadOnly

Gets or sets a value to determine whether the grid is read-only.

KeyActionEnter

Gets or sets the action to perform when the Enter key is pressed.

KeyActionTab

Gets or sets the action to perform when the Tab key is pressed.

MergeManager

Gets or sets the merge manager.

RowBackgroundColor

Gets or sets the System.Nullable<> that is used to paint row backgrounds.

RowHeaderBackgroundColor

Gets or sets the System.Nullable<> of the row header background.

RowHeaderGridLinesVisibility

Gets or sets a value that indicates which grid lines separating row header cells are shown.

RowHeaderSelectedBackgroundColor

Gets or sets the System.Nullable<> that is used to paint row header background for selected cells.

RowHeaderSelectedTextColor

Gets or sets the System.Nullable<> that is used to paint row header text for selected cells.

RowHeaderTextColor

Gets or sets the System.Nullable<> of the row header text and glyphs.

RowHeaderTextSize

Gets or sets the font size applied to row header cells.

RowHeaderTypeface

Gets or sets the font family applied to row header cells.

RowTextColor

Gets or sets the System.Nullable<> that is used to paint the text color of rows.

ScrollPosition

Gets or sets the scroll position.

Selection

Gets or sets the current selection.

SelectionAdornerBorderColor

Gets or sets the System.Nullable<> of the selection adorner border.

SelectionAdornerColor

Gets or sets the System.Nullable<> of the selection adorner.

SelectionBackgroundColor

Gets or sets the System.Nullable<> that is used to paint the background of selected cells.

SelectionMode

Gets or sets how the cells or rows are selected.

SelectionTextColor

Gets or sets the System.Nullable<> of the selected text.

ShowMarquee

Gets or sets a value that indicates whether the grid shows an Excel-style marquee around the current selection.

ShowSelectionMenu

Gets or sets a value that indicates whether the grid shows menu when select rows or cells.

Site

IComponent Site

TextColor

Gets or sets the System.Nullable<> of the text and glyphs.

TextSize

Gets or sets the font size applied to normal cells.

TopLeftCellBackgroundColor

Gets or sets the System.Nullable<> that is used to paint the background of the cell at the left top corner of the grid.

TopLeftHeaderGridLinesVisibility

Gets or sets a value that indicates which grid lines separating top-left header cells are shown.

Typeface

Gets or sets the typeface applied to normal cells.

UpdateAnimation

Gets an object containing the animation settings that will be applied when updating cells.

VerticalScrollBarVisibility

Gets or sets the vertical scroll bar visibility.

ViewRange

Gets a GridCellRange value that indicates the range of cells currently visible on the grid.

ZoomMode

Gets or sets the zoom mode.

Methods

Name Description
CanRefresh()

Determines whether the grid shows the refresh indicator when pulled.

ChangeView(Nullable<double>, Nullable<double>, Nullable<double>, bool)

Changes the scroll and zoom of the grid to the specified part of the viewport.

Copy()

Copy the current selection to the clipboard.

CreateSelectionMenu(GridCellRange)

Creates the selection menu.

Cut()

Cut the current selection and copy to the clipboard.

Dispose(bool)
FinishEditing(bool)

Commits or cancels any pending edits and exits edit mode.

GetSelectedState(int, int)

Gets a GridSelectedState value that indicates the selected state of the cells in a specified column and row.

LoadDesignTimeData()

Loads dummy design time content visible in Storyboard and Android designer

OnAttachedToWindow()
OnBeginningEdit(GridCellEditEventArgs)

Raises the BeginningEdit event.

OnCellDoubleTapped(GridCellType, GridCellRange, C1TappedEventArgs)

Called when a cell is double tapped.

OnCellDoubleTapped(GridInputEventArgs)

Called when a cell is double tapped.

OnCellEditEnded(GridCellEditEventArgs)

Raises the CellEditEnded event.

OnCellEditEnding(GridCellEditEventArgs)

Raises the CellEditEnding event.

OnCellLongPressed(GridCellType, GridCellRange, C1TappedEventArgs)

Called when a cell is being held.

OnCellLongPressed(GridInputEventArgs)

Called when a cell is being held.

OnCellTapped(GridCellType, GridCellRange, C1TappedEventArgs)

Called when a cell is tapped.

OnCellTapped(GridInputEventArgs)

Called when a cell is tapped.

OnCreatingSelectionMenu(GridSelectionMenuEventArgs)

Raises the CreatingSelectionMenu event giving the opportunity to customize the menu that will be displayed.

OnCursorChanged(GridCellRangeEventArgs)

Raises the CursorChanged event.

OnCursorChanging(GridCellRangeEventArgs)

Raises the CursorChanging event.

OnDetachedFromWindow()
OnDisposed()

Called after the object was disposed.

OnDisposing()

Called when the object is being disposed.

OnIsReadOnlyChanged()

Called when the property IsReadOnly changed.

OnKeyDown(Keycode, KeyEvent)
OnLayout(bool, int, int, int, int)
OnMeasure(int, int)
OnPrepareCellForEdit(GridCellEditEventArgs)

Raises the PrepareCellForEdit event.

OnRefreshAsync(GridRefreshEventArgs)

Called when the refresh was pulled.

OnResizedColumn(GridCellRangeEventArgs)

Raises the ResizedColumn event.

OnResizedRow(GridCellRangeEventArgs)

Raises the ResizedRow event.

OnResizingColumn(GridCellRangeEventArgs)

Raises the ResizingColumn event.

OnResizingRow(GridCellRangeEventArgs)

Raises the ResizingRow event.

OnScrollPositionChanged(EventArgs)

Called when the scroll position changed.

OnSelectionChanged(GridCellRangeEventArgs)

Raises the SelectionChanged event.

OnSelectionChanging(GridCellRangeEventArgs)

Raises the SelectionChanging event.

Paste()

Pastes the content of the clipboard to the grid.

Refresh()

Recreates all the cells.

Refresh(Nullable<GridCellType>, GridCellRange)

Refreshes the specified cells.

ScrollIntoView(GridCellRange, double, bool)

Scrolls the grid to bring a specified range into view.

ScrollIntoView(int, int, double, bool)

Scrolls the grid to bring a specific cell into view.

Select(GridCellRange, bool, bool)

Selects a given cell and optionally scrolls it into view.

Select(int, int, bool, bool)

Selects a given cell and optionally scrolls it into view.

SelectAll()

Selects all the cells.

SetCursor(int, int)

Sets the cursor of the grid to the specified row and column.

StartEditing(int, int, bool, bool)

Starts editing a specific cell.

Events

Name Description
BeginningEdit

Occurs when the edit of a cell is about to start.

CellDoubleTapped

Occurs when a cell is double tapped.

CellEditEnded

Occurs after the edit of a cell is committed.

CellEditEnding

Occurs before the edit of a cell is committed.

CellLongPressed

Occurs when a cell is being held.

CellTapped

Occurs when a cell is tapped.

CreatingSelectionMenu

Occurs when the selection menu is created. This event can be used to customize the displayed menu.

CursorChanged

Occurs after the cursor is changed.

CursorChanging

Occurs before the cursor is changed.

Disposed

Occurs when the object is disposed.

PrepareCellForEdit

Occurs when an editor cell is created and before it becomes active.

Refreshing

Occurs when the user pulls the grid to be refreshed.

ResizedColumn

Occurs when the user finishes resizing a column.

ResizedRow

Occurs when the user finishes resizing a row.

ResizingColumn

Occurs when the user starts resizing a column.

ResizingRow

Occurs when the user starts resizing a row.

ScrollPositionChanged

Occurs when scroll position changed.

SelectionChanged

Occurs after selection changed.

SelectionChanging

Occurs before selection is changed.