Share via

  • Article

PropertyDictionary Class

Gets the list of elements contained in the PropertyDictionary.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public Class PropertyDictionary _
    Implements IPropertyDictionary, ISfcPropertySet, IDictionary(Of String, Object),  _
    ICollection(Of KeyValuePair(Of String, Object)), IEnumerable(Of KeyValuePair(Of String, Object)),  _
    IEnumerable, ISfcPropertyProvider, ISfcNotifyPropertyMetadataChanged, INotifyPropertyChanged
'Usage
Dim instance As PropertyDictionary

[SerializableAttribute]
[ComVisibleAttribute(true)]
public class PropertyDictionary : IPropertyDictionary, 
    ISfcPropertySet, IDictionary<string, Object>, ICollection<KeyValuePair<string, Object>>, 
    IEnumerable<KeyValuePair<string, Object>>, IEnumerable, ISfcPropertyProvider, 
    ISfcNotifyPropertyMetadataChanged, INotifyPropertyChanged

[SerializableAttribute]
[ComVisibleAttribute(true)]
public ref class PropertyDictionary : IPropertyDictionary, 
    ISfcPropertySet, IDictionary<String^, Object^>, ICollection<KeyValuePair<String^, Object^>>, 
    IEnumerable<KeyValuePair<String^, Object^>>, IEnumerable, 
    ISfcPropertyProvider, ISfcNotifyPropertyMetadataChanged, INotifyPropertyChanged

[<SerializableAttribute>]
[<ComVisibleAttribute(true)>]
type PropertyDictionary =  
    class
        interface IPropertyDictionary
        interface ISfcPropertySet
        interface IDictionary<string, Object>
        interface ICollection<KeyValuePair<string, Object>>
        interface IEnumerable<KeyValuePair<string, Object>>
        interface IEnumerable
        interface ISfcPropertyProvider
        interface ISfcNotifyPropertyMetadataChanged
        interface INotifyPropertyChanged
    end

public class PropertyDictionary implements IPropertyDictionary, ISfcPropertySet, IDictionary<String, Object>, ICollection<KeyValuePair<String, Object>>, IEnumerable<KeyValuePair<String, Object>>, IEnumerable, ISfcPropertyProvider, ISfcNotifyPropertyMetadataChanged, INotifyPropertyChanged

The PropertyDictionary type exposes the following members.

Constructors

  Name Description
Public method PropertyDictionary() Initializes a new instance of the PropertyDictionary class with the default property values.
Public method PropertyDictionary(IEnumerable<KeyValuePair<String, Object>>) Initializes a new instance of the PropertyDictionary class with the specified properties.
Public method PropertyDictionary(ISfcPropertyProvider) Initializes a new instance of the PropertyDictionary class with the specified provider.

Top

Properties

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

Top

Methods

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

Top

Events

  Name Description
Public event PropertyChanged Occurs after the value of the application settings property is changed.
Public event PropertyMetadataChanged Occurs after the value of metadata property is changed.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Returns an enumerator that iterates through the current Collection object.

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.