Class GridCardView
Provides the information to manipulate the functionalities of CardView.
Inheritance
System.Object
GridCardView
Assembly: Syncfusion.GridHelperClasses.Windows.dll
Syntax
public class GridCardView : Object
Constructors
GridCardView()
Declaration
Properties
ActivateCurrentCellBehavior
Gets or sets a current cell activation behavior when moving the current cell or clicking inside a cell.
Declaration
public GridCellActivateAction ActivateCurrentCellBehavior { get; set; }
Property Value
AllowResizing
Gets or sets a value indicating whether resizing of GridCardView should be enabled.
Declaration
public bool AllowResizing { get; set; }
Property Value
ApplyRoundedCorner
Gets or sets a value indicating whether the card to be rounded.
Declaration
public bool ApplyRoundedCorner { get; set; }
Property Value
BrowseOnly
Gets or sets a value indicating whether the grid should be in browse only state.
Declaration
public bool BrowseOnly { get; set; }
Property Value
CaptionField
Gets or sets the field to be displayed in the Caption.
Declaration
public string CaptionField { get; set; }
Property Value
CaptionHeight
Gets or sets the height of the caption cell.
Declaration
public int CaptionHeight { get; set; }
Property Value
CardBackColor
Gets or sets the backcolor of the outer area.
Declaration
public Color CardBackColor { get; set; }
Property Value
| Type |
| System.Drawing.Color |
CardSpacingHeight
Gets or sets the height between each cards.
Declaration
public int CardSpacingHeight { get; set; }
Property Value
CardSpacingWidth
Gets or sets the width between each cards.
Declaration
public int CardSpacingWidth { get; set; }
Property Value
CardStyle
Gets or sets the card style.
Declaration
public CardStyle CardStyle { get; set; }
Property Value
Columns
Gets the column information.
Declaration
public GridBoundColumnsCollection Columns { get; }
Property Value
CurrentCell
Gets GridCurrentCell object that provides storage
for current cell information and manages all current cell operation such
as activating, deactivating, saving, editing, and moving the current cell.
Declaration
public GridCurrentCell CurrentCell { get; }
Property Value
HighlightActiveCard
Gets or sets a value indicating whether active card an be highlighted.
Declaration
public bool HighlightActiveCard { get; set; }
Property Value
MaxCardCols
Gets or sets the maximum columns of cards.
Declaration
public int MaxCardCols { get; set; }
Property Value
MaxCardRows
Gets or sets the maximum rows of cards.
Declaration
public int MaxCardRows { get; set; }
Property Value
Model
Declaration
public GridModel Model { get; }
Property Value
ShowCaption
Gets or sets a value indicating whether caption should be shown.
Declaration
public bool ShowCaption { get; set; }
Property Value
ShowCardCellBorders
Gets or sets a value indicating whether cell borders can be shown.
Declaration
public bool ShowCardCellBorders { get; set; }
Property Value
VisualStyle
Declaration
public CardVisualStyles VisualStyle { get; set; }
Property Value
Methods
add_CellClick(CardCellClickEventHandler)
Declaration
public void add_CellClick(CardCellClickEventHandler value)
Parameters
Declaration
public void add_CellDrawn(GridDrawCellEventHandler value)
Parameters
Declaration
public void add_CurrentCellCloseDropDown(PopupClosedEventHandler value)
Parameters
Declaration
public void add_CurrentCellErrorMessage(GridCurrentCellErrorMessageEventHandler value)
Parameters
Declaration
public void add_CurrentCellShowingDropDown(GridCurrentCellShowingDropDownEventHandler value)
Parameters
Declaration
public void add_CurrentCellValidateString(GridCurrentCellValidateStringEventHandler value)
Parameters
add_DrawCellDisplayText(GridDrawCellDisplayTextEventHandler)
Declaration
public void add_DrawCellDisplayText(GridDrawCellDisplayTextEventHandler value)
Parameters
Declaration
public void add_DrawCurrentCellBorder(GridDrawCurrentCellBorderEventHandler value)
Parameters
Declaration
public void add_PushButtonClick(CardCellPushButtonClickEventHandler value)
Parameters
add_QueryCardCellInfo(QueryCardCellInfoEventHandler)
Declaration
public void add_QueryCardCellInfo(QueryCardCellInfoEventHandler value)
Parameters
add_SaveCardCellInfo(SaveCardCellInfoEventHandler)
Declaration
public void add_SaveCardCellInfo(SaveCardCellInfoEventHandler value)
Parameters
GetCardCellType(Int32, Int32)
Gets the type of the card cell.
Declaration
public CardCellType GetCardCellType(int rowIndex, int colIndex)
Parameters
| Type |
Name |
Description |
| System.Int32 |
rowIndex |
The row index.
|
| System.Int32 |
colIndex |
The column index.
|
Returns
IsActiveCard(Int32, Int32)
Determines whether the state of the card is active.
Declaration
public bool IsActiveCard(int rowIndex, int colIndex)
Parameters
| Type |
Name |
Description |
| System.Int32 |
rowIndex |
The row index.
|
| System.Int32 |
colIndex |
The column index.
|
Returns
| Type |
Description |
| System.Boolean |
The boolean value.
|
IsCardCaption(Int32, Int32)
Indicates if the cell is a caption cell.
Declaration
public bool IsCardCaption(int rowIndex, int colIndex)
Parameters
| Type |
Name |
Description |
| System.Int32 |
rowIndex |
The row index.
|
| System.Int32 |
colIndex |
The column index.
|
Returns
| Type |
Description |
| System.Boolean |
The boolean value.
|
Indicates if the cell is header column cell.
Declaration
public bool IsHeaderCell(int rowIndex, int colIndex)
Parameters
| Type |
Name |
Description |
| System.Int32 |
rowIndex |
The row index.
|
| System.Int32 |
colIndex |
The column index.
|
Returns
| Type |
Description |
| System.Boolean |
The boolean value.
|
IsRecordCell(Int32, Int32)
Indicates if the cell is any record cell.
Declaration
public bool IsRecordCell(int rowIndex, int colIndex)
Parameters
| Type |
Name |
Description |
| System.Int32 |
rowIndex |
The row index.
|
| System.Int32 |
colIndex |
The column index.
|
Returns
| Type |
Description |
| System.Boolean |
The boolean value.
|
IsValueCell(Int32, Int32)
Indicates if the cell is a value cell.
Declaration
public bool IsValueCell(int rowIndex, int colIndex)
Parameters
| Type |
Name |
Description |
| System.Int32 |
rowIndex |
The row index.
|
| System.Int32 |
colIndex |
The column index.
|
Returns
| Type |
Description |
| System.Boolean |
The boolean value.
|
remove_CellClick(CardCellClickEventHandler)
Declaration
public void remove_CellClick(CardCellClickEventHandler value)
Parameters
Declaration
public void remove_CellDrawn(GridDrawCellEventHandler value)
Parameters
Declaration
public void remove_CurrentCellCloseDropDown(PopupClosedEventHandler value)
Parameters
Declaration
public void remove_CurrentCellErrorMessage(GridCurrentCellErrorMessageEventHandler value)
Parameters
Declaration
public void remove_CurrentCellShowingDropDown(GridCurrentCellShowingDropDownEventHandler value)
Parameters
Declaration
public void remove_CurrentCellValidateString(GridCurrentCellValidateStringEventHandler value)
Parameters
remove_DrawCellDisplayText(GridDrawCellDisplayTextEventHandler)
Declaration
public void remove_DrawCellDisplayText(GridDrawCellDisplayTextEventHandler value)
Parameters
Declaration
public void remove_DrawCurrentCellBorder(GridDrawCurrentCellBorderEventHandler value)
Parameters
Declaration
public void remove_PushButtonClick(CardCellPushButtonClickEventHandler value)
Parameters
remove_QueryCardCellInfo(QueryCardCellInfoEventHandler)
Declaration
public void remove_QueryCardCellInfo(QueryCardCellInfoEventHandler value)
Parameters
remove_SaveCardCellInfo(SaveCardCellInfoEventHandler)
Declaration
public void remove_SaveCardCellInfo(SaveCardCellInfoEventHandler value)
Parameters
UnwireGrid()
Unwires the grid and its components.
Declaration
Wires the bounded grid to design the card view layout.
Declaration
public void WireGrid(GridDataBoundGrid boundGrid)
Parameters
Events
CellClick
Occurs when the user clicks inside a cell.
Declaration
public event CardCellClickEventHandler CellClick
Event Type
CellDrawn
Occurs for every cell after the grid has drawn the specified cell.
Declaration
public event GridDrawCellEventHandler CellDrawn
Event Type
CurrentCellAcceptedChanges
Occurs when the grid accepts changes made to the active current cell.
Declaration
public event CancelEventHandler CurrentCellAcceptedChanges
Event Type
| Type |
| System.ComponentModel.CancelEventHandler |
CurrentCellCloseDropDown
Occurs when the drop-down part of the current cell is closed.
Declaration
public event PopupClosedEventHandler CurrentCellCloseDropDown
Event Type
CurrentCellErrorMessage
The CurrentCellErrorMessage notifies you that the current cell validation
failed and a message is displayed. You can cancel the event and display your
own custom messagebox.
Declaration
public event GridCurrentCellErrorMessageEventHandler CurrentCellErrorMessage
Event Type
CurrentCellKeyDown
Occurs when the current cell state tends to change on key down.
Declaration
public event KeyEventHandler CurrentCellKeyDown
Event Type
| Type |
| System.Windows.Forms.KeyEventHandler |
CurrentCellKeyPress
Occurs when the current cell state tends to change on key press.
Declaration
public event KeyPressEventHandler CurrentCellKeyPress
Event Type
| Type |
| System.Windows.Forms.KeyPressEventHandler |
CurrentCellKeyUp
Occurs when the current cell state tends to change on key up.
Declaration
public event KeyEventHandler CurrentCellKeyUp
Event Type
| Type |
| System.Windows.Forms.KeyEventHandler |
CurrentCellRejectedChanges
Occurs when the grid rejects changes made to the active current cell.
Declaration
public event EventHandler CurrentCellRejectedChanges
Event Type
CurrentCellShowingDropDown
Occurs when the drop-down part is about to be shown.
Declaration
public event GridCurrentCellShowingDropDownEventHandler CurrentCellShowingDropDown
Event Type
CurrentCellStartEditing
Occurs before the current cell switches into editing mode.
Declaration
public event CancelEventHandler CurrentCellStartEditing
Event Type
| Type |
| System.ComponentModel.CancelEventHandler |
CurrentCellValidated
Occurs when the grid has successfully validated the contents of the active current cell.
Declaration
public event EventHandler CurrentCellValidated
Event Type
CurrentCellValidateString
Occurs after the user presses a key in the current cell and before it is
accepted. Allows you to limit the keys that are accepted for the current
cell while the user is typing text.
Declaration
public event GridCurrentCellValidateStringEventHandler CurrentCellValidateString
Event Type
CurrentCellValidating
Occurs when the grid validates contents of the active current cell.
Declaration
public event CancelEventHandler CurrentCellValidating
Event Type
| Type |
| System.ComponentModel.CancelEventHandler |
DrawCellDisplayText
Occurs for every cell before the grid draws the display text for the specified cell.
Declaration
public event GridDrawCellDisplayTextEventHandler DrawCellDisplayText
Event Type
DrawCurrentCellBorder
Occurs when the grid draws a border around the current cell.
Declaration
public event GridDrawCurrentCellBorderEventHandler DrawCurrentCellBorder
Event Type
Occurs when the user clicks a push button.
Declaration
public event CardCellPushButtonClickEventHandler PushButtonClick
Event Type
QueryCardCellInfo
Occurs when the card model queries for style information about a specific cell.
Declaration
public event QueryCardCellInfoEventHandler QueryCardCellInfo
Event Type
SaveCardCellInfo
Occurs when the card model is about to save style information about at specific cell.
Declaration
public event SaveCardCellInfoEventHandler SaveCardCellInfo
Event Type