Share via


EditingContext Class

The EditingContext class contains contextual state about a designer. This includes permanent state such as list of services running in the designer. It also includes transient state consisting of context items. Examples of transient context item state include the set of currently selected objects as well as the editing tool being used to manipulate objects on the design surface. The editing context is designed to be a concrete class for ease of use. It does have a protected API that can be used to replace its implementation.

Inheritance Hierarchy

System..::..Object
  Microsoft.Data.Tools.Design.Core.Context..::..EditingContext

Namespace:  Microsoft.Data.Tools.Design.Core.Context
Assembly:  Microsoft.Data.Tools.Design.Core (in Microsoft.Data.Tools.Design.Core.dll)

Syntax

'Declaration
Public Class EditingContext _
    Implements IDisposable
'Usage
Dim instance As EditingContext
public class EditingContext : IDisposable
public ref class EditingContext : IDisposable
type EditingContext =  
    class
        interface IDisposable
    end
public class EditingContext implements IDisposable

The EditingContext type exposes the following members.

Constructors

  Name Description
Public method EditingContext Creates a new editing context.

Top

Properties

  Name Description
Public property Items Returns the local collection of context items offered by this editing context.
Public property Services Returns the service collection for this editing context.

Top

Methods

  Name Description
Protected method CreateContextItemCollection Creates an instance of the context item collection to be returned from the ContextItems property. The default implementation creates a ContextItemCollection that supports delayed activation of design editor collections through the declaration of a SubscribeContext attribute on the design editor manager.
Protected method CreateServiceCollection Creates an instance of the service collection to be returned from the Services property. The default implementation creates a ServiceCollection that supports delayed activation of design editor managers through the declaration of a SubscribeService attribute on the design editor manager.
Public method Dispose() () () () Disposes this editing context.
Protected method Dispose(Boolean) Disposes this editing context. <param name="disposing">True if this object is being disposed, or false if it is finalizing.</param>
Public method Equals (Inherited from Object.)
Protected method Finalize Finalizer that implements the IDisposable pattern. (Overrides Object..::..Finalize() () () ().)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event Disposing The Disposing event gets fired just before the context gets disposed.

Top

Thread Safety

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

See Also

Reference

Microsoft.Data.Tools.Design.Core.Context Namespace