CustomActionData Class

DTF API

previous page next page

Deployment Tools Foundation CustomActionData Class

Contains a collection of key-value pairs suitable for passing between immediate and deferred/rollback/commit custom actions.

Declaration Syntax

Visual Basic

Visual C++

public sealed class CustomActionData : IDictionary<string, string>, 
	ICollection<KeyValuePair<string, string>>, IEnumerable<KeyValuePair<string, string>>, 
	IEnumerable

Public NotInheritable Class CustomActionData
	Implements IDictionary(Of String, String), 
	ICollection(Of KeyValuePair(Of String, String)), IEnumerable(Of KeyValuePair(Of String, String)), 
	IEnumerable

public ref class CustomActionData sealed : IDictionary<String^, String^>, 
	ICollection<KeyValuePair<String^, String^>>, IEnumerable<KeyValuePair<String^, String^>>, 
	IEnumerable

[<SealedAttribute>]
type CustomActionData =  
    class
        interface IDictionary<string, string>
        interface ICollection<KeyValuePair<string, string>>
        interface IEnumerable<KeyValuePair<string, string>>
        interface IEnumerable
    end

Members

All Members	Constructors	Methods	Properties	Fields
Public Protected		Instance Static		Declared Inherited

Icon	Member	Description
	CustomActionData()()()()	Creates a new empty custom action data object.
	CustomActionData(String)	Reconstructs a custom action data object from data that was previously persisted in a string.
	Add(String, String)	Adds a key and value to the data collection.
	Add(KeyValuePair<(Of <<'(String, String>)>>))	Adds an item with key and value to the data collection.
	AddObject<(Of <<'(T>)>>)(String, T)	Adds a value to the data collection, using XML serialization to persist the object as a string.
	Clear()()()()	Removes all items from the data.
	Contains(KeyValuePair<(Of <<'(String, String>)>>))	Determines whether the data contains a specified item.
	ContainsKey(String)	Determines whether the data contains an item with the specified key.
	CopyTo(array<KeyValuePair<(Of <<'(String, String>)>>)>[]()[][], Int32)	Copies the data to an array, starting at a particular array index.
	Count	Gets the number of items in the data.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize()()()()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator()()()()	Returns an enumerator that iterates through the collection.
	GetHashCode()()()()	Serves as a hash function for a particular type. (Inherited from Object.)
	GetObject<(Of <<'(T>)>>)(String)	Gets a value from the data collection, using XML serialization to load the object from a string.
	GetType()()()()	Gets the Type of the current instance. (Inherited from Object.)
	IsReadOnly	Gets a value indicating whether the data is read-only.
	Item[([( String])])	Gets or sets a data value with a specified key.
	Keys	Gets a collection object containing all the keys of the data.
	MemberwiseClone()()()()	Creates a shallow copy of the current Object. (Inherited from Object.)
	PropertyName	"CustomActionData" literal property name.
	Remove(String)	Removes the item with the specified key from the data.
	Remove(KeyValuePair<(Of <<'(String, String>)>>))	Removes an item from the data.
	ToString()()()()	Gets a string representation of the data suitable for persisting in a property. (Overrides Object.ToString()()()().)
	TryGetValue(String, String%)	Gets the value with the specified key.
	Values	Gets a collection containing all the values of the data.

Remarks

Call the ToString()()()() method to get a string suitable for storing in a property and reconstructing the custom action data later.

Inheritance Hierarchy

Object
	CustomActionData