Class GridCardView

Provides the information to manipulate the functionalities of CardView.

Inheritance

System.Object

GridCardView

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.GridHelperClasses

Assembly: Syncfusion.GridHelperClasses.Windows.dll

Syntax

public class GridCardView

Constructors

GridCardView()

Initializes a new instance of the GridCardView class.

Declaration

public GridCardView()

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

Type
GridCellActivateAction

AllowResizing

Gets or sets a value indicating whether resizing of GridCardView should be enabled.

Declaration

public bool AllowResizing { get; set; }

Property Value

Type
System.Boolean

ApplyRoundedCorner

Gets or sets a value indicating whether the card to be rounded.

Declaration

public bool ApplyRoundedCorner { get; set; }

Property Value

Type
System.Boolean

BrowseOnly

Gets or sets a value indicating whether the grid should be in browse only state.

Declaration

public bool BrowseOnly { get; set; }

Property Value

Type
System.Boolean

CaptionField

Gets or sets the field to be displayed in the Caption.

Declaration

public string CaptionField { get; set; }

Property Value

Type
System.String

CaptionHeight

Gets or sets the height of the caption cell.

Declaration

public int CaptionHeight { get; set; }

Property Value

Type
System.Int32

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

Type
System.Int32

CardSpacingWidth

Gets or sets the width between each cards.

Declaration

public int CardSpacingWidth { get; set; }

Property Value

Type
System.Int32

CardStyle

Gets or sets the card style.

Declaration

public CardStyle CardStyle { get; set; }

Property Value

Type
CardStyle

Columns

Gets the column information.

Declaration

public GridBoundColumnsCollection Columns { get; }

Property Value

Type
GridBoundColumnsCollection

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

Type
GridCurrentCell

HighlightActiveCard

Gets or sets a value indicating whether active card an be highlighted.

Declaration

public bool HighlightActiveCard { get; set; }

Property Value

Type
System.Boolean

MaxCardCols

Gets or sets the maximum columns of cards.

Declaration

public int MaxCardCols { get; set; }

Property Value

Type
System.Int32

MaxCardRows

Gets or sets the maximum rows of cards.

Declaration

public int MaxCardRows { get; set; }

Property Value

Type
System.Int32

Model

Gets the grid model of the GridCardView.

Declaration

public GridModel Model { get; }

Property Value

Type
GridModel

ShowCaption

Gets or sets a value indicating whether caption should be shown.

Declaration

public bool ShowCaption { get; set; }

Property Value

Type
System.Boolean

ShowCardCellBorders

Gets or sets a value indicating whether cell borders can be shown.

Declaration

public bool ShowCardCellBorders { get; set; }

Property Value

Type
System.Boolean

VisualStyle

Gets or sets the visual themes of the GridCardView.

Declaration

public CardVisualStyles VisualStyle { get; set; }

Property Value

Type
CardVisualStyles

Methods

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

Type	Description
CardCellType	The card cell type.

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.

IsHeaderCell(Int32, Int32)

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.

UnwireGrid()

Unwires the grid and its components.

Declaration

public void UnwireGrid()

WireGrid(GridDataBoundGrid)

Wires the bounded grid to design the card view layout.

Declaration

public void WireGrid(GridDataBoundGrid boundGrid)

Parameters

Type	Name	Description
GridDataBoundGrid	boundGrid	The GridDataBoundGrid.

Events

CellClick

Occurs when the user clicks inside a cell.

Declaration

public event CardCellClickEventHandler CellClick

Event Type

Type
CardCellClickEventHandler

CellDrawn

Occurs for every cell after the grid has drawn the specified cell.

Declaration

public event GridDrawCellEventHandler CellDrawn

Event Type

Type
GridDrawCellEventHandler

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

Type
PopupClosedEventHandler

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

Type
GridCurrentCellErrorMessageEventHandler

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

Type
System.EventHandler

CurrentCellShowingDropDown

Occurs when the drop-down part is about to be shown.

Declaration

public event GridCurrentCellShowingDropDownEventHandler CurrentCellShowingDropDown

Event Type

Type
GridCurrentCellShowingDropDownEventHandler

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

Type
System.EventHandler

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

Type
GridCurrentCellValidateStringEventHandler

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

Type
GridDrawCellDisplayTextEventHandler

DrawCurrentCellBorder

Occurs when the grid draws a border around the current cell.

Declaration

public event GridDrawCurrentCellBorderEventHandler DrawCurrentCellBorder

Event Type

Type
GridDrawCurrentCellBorderEventHandler

PushButtonClick

Occurs when the user clicks a push button.

Declaration

public event CardCellPushButtonClickEventHandler PushButtonClick

Event Type

Type
CardCellPushButtonClickEventHandler

QueryCardCellInfo

Occurs when the card model queries for style information about a specific cell.

Declaration

public event QueryCardCellInfoEventHandler QueryCardCellInfo

Event Type

Type
QueryCardCellInfoEventHandler

SaveCardCellInfo

Occurs when the card model is about to save style information about at specific cell.

Declaration

public event SaveCardCellInfoEventHandler SaveCardCellInfo

Event Type

Type
SaveCardCellInfoEventHandler