WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridModelOptions - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridModelOptions

    Implements properties that allow you to adjust behavior and appearance of the grid.

    Inheritance
    System.Object
    GridModelOptions
    Implements
    System.IDisposable
    System.Runtime.Serialization.ISerializable
    System.Runtime.Serialization.IDeserializationCallback
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public class GridModelOptions : IDisposable, ISerializable, IDeserializationCallback

    Constructors

    GridModelOptions()

    Initializes a new instance of GridModelOptions.

    Declaration
    public GridModelOptions()

    GridModelOptions(SerializationInfo, StreamingContext)

    Initializes a new instance of GridModelOptions from a serialization stream.

    Declaration
    protected GridModelOptions(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    An object that holds all the data needed to serialize or de-serialize this instance.

    System.Runtime.Serialization.StreamingContext context

    Describes the source and destination of the serialized stream specified by info.

    Properties

    ActivateCurrentCellBehavior

    Gets or sets current cell activation behavior when moving the current cell or clicking inside a cell.

    Declaration
    public GridCellActivateAction ActivateCurrentCellBehavior { get; set; }
    Property Value
    Type Description
    GridCellActivateAction

    A GridCellActivateAction enumeration that defines when to set the focus / toggle edit mode for the current cell.

    ActivateSendKey

    Gets or sets Activate the SendKey when pressing the negative sign key.

    Declaration
    public bool ActivateSendKey { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowDragSelectedCols

    Gets or sets a value indicating whether to allow the user to drag selected columns by clicking on the column header.

    Declaration
    public bool AllowDragSelectedCols { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    You can customize the mouse controller's behavior at run-time while the user is performing the action by subscribing to the SelectionDragging and SelectionDragged events.

    AllowDragSelectedRows

    Gets or sets a value indicating whether to allow the user to drag selected rows by clicking on the row header.

    Declaration
    public bool AllowDragSelectedRows { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    You can customize the mouse controller's behavior at run-time while the user is performing the action by subscribing to the SelectionDragging and SelectionDragged events.

    AllowScrollCurrentCellInView

    Gets or sets ScrollCurrentCellInView behavior of the grid.

    Declaration
    public GridScrollCurrentCellReason AllowScrollCurrentCellInView { get; set; }
    Property Value
    Type Description
    GridScrollCurrentCellReason

    A GridScrollCurrentCellReason that specifies options to be applied.

    Remarks

    You can customize the current cell's scroll behavior at run-time by subscribing to the QueryScrollCellInView event.

    The AllowScrollCurrentCellInView property lets you specify the mask for which reason the scrolling should happen.

    AllowSelection

    Gets or sets selection behavior of the grid.

    Declaration
    public GridSelectionFlags AllowSelection { get; set; }
    Property Value
    Type Description
    GridSelectionFlags

    A GridSelectionFlags that specifies options to be applied.

    Remarks

    You can customize the mouse controller's behavior at run-time while the user is performing the action by subscribing to the SelectionChanging and SelectionChanged events.

    The SelectCellsMouseButtonsMask property lets you decide which mouse buttons can be used for selecting cells.

    AllowThumbTrack

    Gets or sets a value indicating whether the grid should scroll immediately when the user grabs a vertical scrollbar thumb and drags it.

    Declaration
    [Obsolete("Use HorizontalThumbTrack and VerticalThumbTrack properties instead.")]
    public bool AllowThumbTrack { get; set; }
    Property Value
    Type Description
    System.Boolean

    AlphaBlendSelectionColor

    Gets or sets the System.Drawing.Color for alpha blended cell selections.

    Declaration
    public Color AlphaBlendSelectionColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    A System.Drawing.Color for alpha blended cell selections. It is important to set the alpha value to be less than 255 when calling System.Drawing.Color.FromArgb(int).

    Remarks

    This setting has no effect if alpha blended selections have been disabled with AllowSelection.

    AlphaBlendValue

    Gets or sets an alphablend that should be used whenever a style or color setting in the grid has no alpha value specified. Ideal to change transparency for the whole grid in one place instead of changing colors for cells individually. Set to -1 if no value is specified.

    Declaration
    public int AlphaBlendValue { get; set; }
    Property Value
    Type Description
    System.Int32

    ClickedOnDisabledCellBehavior

    Gets or sets Excel-like current cell behavior. When the user clicks on a cell out of a selected range for which .Enabled has been set to false.

    Declaration
    public GridClickedOnDisabledCellBehavior ClickedOnDisabledCellBehavior { get; set; }
    Property Value
    Type Description
    GridClickedOnDisabledCellBehavior

    ControllerOptions

    Gets or sets which mouse controllers should be enabled for the grid.

    This enumeration has a System.FlagsAttribute attribute that allows a bitwise combination of its member values.

    Declaration
    public GridControllerOptions ControllerOptions { get; set; }
    Property Value
    Type Description
    GridControllerOptions
    Remarks

    When you assign this enumeration value to ControllerOptions, the grid will create or disable specified mouse controllers for the grid. Each of these mouse controllers implements the IMouseController interface and gets registered with MouseControllerDispatcher.

    DataObjectConsumerOptions

    Gets or sets which default data consumers should be enabled for the grid.

    Declaration
    public GridDataObjectConsumerOptions DataObjectConsumerOptions { get; set; }
    Property Value
    Type Description
    GridDataObjectConsumerOptions

    A GridDataObjectConsumerOptions that holds the options to be applied.

    See Also
    GridDataObjectConsumerOptions

    DefaultGridBorderStyle

    Gets or sets the GridBorderStyle value to be used as default for cell borders.

    Declaration
    public GridBorderStyle DefaultGridBorderStyle { get; set; }
    Property Value
    Type Description
    GridBorderStyle

    DisplayEmptyColumns

    Gets or sets a value indicating whether to Display Empty Columns. Used internally. This boolean property can be used only in GridControl.

    Declaration
    public bool DisplayEmptyColumns { get; set; }
    Property Value
    Type Description
    System.Boolean

    DisplayEmptyRows

    Gets or sets a value indicating whether to Display Empty Rows. Used internally. This boolean property can be used only in GridControl.

    Declaration
    public bool DisplayEmptyRows { get; set; }
    Property Value
    Type Description
    System.Boolean

    DragDropDropTargetFlags

    Gets or sets or disables various options for using the grid as an OLE drop target.

    Declaration
    public int DragDropDropTargetFlags { get; set; }
    Property Value
    Type Description
    System.Int32

    DragSelectedCellsMouseButtonsMask

    Gets or sets which mouse buttons can be used for dragging selected rows or columns.

    Declaration
    public MouseButtons DragSelectedCellsMouseButtonsMask { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.MouseButtons

    A GridSelectionFlags that specifies options to be applied.

    Remarks

    You can customize the mouse controller's behavior at run-time while the user is performing the action by subscribing to the SelectionChanging and SelectionChanged events.

    The AllowSelection property lets you further customize selection behavior.

    DrawOrder

    Gets or sets the order how cells are loaded before the grid is displayed. This is of use when using the virtual grid and it is more extensive to move from column to column than to move from row to row in your custom data source.

    Declaration
    public GridDrawOrder DrawOrder { get; set; }
    Property Value
    Type Description
    GridDrawOrder

    EnterKeyBehavior

    Gets or sets movement of current cell when pressing the Enter key.

    Declaration
    public GridDirectionType EnterKeyBehavior { get; set; }
    Property Value
    Type Description
    GridDirectionType

    ExcelLikeCurrentCell

    Gets or sets a value indicating whether Excel-like current cell behavior. When the user moves the current cell out of a selected range, the range will be cleared. If the user moves the current cell inside a selected range, the range will stay.

    Declaration
    public bool ExcelLikeCurrentCell { get; set; }
    Property Value
    Type Description
    System.Boolean

    ExcelLikeSelectionFrame

    Gets or sets a value indicating whether the active selection should be outline with a selection frame.

    Declaration
    public bool ExcelLikeSelectionFrame { get; set; }
    Property Value
    Type Description
    System.Boolean

    FloatCellsMode

    Gets or sets a GridFloatCellsMode enumeration that specifies floating cells' behavior in a GridModel.

    Declaration
    public GridFloatCellsMode FloatCellsMode { get; set; }
    Property Value
    Type Description
    GridFloatCellsMode

    GridOfficeScrollBars

    Gets or sets a value indicating whether to toggle between standard and Office2007 scrollbars.

    Declaration
    public OfficeScrollBars GridOfficeScrollBars { get; set; }
    Property Value
    Type Description
    OfficeScrollBars

    GridVisualStyles

    Gets or sets the VisualStyles (skins) like Office2010, Office2007, Office2003

    Declaration
    public GridVisualStyles GridVisualStyles { get; set; }
    Property Value
    Type Description
    GridVisualStyles
    Remarks

    Each of the components that is incorporated into the grid control is being affected with Visual Styles. Choosing one of the options will change the look and feel of the individual grid elements.

    Examples

    The VisualStyles can be set by assigning a GridVisualStyles enumeration value to the GridVisualStyles property

        this.gridControl1.GridVisualStyles = GridVisualStyles.Office2007Blue;
        Me.GridControl1.GridVisualStyles = GridVisualStyles.Office2007Blue

    GridVisualStylesDrawing

    Gets or sets the VisualStylesDrawing object.

    Declaration
    public IVisualStylesDrawing GridVisualStylesDrawing { get; set; }
    Property Value
    Type Description
    IVisualStylesDrawing

    HighlightFrozenLine

    Gets or sets a value indicating whether the frozen line should be highlighted with GridProperties.FixedLinesColor the GridBorderStyle.

    Declaration
    public bool HighlightFrozenLine { get; set; }
    Property Value
    Type Description
    System.Boolean

    HorizontalScrollTips

    Gets or sets a value indicating whether the grid should display Scroll Tips when the user grabs a horizontal scrollbar thumb and drags it.

    Declaration
    public bool HorizontalScrollTips { get; set; }
    Property Value
    Type Description
    System.Boolean

    HorizontalThumbTrack

    Gets or sets a value indicating whether the grid should scroll immediately when the user grabs a horizontal scrollbar thumb and drags it.

    Declaration
    public bool HorizontalThumbTrack { get; set; }
    Property Value
    Type Description
    System.Boolean

    ListBoxSelectionMode

    Gets or sets list box-like selection behavior for the grid when the user moves the current cell.

    Declaration
    public SelectionMode ListBoxSelectionMode { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.SelectionMode

    A System.WIndows.Forms.SelectionMode that defines the list box-like selection behavior of the grid.

    MergeCellsLayout

    Gets or sets a GridMergeCellsMode enumeration that specifies merge cells behavior in a GridModel.

    Declaration
    public GridMergeCellsLayout MergeCellsLayout { get; set; }
    Property Value
    Type Description
    GridMergeCellsLayout

    MergeCellsMode

    Gets or sets a GridMergeCellsMode enumeration that specifies merge cells behavior in a GridModel.

    Declaration
    public GridMergeCellsMode MergeCellsMode { get; set; }
    Property Value
    Type Description
    GridMergeCellsMode

    MinResizeColSize

    Gets or sets the minimum column width when the user resizes a column with the mouse.

    Declaration
    public int MinResizeColSize { get; set; }
    Property Value
    Type Description
    System.Int32

    MinResizeRowSize

    Gets or sets the minimum row height when the user resizes a row with the mouse.

    Declaration
    public int MinResizeRowSize { get; set; }
    Property Value
    Type Description
    System.Int32

    MulitExtendedArrowKeySelect

    Gets or sets a value indicating whether when you select SelectionMode.MultiExtended, this flag defines if the rows selection should be cleared and moved with the new current cell or if only the current cell should be moved without clearing selections.

    Declaration
    public bool MulitExtendedArrowKeySelect { get; set; }
    Property Value
    Type Description
    System.Boolean

    NumberedColHeaders

    Gets or sets a value indicating whether to toggle display of column ids (A, B, C, ...) in column headers.

    Declaration
    public bool NumberedColHeaders { get; set; }
    Property Value
    Type Description
    System.Boolean

    NumberedRowHeaders

    Gets or sets a value indicating whether to toggle display of row numbers in row headers.

    Declaration
    public bool NumberedRowHeaders { get; set; }
    Property Value
    Type Description
    System.Boolean

    Office2007ScrollBars

    Gets or sets a value indicating whether to toggle between standard and Office2007 scrollbars.

    Declaration
    public bool Office2007ScrollBars { get; set; }
    Property Value
    Type Description
    System.Boolean

    Office2007ScrollBarsColorScheme

    Gets or sets the style of Office2007 scroll bars.

    Declaration
    public Office2007ColorScheme Office2007ScrollBarsColorScheme { get; set; }
    Property Value
    Type Description
    Office2007ColorScheme

    Office2010ScrollBarsColorScheme

    Gets or sets the style of Office2010 scroll bars.

    Declaration
    public Office2010ColorScheme Office2010ScrollBarsColorScheme { get; set; }
    Property Value
    Type Description
    Office2010ColorScheme

    Office2016ScrollBarsColorScheme

    Gets or sets the style of Office2016 scroll bars.

    Declaration
    public ScrollBarOffice2016ColorScheme Office2016ScrollBarsColorScheme { get; set; }
    Property Value
    Type Description
    ScrollBarOffice2016ColorScheme

    RefreshCurrentCellBehavior

    Gets or sets which cells to refresh when moving the current cell. If a cell's appearance is changed if cells are moved to a new row (e.g. when GridShowButtons.ShowCurrentRow is used), you should specify RefreshRow.

    Declaration
    public GridRefreshCurrentCellBehavior RefreshCurrentCellBehavior { get; set; }
    Property Value
    Type Description
    GridRefreshCurrentCellBehavior

    ResizeColsBehavior

    Gets or sets behavior for resizing columns.

    Declaration
    public GridResizeCellsBehavior ResizeColsBehavior { get; set; }
    Property Value
    Type Description
    GridResizeCellsBehavior

    A GridResizeCellsBehavior enumeration with options.

    Remarks

    You can customize the mouse controller's behavior at run-time while the user is performing the action by subscribing to the ResizingColumns and ResizingRows events.

    ResizeRowsBehavior

    Gets or sets behavior for resizing rows.

    Declaration
    public GridResizeCellsBehavior ResizeRowsBehavior { get; set; }
    Property Value
    Type Description
    GridResizeCellsBehavior

    A GridResizeCellsBehavior enumeration with options.

    Remarks

    You can customize the mouse controller's behavior at run-time while the user is performing the action by subscribing to the ResizingColumns and ResizingRows events.

    ScrollFrozen

    Gets or sets a value indicating whether the scroll behavior when user moves current cell with arrow keys into the frozen cells area.

    Declaration
    public bool ScrollFrozen { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    True, if current cell is at the topmost nonfrozen row, scroll the view. False, move current cell into frozen cells. If current cell is at the top row, scroll the view.

    SelectCellsMouseButtonsMask

    Gets or sets which mouse buttons can be used for selecting cells.

    Declaration
    public MouseButtons SelectCellsMouseButtonsMask { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.MouseButtons

    A GridSelectionFlags that specifies options to be applied.

    Remarks

    You can customize the mouse controller's behavior at run-time while the user is performing the action by subscribing to the SelectionChanging and SelectionChanged events.

    The AllowSelection property lets you further customize selection behavior.

    SelectionBorderBrush

    Gets or sets selection border brush for 2016 Excel-like selection frame. It is applicable if SelectionFrameOption.Excel2016 is used as selection frame.

    Declaration
    public Brush SelectionBorderBrush { get; set; }
    Property Value
    Type Description
    System.Drawing.Brush
    Remarks

    This settings effects if SelectionFrameOption.Excel2016 have been enabled with SelectionFrameOption.

    SelectionBorderThickness

    Gets or sets border thickness for 2016 Excel-like selection frame. It is applicable for if SelectionFrameOption.Excel2016 is used as selection frame.

    Declaration
    public int SelectionBorderThickness { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This settings effects if SelectionFrameOption.Excel2016 have been enabled with SelectionFrameOption.

    SelectionFrameOption

    Gets or sets the behavior of the Excel-like selection frame.

    Declaration
    public SelectionFrameOption SelectionFrameOption { get; set; }
    Property Value
    Type Description
    SelectionFrameOption

    One of the SelectionFrameOption enumeration that specifies the Excel-like selection behavior. The default value is Syncfusion.Windows.Forms.Grid.SelectionFrameOption.Excel2016.

    Remarks

    This settings effects if Excel-like selection have been enabled with ExcelLikeSelectionFrame.

    ShouldSynchronizeCurrentCell

    Gets or sets a value indicating whether current cell movements should be synchronized among GridControlBase attached to the same model.

    Declaration
    public bool ShouldSynchronizeCurrentCell { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowCurrentCellBorderBehavior

    Gets or sets when to show current cell frame or border.

    Declaration
    public GridShowCurrentCellBorder ShowCurrentCellBorderBehavior { get; set; }
    Property Value
    Type Description
    GridShowCurrentCellBorder

    SmoothControlResize

    Gets or sets a value indicating whether a grid should be completely refreshed when the user resizes the window or if only newly visible rows or columns should be redrawn.

    Declaration
    public bool SmoothControlResize { get; set; }
    Property Value
    Type Description
    System.Boolean

    TransparentBackground

    Gets or sets a value indicating whether grid should erase and fill background of cells or only draw cell text.

    Declaration
    public bool TransparentBackground { get; set; }
    Property Value
    Type Description
    System.Boolean

    True if only text should be drawn; False if cell background should be erased and filled.

    UseRightToLeftCompatibleTextBox

    Gets or sets a value indicating whether the controls the kind of textbox control that is created for TextBox cells. In general the original text box behaves better than the richtext box with Hebrew and arabic languages. By default the grid uses the RichTextBox control for cell editing, but if you set UseRightToLeftCompatibleTextBox to true then the grid will do editing with original TextBox controls instead.

    Declaration
    public bool UseRightToLeftCompatibleTextBox { get; set; }
    Property Value
    Type Description
    System.Boolean

    VerticalScrollTips

    Gets or sets a value indicating whether the grid should display Scroll Tips when the user grabs a vertical scrollbar thumb and drags it.

    Declaration
    public bool VerticalScrollTips { get; set; }
    Property Value
    Type Description
    System.Boolean

    VerticalThumbTrack

    Gets or sets a value indicating whether the grid should scroll immediately when the user grabs a vertical scrollbar thumb and drags it.

    Declaration
    public bool VerticalThumbTrack { get; set; }
    Property Value
    Type Description
    System.Boolean

    WrapCell

    Gets or sets a value indicating whether to go to first column in next row or last column in previous row when at end or beginning of a row and moving left or right. For more options, use WrapCellBehavior instead.

    Declaration
    public bool WrapCell { get; set; }
    Property Value
    Type Description
    System.Boolean

    WrapCellBehavior

    Gets or sets go to first column in next row or last column in previous row when at end or beginning of a row and moving left or right.

    Declaration
    public GridWrapCellBehavior WrapCellBehavior { get; set; }
    Property Value
    Type Description
    GridWrapCellBehavior

    Methods

    Dispose()

    Disposes the object.

    Declaration
    public void Dispose()

    GetControllerOption(GridControllerOptions)

    Returns the enabled state of a specific controller.

    Declaration
    public bool GetControllerOption(GridControllerOptions coption)
    Parameters
    Type Name Description
    GridControllerOptions coption

    A GridControllerOptions that identifies the controller.

    Returns
    Type Description
    System.Boolean

    A System.Boolean that indicates if the controller is enabled.

    GetDataObjectConsumerOption(GridDataObjectConsumerOptions)

    Returns the enabled state for specific data consumers.

    Declaration
    public bool GetDataObjectConsumerOption(GridDataObjectConsumerOptions doption)
    Parameters
    Type Name Description
    GridDataObjectConsumerOptions doption

    A GridDataObjectConsumerOptions that identifies the data object consumer.

    Returns
    Type Description
    System.Boolean

    A System.Boolean that indicates if the controller is enabled.

    OnControllerOptionsChanged(EventArgs)

    Raises the ControllerOptionsChanged event.

    Declaration
    protected virtual void OnControllerOptionsChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    A System.EventArgs that contains the event data.

    OnDataObjectConsumerOptionsChanged(EventArgs)

    Raises the DataObjectConsumerOptionsChanged event.

    Declaration
    protected virtual void OnDataObjectConsumerOptionsChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    A System.EventArgs that contains the event data.

    OnFloatCellsModeChanged(EventArgs)

    Raises the FloatCellsModeChanged event.

    Declaration
    protected virtual void OnFloatCellsModeChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    A System.EventArgs that contains the event data.

    OnMergeCellsModeChanged(EventArgs)

    Raises the MergeCellsModeChanged event.

    Declaration
    protected virtual void OnMergeCellsModeChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    A System.EventArgs that contains the event data.

    OnOptionsChanged(EventArgs)

    Raises the OptionsChanged event.

    Declaration
    protected virtual void OnOptionsChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    A System.EventArgs that contains the event data.

    SetControllerOption(GridControllerOptions, Boolean)

    Toggles the enabled state of a specific controller.

    Declaration
    public void SetControllerOption(GridControllerOptions coption, bool value)
    Parameters
    Type Name Description
    GridControllerOptions coption

    A GridControllerOptions that identifies the controller.

    System.Boolean value

    The new enabled state.

    SetDataObjectConsumerOption(GridDataObjectConsumerOptions, Boolean)

    Toggles the enabled state for specific data consumers.

    Declaration
    public void SetDataObjectConsumerOption(GridDataObjectConsumerOptions coption, bool value)
    Parameters
    Type Name Description
    GridDataObjectConsumerOptions coption

    A GridDataObjectConsumerOptions that identifies the dataobject consumer.

    System.Boolean value

    A System.Boolean that indicates if the controller is enabled.

    SetMetroStyles(GridMetroColors)

    set the metro color for Grid

    Declaration
    public void SetMetroStyles(GridMetroColors metroColors)
    Parameters
    Type Name Description
    GridMetroColors metroColors

    Collection of metro color

    SetMetroStyles(Object, Object, Object)

    Sets the custom Metro colors to the Grid.

    Declaration
    public void SetMetroStyles(object metroColor, object metroHoverColor, object metroColorPressed)
    Parameters
    Type Name Description
    System.Object metroColor

    Custom Metro Color.

    System.Object metroHoverColor

    Custom MouseHover color.

    System.Object metroColorPressed

    Custom PushButtonPress color.

    SetMetroStyles(Object, Object, Object, Object)

    Sets the custom metro colors to the Grid.

    Declaration
    public void SetMetroStyles(object metroColor, object metroHoverColor, object metroColorPressed, object metroGroupBarColor)
    Parameters
    Type Name Description
    System.Object metroColor

    custom Metro Color.

    System.Object metroHoverColor

    custom MouseHover color.

    System.Object metroColorPressed

    custom MouseClick color.

    System.Object metroGroupBarColor

    custom GroupBar color.

    SetOffice2016ThemeStyle(GridVisualStyles, GridOffice2016ThemeColors)

    Sets the customized the Office 2016 theme colors. Use the Office2016ColorfulThemeColors, Office2016DarkGrayThemeColors, Office2016BlackThemeColors, Office2016WhiteThemeColors classes to customize the colors.

    Declaration
    public void SetOffice2016ThemeStyle(GridVisualStyles visualStyle, GridOffice2016ThemeColors office2016Colors)
    Parameters
    Type Name Description
    GridVisualStyles visualStyle
    GridOffice2016ThemeColors office2016Colors

    The custom colors for Office 2016 theme.

    Remarks

    The Office 2016 rendering styles are derived from the Metro color styles rendering.

    Events

    ControllerOptionsChanged

    Occurs when ControllerOptions have changed.

    Declaration
    public event EventHandler ControllerOptionsChanged
    Event Type
    Type Description
    System.EventHandler

    DataObjectConsumerOptionsChanged

    Occurs when DataObjectConsumerOptions have changed.

    Declaration
    public event EventHandler DataObjectConsumerOptionsChanged
    Event Type
    Type Description
    System.EventHandler

    FloatCellsModeChanged

    Occurs when the FloatCellsMode is changed.

    Declaration
    public event EventHandler FloatCellsModeChanged
    Event Type
    Type Description
    System.EventHandler

    MergeCellsModeChanged

    Occurs when the MergeCellsMode is changed.

    Declaration
    public event EventHandler MergeCellsModeChanged
    Event Type
    Type Description
    System.EventHandler

    OptionsChanged

    Occurs when settings in GridModelOptions have changed.

    Declaration
    public event EventHandler OptionsChanged
    Event Type
    Type Description
    System.EventHandler

    Explicit Interface Implementations

    IDeserializationCallback.OnDeserialization(Object)

    Runs when the entire object graph has been de-serialized.

    Declaration
    void IDeserializationCallback.OnDeserialization(object sender)
    Parameters
    Type Name Description
    System.Object sender

    ISerializable.GetObjectData(SerializationInfo, StreamingContext)

    Implements the ISerializable interface and returns the data needed to serialize the GridModelOptions.

    Declaration
    void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    A SerializationInfo object containing the information required to serialize the object.

    System.Runtime.Serialization.StreamingContext context

    A StreamingContext object containing the source and destination of the serialized stream.

    Implements

    System.IDisposable
    System.Runtime.Serialization.ISerializable
    System.Runtime.Serialization.IDeserializationCallback
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved