SftBox/OCX 5.0 - Combo Box Control

DataObject.SetData Method

Adds a supported format and possibly its data to a DataObject object.

Syntax

object

A DataObject object.

Data

The data to be passed to the DataObject object. The Data argument is optional.

Format

The data format (see SftOLEClipboardConstants). The Format argument is optional.

Comments

The SetData method adds a supported format and possibly its data to a DataObject object.

The Data argument is optional. This allows you to set several different formats that the source component can support without having to load the data separately for each format. Multiple formats are set by calling SetData several times, each time using a different format. If you wish to start fresh, use the DataObject.Clear method to clear all data and format information from the DataObject.

The Format argument is also optional, but either the Data or Format argument must be specified. If Data is specified, but not Format, the format of the data is determined automatically. If this is unsuccessful, then an error is generated. When the target requests the data and a format was specified, but no data was provided, the source's OLESetData event occurs, and the source can then provide the requested data type.

It is possible for the DataObject.GetData method and SetData method to use data formats other than those listed as valid Format argument, including user-defined formats registered with Windows via the RegisterClipboardFormat() API function. The SetData method requires the data to be in the form of a byte array when it does not recognize the data format specified. The DataObject.GetData method always returns data in a byte array when it is in a format that it doesn't recognize, although this may be transparently converted into other data types, such as strings. The byte array returned by DataObject.GetData will be larger than the actual data when running on some operating systems, with arbitrary bytes at the end of the array. This allocation of memory is often larger than is actually required for the data. Therefore, there may be extraneous bytes near the end of the allocated memory segment.

Examples

VB.NET

Private Sub comboSource_DragStarting(ByVal sender As Object, ByVal e As AxSftBoxLib50._ISftBoxEvents_DragStartingEvent) Handles comboSource.DragStarting
    comboSource.OLEDrag()
End Sub

Private Sub comboSource_OLEStartDrag(ByVal sender As Object, ByVal e As AxSftBoxLib50._ISftBoxEvents_OLEStartDragEvent) Handles comboSource.OLEStartDrag
    e.allowedEffects = vbDropEffectCopy Or vbDropEffectMove
    Dim textData As String = comboSource.get_Cell(comboSource.Items.Selection, 0).Text
    e.data.SetData(textData, SftOLEClipboardConstants.sftCFText)
End Sub

Private Sub comboTarget_OLEDragOver(ByVal sender As Object, ByVal e As AxSftBoxLib50._ISftBoxEvents_OLEDragOverEvent) Handles comboTarget.OLEDragOver
    If e.state = SftBoxOLEDragOverConstants.enterSftBox Then
        ' Show the drop down portion
        comboTarget.DropDown.Dropped = True
    ElseIf e.state = SftBoxOLEDragOverConstants.leaveSftBox Then
        ' Hide the drop down portion with a delay, in case the

View Entire Sample Code

VB6

End Sub

Private Sub ComboSource_DragStarting(ByVal Part As SftBoxLib50.SftBoxPortionConstants, ByVal Button As Integer, ByVal Shift As Integer, ByVal xPos As Single, ByVal yPos As Single)
    ComboSource.OLEDrag
End Sub

Private Sub ComboSource_OLEStartDrag(Data As SftBoxLib50.DataObject, AllowedEffects As Long)
    AllowedEffects = vbDropEffectCopy Or vbDropEffectMove
    Data.SetData ComboSource.Cell(ComboSource.Items.Selection, 0).Text, sftCFText
End Sub

Private Sub Command1_Click()
    Unload Form1
End Sub

Private Sub Form_Load()

View Entire Sample Code

C#

{
    comboSource.OLEDrag();
}

private void comboSource_OLEStartDrag(object sender, AxSftBoxLib50._ISftBoxEvents_OLEStartDragEvent e)
{
    e.allowedEffects = vbDropEffectCopy | vbDropEffectMove;
    string textData = comboSource.get_Cell(comboSource.Items.Selection, 0).Text;
    e.data.SetData(textData, SftOLEClipboardConstants.sftCFText);
}

private void comboTarget_OLEDragOver(object sender, AxSftBoxLib50._ISftBoxEvents_OLEDragOverEvent e)
{
    if (e.state == SftBoxOLEDragOverConstants.enterSftBox) {
        // Show the drop down portion
        comboTarget.DropDown.Dropped = true;

View Entire Sample Code

See Also DataObject Object | Object Hierarchy