Class DelimiterClipboardProvider

DelimiterClipboardProvider - derived from the ClipboardProvider. Facilitates reading from and writing to the clipboard in unicode text format when there is a specified string delimiter between worksheet columns and another delimiter between rows.

Inheritance
System.Object
ClipboardProvider
DelimiterClipboardProvider
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.XlsIO.Implementation.Clipboard
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class DelimiterClipboardProvider : ClipboardProvider

Constructors

DelimiterClipboardProvider()

Default constructor - just for getting the workbook from the clipboard. If data needs to be copied from the clipboard, then the Initialize method or set Workbook or Worksheet properties should be called.

Declaration
public DelimiterClipboardProvider()

DelimiterClipboardProvider(IWorksheet)

Creates provider for the specified worksheet.

Declaration
public DelimiterClipboardProvider(IWorksheet sheet)
Parameters
Type Name Description
IWorksheet sheet

Worksheet that should be copied to the clipboard.

DelimiterClipboardProvider(IWorksheet, ClipboardProvider)

Creates provider for the specified worksheet and sets the next clipboard provider.

Declaration
public DelimiterClipboardProvider(IWorksheet sheet, ClipboardProvider next)
Parameters
Type Name Description
IWorksheet sheet

Worksheet that should be copied to the clipboard.
ClipboardProvider next

Next clipboard provider in the list.

Fields

DEF_DEFAULT_COLUMN_DELIMITER

Default delimiter between worksheet columns.

Declaration
public const string DEF_DEFAULT_COLUMN_DELIMITER = "\t"
Field Value
Type
System.String

DEF_DEFAULT_FORMAT_NAME

Default format name.

Declaration
public const string DEF_DEFAULT_FORMAT_NAME = "UnicodeText"
Field Value
Type
System.String

DEF_DEFAULT_ROW_DELIMITER

Default delimiter between worksheet rows.

Declaration
public const string DEF_DEFAULT_ROW_DELIMITER = "\r\n"
Field Value
Type
System.String

Properties

ColumnDelimiter

Delimiter between worksheet columns.

Declaration
public string ColumnDelimiter { get; set; }
Property Value
Type
System.String

RowDelimiter

Delimiter between worksheet rows.

Declaration
public string RowDelimiter { get; set; }
Property Value
Type
System.String

Methods

ExtractWorkbook(IDataObject, IWorkbooks)

Extracts workbook from the data object.

Declaration
protected override IWorkbook ExtractWorkbook(IDataObject dataObject, IWorkbooks workbooks)
Parameters
Type Name Description
System.Windows.Forms.IDataObject dataObject

Data object that contains workbook data.
IWorkbooks workbooks

Workbooks collection to add workbook to.
Returns
Type Description
IWorkbook

Extracted workbook.
Overrides

FillData()

Fills internal string that will be copied to the clipboard.

Declaration
protected virtual void FillData()

FillData(IRange)

Fills internal string that will be copied to the clipboard.

Declaration
protected virtual void FillData(IRange range)
Parameters
Type Name Description
IRange range

Range to copy to the clipboard.

FillDataObject(IDataObject)

Fills the dataobject.

Declaration
protected override void FillDataObject(IDataObject dataObject)
Parameters
Type Name Description
System.Windows.Forms.IDataObject dataObject

Dataobject to extract.
Overrides

FillDataObject(IDataObject, IRange)

Extracts the workbook.

Declaration
protected override void FillDataObject(IDataObject dataObject, IRange range)
Parameters
Type Name Description
System.Windows.Forms.IDataObject dataObject

Data object to extract.
IRange range

Range to copy into data object.
Overrides

GetForClipboard()

Returns IDataObject (for copying to the clipboard) that contains data from workbook or worksheet.

Declaration
public override IDataObject GetForClipboard()
Returns
Type Description
System.Windows.Forms.IDataObject

IDataObject for copying to the clipboard.
Overrides

GetForClipboard(IRange)

Returns IDataObject (for copying to the clipboard) that contains data from workbook or worksheet.

Declaration
public override IDataObject GetForClipboard(IRange range)
Parameters
Type Name Description
IRange range

Range to copy.
Returns
Type Description
System.Windows.Forms.IDataObject

IDataObject for copying to the clipboard.
Overrides