Share via


ModelItem.BeginEdit Method (String)

When overridden in a derived class, this method is called when performing multiple operations on an object or group of objects.

Namespace:  Microsoft.Windows.Design.Model
Assembly:  Microsoft.Windows.Design.Interaction (in Microsoft.Windows.Design.Interaction.dll)

Syntax

'Declaration
Public MustOverride Function BeginEdit ( _
    description As String _
) As ModelEditingScope
public abstract ModelEditingScope BeginEdit(
    string description
)
public:
virtual ModelEditingScope^ BeginEdit(
    String^ description
) abstract
abstract BeginEdit : 
        description:string -> ModelEditingScope 
public abstract function BeginEdit(
    description : String
) : ModelEditingScope

Parameters

  • description
    Type: System.String
    An optional description that describes the change. This string is set into the editing scope’s Description property.

Return Value

Type: Microsoft.Windows.Design.Model.ModelEditingScope
An ModelEditingScope that must be either completed or reverted.

Remarks

Once an editing scope is open, all changes across all objects are saved into the scope.

Editing scopes are global to the designer. An editing scope may be created for any item in the designer. You do not have to create an editing scope for the specific item you are changing.

Editing scopes can be nested, but must be committed in order.

.NET Framework Security

See Also

Reference

ModelItem Class

BeginEdit Overload

Microsoft.Windows.Design.Model Namespace

Other Resources

WPF Designer Extensibility Architecture

Editing Model Architecture