• Article

ActionContext Class

Provides the context for an action while executing.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Data.PropertyDictionary
    Microsoft.SqlServer.Management.ActionContext

Namespace:  Microsoft.SqlServer.Management
Assembly:  Microsoft.SqlServer.Management.SDK.SqlStudio (in Microsoft.SqlServer.Management.SDK.SqlStudio.dll)

Syntax

'Declaration
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
<ComVisibleAttribute(True)> _
Public Class ActionContext _
    Inherits PropertyDictionary _
    Implements IContext, IPropertyDictionary, ISfcPropertySet, IDictionary(Of String, Object),  _
    ICollection(Of KeyValuePair(Of String, Object)), IEnumerable(Of KeyValuePair(Of String, Object)),  _
    IEnumerable, IEquatable(Of IContext), IServiceContainer, IServiceProvider
'Usage
Dim instance As ActionContext

[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[ComVisibleAttribute(true)]
public class ActionContext : PropertyDictionary, 
    IContext, IPropertyDictionary, ISfcPropertySet, IDictionary<string, Object>, 
    ICollection<KeyValuePair<string, Object>>, IEnumerable<KeyValuePair<string, Object>>, 
    IEnumerable, IEquatable<IContext>, IServiceContainer, IServiceProvider

[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[ComVisibleAttribute(true)]
public ref class ActionContext : public PropertyDictionary, 
    IContext, IPropertyDictionary, ISfcPropertySet, IDictionary<String^, Object^>, 
    ICollection<KeyValuePair<String^, Object^>>, IEnumerable<KeyValuePair<String^, Object^>>, 
    IEnumerable, IEquatable<IContext^>, IServiceContainer, IServiceProvider

[<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>]
[<ComVisibleAttribute(true)>]
type ActionContext =  
    class
        inherit PropertyDictionary
        interface IContext
        interface IPropertyDictionary
        interface ISfcPropertySet
        interface IDictionary<string, Object>
        interface ICollection<KeyValuePair<string, Object>>
        interface IEnumerable<KeyValuePair<string, Object>>
        interface IEnumerable
        interface IEquatable<IContext>
        interface IServiceContainer
        interface IServiceProvider
    end

public class ActionContext extends PropertyDictionary implements IContext, IPropertyDictionary, ISfcPropertySet, IDictionary<String, Object>, ICollection<KeyValuePair<String, Object>>, IEnumerable<KeyValuePair<String, Object>>, IEnumerable, IEquatable<IContext>, IServiceContainer, IServiceProvider

The ActionContext type exposes the following members.

Constructors

  Name Description
Public method ActionContext() Initializes a new instance of the ActionContext class with the default property values.
Public method ActionContext(IServiceProvider) Initializes a new instance of the ActionContext class with the specified service provider parameter.
Public method ActionContext(IContext) Initializes a new instance of the ActionContext class with the specified context parameter.
Public method ActionContext(IServiceProvider, IEnumerable<KeyValuePair<String, Object>>) Initializes a new instance of the ActionContext class with the specified service provider and properties parameters.

Top

Properties

  Name Description
Public property Count Gets the count of items in the property dictionary. (Inherited from PropertyDictionary.)
Public property IsReadOnly Gets a value indicating whether the property can be modified. (Inherited from PropertyDictionary.)
Public property Item Gets or sets the item at the specified key. (Inherited from PropertyDictionary.)
Public property Keys Gets the keys of the property. (Inherited from PropertyDictionary.)
Public property Values Gets the ICollection object that contains the values in the dictionary. (Inherited from PropertyDictionary.)

Top

Methods

  Name Description
Public method Add(KeyValuePair<String, Object>) Indicates a specified string value to be added in the dictionary. (Inherited from PropertyDictionary.)
Public method Add(ISfcProperty) Indicates a property to be added in the dictionary. (Inherited from PropertyDictionary.)
Public method Add(IEnumerable<KeyValuePair<String, Object>>, PropertyCollisionResolution) Specifies the string inputs to be added to the dictionary. (Inherited from PropertyDictionary.)
Public method Add(KeyValuePair<String, Object>, PropertyCollisionResolution) Indicates the added value in the dictionary. (Inherited from PropertyDictionary.)
Public method Add(String, Object) Adds the specified key and value to the dictionary. (Inherited from PropertyDictionary.)
Public method Add(String, Type) Indicates the property value to be added with the name and type specified. (Inherited from PropertyDictionary.)
Public method Add(ISfcProperty, PropertyCollisionResolution) Specifies the string value to be added to the dictionary. (Inherited from PropertyDictionary.)
Public method Add(String, Object, PropertyCollisionResolution) Indicates the property value to be added with the key, value, and event specified. (Inherited from PropertyDictionary.)
Public method Add(String, Type, PropertyCollisionResolution) Indicates the property value to be added using PropertyCollisionResolution. (Inherited from PropertyDictionary.)
Public method AddService(Type, ServiceCreatorCallback) Adds the specified service to the service container. This class cannot be inherited.
Public method AddService(Type, Object) Adds the specified service to the service container. This class cannot be inherited.
Public method AddService(Type, ServiceCreatorCallback, Boolean) Adds the specified service to the service container, and optionally promotes the service to parent service containers. This class cannot be inherited.
Public method AddService(Type, Object, Boolean) Adds the specified service to the service container, and optionally promotes the service to any parent service containers. This class cannot be inherited.
Public method Clear Clears the content of the property. This class cannot be inherited. (Inherited from PropertyDictionary.)
Public method Contains(KeyValuePair<String, Object>) Provides the object for the PropertyDictionary. (Inherited from PropertyDictionary.)
Public method Contains(ISfcProperty) Determines a value that indicates a specified object to be contained. (Inherited from PropertyDictionary.)
Public method Contains<T>(String) Determines if the dictionary contains a specific name. (Inherited from PropertyDictionary.)
Public method ContainsKey Determines whether the dictionary contains the specified key. (Inherited from PropertyDictionary.)
Public method CopyTo Copies the dictionary entries to a one-dimensional Array instance at the specified index. (Inherited from PropertyDictionary.)
Public method EnumProperties Indicates the enumerable properties for the PropertyDictionary. (Inherited from PropertyDictionary.)
Public method Equals(Object) (Inherited from Object.)
Public method Equals(IContext) Determines whether the specified object is equal to the current object with specified context.
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator Retrieves an enumerator that iterates through the dictionary. (Inherited from PropertyDictionary.)
Public method GetHashCode (Inherited from Object.)
Public method GetPropertySet Indicates a specific property in the PropertyDictionary. (Inherited from PropertyDictionary.)
Public method GetService Gets the service object of the specified type.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnPropertyChanged Indicates a specified value of a property that is changed. (Inherited from PropertyDictionary.)
Protected method OnPropertyMetadataChanged Indicates a value when a property in the metadata is changed. (Inherited from PropertyDictionary.)
Public method Remove(KeyValuePair<String, Object>) Returns a value that indicates the object to be removed. (Inherited from PropertyDictionary.)
Public method Remove(String) Removes the element with the specified key from the collection. (Inherited from PropertyDictionary.)
Public method RemoveService(Type) Removes the specified service type from the service container. This class cannot be inherited.
Public method RemoveService(Type, Boolean) Removes the specified service type from the service container, and optionally promotes the service to parent service containers. This class cannot be inherited.
Public method ToString (Inherited from Object.)
Public method TryGetProperty Retrieves the property associated with the specified key. This class cannot be inherited. (Inherited from PropertyDictionary.)
Public method TryGetPropertyValue(String, Object%) Retrieves a value that indicates a property to get. (Inherited from PropertyDictionary.)
Public method TryGetPropertyValue<T>(String, T%) Retrieves a value that indicates a property to get using a list of items. (Inherited from PropertyDictionary.)
Public method TryGetValue Retrieves the value associated with the specified key. (Inherited from PropertyDictionary.)

Top

Events

  Name Description
Public event PropertyChanged Occurs after the value of the application settings property is changed. (Inherited from PropertyDictionary.)
Public event PropertyMetadataChanged Occurs after the value of metadata property is changed. (Inherited from PropertyDictionary.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Returns an enumerator that iterates through the current Collection object. (Inherited from PropertyDictionary.)

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.