SmartPasteBehavior.Properties Property

Gets SmartPaste behavior settings.

Namespace: DevExpress.AIIntegration.WinForms

Assembly: DevExpress.AIIntegration.WinForms.v24.2.dll

Declaration

C#

public SmartPasteBehaviorProperties Properties { get; }

VB.NET

Public ReadOnly Property Properties As SmartPasteBehaviorProperties

Property Value

Type	Description
SmartPasteBehaviorProperties	SmartPaste behavior settings.

Remarks

Once you attached the SmartPasteBehavior to a control, you should describe items so that SmartPaste can assign right values to appropriate items. In the context of SmartPaste, an item refers to a LayoutControlItem when working with a LayoutControl, or a GridColumn when working with a GridControl.

Item Descriptions

Note

Item descriptions are optional if an item’s text or caption is specified (for example, a grid column’s Caption property or layout item’s Text property is set to a non-empty string). Although SmartPaste attempts to determine the right value for an item based on the item’s text/caption, we recommend that you also describe items for improved accuracy.

Use the SmartPasteBehavior.Properties.ItemDescriptions collection property to add descriptions (AIItemDescription) for certain items. Each AIItemDescription object in the collection has two properties:

1. AIItemDescription.Item: A component that will receive the pasted data (GridColumn or LayoutControlItem).
2. AIItemDescription.Description: A string that describes the expected content and/or data format for the item.

Excluded Items

If you want to exclude a specific item from SmartPaste, you can add this item to the ExcludedItems collection. This allows you to exclude grid columns or data fields from being affected by SmartPaste, ensuring that they remain unchanged.

Example

C#

public Form1() {
    InitializeComponent();
    behaviorManager1.Attach<SmartPasteBehavior>(gridView1, behavior => {
        behavior.Properties.ItemDescriptions.AddRange(new List<AIItemDescription>() {
                new AIItemDescription(gridView1.Columns["ProductName"], "The official name or title of the product."),
                new AIItemDescription(gridView1.Columns["Seller"], "The name of the individual or company selling the product."),
                new AIItemDescription(gridView1.Columns["Price"], "The cost of the product, including any applicable taxes."),
                new AIItemDescription(gridView1.Columns["ShippingWeight"], "The weight of the product when packaged for shipping (in lbs or kg)."),
                new AIItemDescription(gridView1.Columns["ProductCode"], "The unique identifier or SKU assigned to the product."),
                new AIItemDescription(gridView1.Columns["Dimensions"], "The physical size of the product, typically in length, width, and height."),
            }
        );
        behavior.Properties.ExcludedItems.Add(gridView1.Columns["Rating"]);
    });
}

VB.NET

Public Sub New()
    InitializeComponent()
    behaviorManager1.Attach(Of SmartPasteBehavior)(gridView1, Sub(behavior)
        behavior.Properties.ItemDescriptions.AddRange(New List(Of AIItemDescription)() From {
            New AIItemDescription(gridView1.Columns("ProductName"), "The official name or title of the product."),
            New AIItemDescription(gridView1.Columns("Seller"), "The name of the individual or company selling the product."),
            New AIItemDescription(gridView1.Columns("Price"), "The cost of the product, including any applicable taxes."),
            New AIItemDescription(gridView1.Columns("ShippingWeight"), "The weight of the product when packaged for shipping (in lbs or kg)."),
            New AIItemDescription(gridView1.Columns("ProductCode"), "The unique identifier or SKU assigned to the product."),
            New AIItemDescription(gridView1.Columns("Dimensions"), "The physical size of the product, typically in length, width, and height.")
        })
        behavior.Properties.ExcludedItems.Add(gridView1.Columns("Rating"))
    End Sub)
End Sub

Tip

Read the following help topic for additional information: Smart Paste AI-powered Extension.