menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridDataBoundGridTextDataObjectConsumer - API Reference

    Show / Hide Table of Contents

    Class GridDataBoundGridTextDataObjectConsumer

    Implements a DataObject consumer for text data. Will handle data provided in DataFormats.Text and DataFormats.UnicodeText format.

    Inheritance
    System.Object
    NonFinalizeDisposable
    GridSubComponent
    GridDataBoundGridTextDataObjectConsumer
    Implements
    System.IDisposable
    IGridDataObjectConsumer
    Inherited Members
    GridSubComponent.Grid
    NonFinalizeDisposable.Dispose()
    NonFinalizeDisposable.Dispose(Boolean)
    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 GridDataBoundGridTextDataObjectConsumer : GridSubComponent, IDisposable, IGridDataObjectConsumer

    Constructors

    GridDataBoundGridTextDataObjectConsumer(GridControlBase)

    Initializes a new GridDataBoundGridTextDataObjectConsumer object and associates it with a GridControlBase.

    Declaration
    public GridDataBoundGridTextDataObjectConsumer(GridControlBase grid)
    Parameters
    Type Name Description
    GridControlBase grid

    The GridControlBase this object should be associated with.

    Properties

    Name

    Gets the name of the DataObject consumer.

    Declaration
    public string Name { get; }
    Property Value
    Type Description
    System.String

    Methods

    DetermineRowColCount(IDataObject)

    Queries the dimension in rows and columns of the data object.

    Declaration
    public Size DetermineRowColCount(IDataObject dataObject)
    Parameters
    Type Name Description
    System.Windows.Forms.IDataObject dataObject

    The data object.

    Returns
    Type Description
    System.Drawing.Size

    returns Dimension.

    DropAtRowCol(IDataObject, Int32, Int32)

    Paste the contents of the data object at the specified cell coordinates.

    Declaration
    public bool DropAtRowCol(IDataObject dataObject, int rowIndex, int colIndex)
    Parameters
    Type Name Description
    System.Windows.Forms.IDataObject dataObject

    Provides data to be consumed.

    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    Returns
    Type Description
    System.Boolean

    True if successful; False otherwise.

    QueryAcceptData(IDataObject, IGridDataObjectConsumer, GridQueryAcceptDataOptions)

    Queries the DataObject consumer if it knows how to handle the IDataObject.

    Declaration
    public bool QueryAcceptData(IDataObject dataObject, IGridDataObjectConsumer consumer, GridQueryAcceptDataOptions options)
    Parameters
    Type Name Description
    System.Windows.Forms.IDataObject dataObject

    Provides data to be consumed.

    IGridDataObjectConsumer consumer

    Another consumer that is capable of reading the data. Might be NULL.

    GridQueryAcceptDataOptions options

    Reserved for future use.

    Returns
    Type Description
    System.Boolean

    True if this consumer is able to read the data from dataObject.

    Implements

    System.IDisposable
    IGridDataObjectConsumer
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved