Share via

EventFieldCollection.Add Method (EventField, String)

  • Article

Adds an EventField before the specified EventFieldCollection.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Sub Add ( _
    eventField As EventField, _
    insertAtColumnName As String _
)

public void Add (
    EventField eventField,
    string insertAtColumnName
)

public:
void Add (
    EventField^ eventField, 
    String^ insertAtColumnName
)

public void Add (
    EventField eventField, 
    String insertAtColumnName
)

public function Add (
    eventField : EventField, 
    insertAtColumnName : String
)

Parameters

  • eventField
    The EventField to add to the collection.
  • insertAtColumnName
    A String that specifies name of the event field column before which to insert the EventField.

Remarks

Each EventField must have a unique name.

You add each EventField before a named field in the collection. The event field at the specified column, and all subsequent event fields, are moved down the list of event fields.

The order of the fields is maintained.

If you add event fields to an application after deploying the application, you must Update the instance to apply the changes.

Example

The following examples show how to define an event field and then add it to an event class before a specific event field:

// Define a destination field and add it before the Price field
EventField eventDestination = 
    new EventField(flightEvents, "GoingTo");
eventDestination.Type = "nvarchar(6)";
flightEvents.EventFields.Add(eventDestination, "Price");

' Define a destination field and add it before the Price field.
Dim eventDestination As EventField = _
    New EventField(flightEvents, "GoingTo")
eventDestination.Type = "nvarchar(6)"
flightEvents.EventFields.Add(eventDestination, "Price")

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

EventFieldCollection Class
EventFieldCollection Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Defining Core Event Class Properties
Field Element for EventClass/Schema (ADF)