IRemoteArgumentDictionaryContract.xml

<Type Name="IRemoteArgumentDictionaryContract" FullName="System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract">
  <TypeSignature Language="C#" Value="public interface IRemoteArgumentDictionaryContract : System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IRemoteArgumentDictionaryContract implements class System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract, class System.AddIn.Contract.Collections.IRemoteArgumentEnumerableContract, class System.AddIn.Contract.IContract" />
  <TypeSignature Language="DocId" Value="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />
  <TypeSignature Language="VB.NET" Value="Public Interface IRemoteArgumentDictionaryContract&#xA;Implements IRemoteArgumentCollectionContract" />
  <TypeSignature Language="F#" Value="type IRemoteArgumentDictionaryContract = interface&#xA;    interface IRemoteArgumentCollectionContract&#xA;    interface IRemoteArgumentEnumerableContract&#xA;    interface IContract" />
  <TypeSignature Language="C++ CLI" Value="public interface class IRemoteArgumentDictionaryContract : System::AddIn::Contract::Collections::IRemoteArgumentCollectionContract" />
  <AssemblyInfo>
    <AssemblyName>System.AddIn.Contract</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces>
    <Interface>
      <InterfaceName>System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.AddIn.Contract.Collections.IRemoteArgumentEnumerableContract</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.AddIn.Contract.IContract</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>Represents a collection of <see cref="T:System.AddIn.Contract.RemoteArgument" /> objects that are stored as key/value pairs.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Each element in an <xref:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract> is a key/value pair that is stored in a <xref:System.AddIn.Contract.Collections.RemoteArgumentDictionaryEntry> object. Each key/value pair must have a unique key.  
  
 The <xref:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract> interface enables the contained keys and values to be enumerated, but it does not imply any particular sort order.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public void Add (System.AddIn.Contract.RemoteArgument key, System.AddIn.Contract.RemoteArgument value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Add(valuetype System.AddIn.Contract.RemoteArgument key, valuetype System.AddIn.Contract.RemoteArgument value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.Add(System.AddIn.Contract.RemoteArgument,System.AddIn.Contract.RemoteArgument)" />
      <MemberSignature Language="VB.NET" Value="Public Sub Add (key As RemoteArgument, value As RemoteArgument)" />
      <MemberSignature Language="F#" Value="abstract member Add : System.AddIn.Contract.RemoteArgument * System.AddIn.Contract.RemoteArgument -&gt; unit" Usage="iRemoteArgumentDictionaryContract.Add (key, value)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; void Add(System::AddIn::Contract::RemoteArgument key, System::AddIn::Contract::RemoteArgument value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="key" Type="System.AddIn.Contract.RemoteArgument" />
        <Parameter Name="value" Type="System.AddIn.Contract.RemoteArgument" />
      </Parameters>
      <Docs>
        <param name="key">The <see cref="T:System.AddIn.Contract.RemoteArgument" /> to use as the key of the element to add.</param>
        <param name="value">The <see cref="T:System.AddIn.Contract.RemoteArgument" /> to use as the value of the element to add.</param>
        <summary>Adds an element with a specified key and value to the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />.</summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />.</exception>
      </Docs>
    </Member>
    <Member MemberName="Clear">
      <MemberSignature Language="C#" Value="public void Clear ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Clear() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.Clear" />
      <MemberSignature Language="VB.NET" Value="Public Sub Clear ()" />
      <MemberSignature Language="F#" Value="abstract member Clear : unit -&gt; unit" Usage="iRemoteArgumentDictionaryContract.Clear " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; void Clear();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Removes all elements from the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ContainsKey">
      <MemberSignature Language="C#" Value="public bool ContainsKey (System.AddIn.Contract.RemoteArgument key);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ContainsKey(valuetype System.AddIn.Contract.RemoteArgument key) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.ContainsKey(System.AddIn.Contract.RemoteArgument)" />
      <MemberSignature Language="VB.NET" Value="Public Function ContainsKey (key As RemoteArgument) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member ContainsKey : System.AddIn.Contract.RemoteArgument -&gt; bool" Usage="iRemoteArgumentDictionaryContract.ContainsKey key" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; bool ContainsKey(System::AddIn::Contract::RemoteArgument key);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="key" Type="System.AddIn.Contract.RemoteArgument" />
      </Parameters>
      <Docs>
        <param name="key">The key to locate in the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />.</param>
        <summary>Indicates whether the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" /> contains an element with the specified key.</summary>
        <returns>
          <see langword="true" /> if the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" /> contains an element with the specified key; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetEnumeratorContract">
      <MemberSignature Language="C#" Value="public System.AddIn.Contract.Collections.IRemoteArgumentDictionaryEnumeratorContract GetEnumeratorContract ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.AddIn.Contract.Collections.IRemoteArgumentDictionaryEnumeratorContract GetEnumeratorContract() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.GetEnumeratorContract" />
      <MemberSignature Language="VB.NET" Value="Public Function GetEnumeratorContract () As IRemoteArgumentDictionaryEnumeratorContract" />
      <MemberSignature Language="F#" Value="abstract member GetEnumeratorContract : unit -&gt; System.AddIn.Contract.Collections.IRemoteArgumentDictionaryEnumeratorContract" Usage="iRemoteArgumentDictionaryContract.GetEnumeratorContract " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::AddIn::Contract::Collections::IRemoteArgumentDictionaryEnumeratorContract ^ GetEnumeratorContract();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.AddIn.Contract.Collections.IRemoteArgumentDictionaryEnumeratorContract</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns an <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryEnumeratorContract" /> that can be used to iterate through the elements in the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />.</summary>
        <returns>An <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryEnumeratorContract" /> that can be used to iterate through the elements in the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetItem">
      <MemberSignature Language="C#" Value="public System.AddIn.Contract.RemoteArgument GetItem (System.AddIn.Contract.RemoteArgument key);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.AddIn.Contract.RemoteArgument GetItem(valuetype System.AddIn.Contract.RemoteArgument key) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.GetItem(System.AddIn.Contract.RemoteArgument)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetItem (key As RemoteArgument) As RemoteArgument" />
      <MemberSignature Language="F#" Value="abstract member GetItem : System.AddIn.Contract.RemoteArgument -&gt; System.AddIn.Contract.RemoteArgument" Usage="iRemoteArgumentDictionaryContract.GetItem key" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::AddIn::Contract::RemoteArgument GetItem(System::AddIn::Contract::RemoteArgument key);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.AddIn.Contract.RemoteArgument</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="key" Type="System.AddIn.Contract.RemoteArgument" />
      </Parameters>
      <Docs>
        <param name="key">The key of the value to return.</param>
        <summary>Returns the value of the element with the specified key.</summary>
        <returns>The <see cref="T:System.AddIn.Contract.RemoteArgument" /> with the specified key.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetKeys">
      <MemberSignature Language="C#" Value="public System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract GetKeys ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract GetKeys() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.GetKeys" />
      <MemberSignature Language="VB.NET" Value="Public Function GetKeys () As IRemoteArgumentCollectionContract" />
      <MemberSignature Language="F#" Value="abstract member GetKeys : unit -&gt; System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract" Usage="iRemoteArgumentDictionaryContract.GetKeys " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::AddIn::Contract::Collections::IRemoteArgumentCollectionContract ^ GetKeys();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns an <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract" /> that contains the keys of the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" /> object.</summary>
        <returns>An <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract" /> that contains the keys of the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" /> object.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetValues">
      <MemberSignature Language="C#" Value="public System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract GetValues ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract GetValues() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.GetValues" />
      <MemberSignature Language="VB.NET" Value="Public Function GetValues () As IRemoteArgumentCollectionContract" />
      <MemberSignature Language="F#" Value="abstract member GetValues : unit -&gt; System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract" Usage="iRemoteArgumentDictionaryContract.GetValues " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::AddIn::Contract::Collections::IRemoteArgumentCollectionContract ^ GetValues();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns an <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract" /> that contains the values of the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" /> object.</summary>
        <returns>An <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentCollectionContract" /> that contains the values of the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" /> object.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Remove">
      <MemberSignature Language="C#" Value="public bool Remove (System.AddIn.Contract.RemoteArgument key);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Remove(valuetype System.AddIn.Contract.RemoteArgument key) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.Remove(System.AddIn.Contract.RemoteArgument)" />
      <MemberSignature Language="VB.NET" Value="Public Function Remove (key As RemoteArgument) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member Remove : System.AddIn.Contract.RemoteArgument -&gt; bool" Usage="iRemoteArgumentDictionaryContract.Remove key" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; bool Remove(System::AddIn::Contract::RemoteArgument key);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="key" Type="System.AddIn.Contract.RemoteArgument" />
      </Parameters>
      <Docs>
        <param name="key">The key of the element to remove.</param>
        <summary>Removes the element with the specified key from the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />.</summary>
        <returns>
          <see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />. This method returns <see langword="false" /> if <paramref name="key" /> is not found in the <see cref="T:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetItem">
      <MemberSignature Language="C#" Value="public void SetItem (System.AddIn.Contract.RemoteArgument key, System.AddIn.Contract.RemoteArgument value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetItem(valuetype System.AddIn.Contract.RemoteArgument key, valuetype System.AddIn.Contract.RemoteArgument value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.AddIn.Contract.Collections.IRemoteArgumentDictionaryContract.SetItem(System.AddIn.Contract.RemoteArgument,System.AddIn.Contract.RemoteArgument)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetItem (key As RemoteArgument, value As RemoteArgument)" />
      <MemberSignature Language="F#" Value="abstract member SetItem : System.AddIn.Contract.RemoteArgument * System.AddIn.Contract.RemoteArgument -&gt; unit" Usage="iRemoteArgumentDictionaryContract.SetItem (key, value)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; void SetItem(System::AddIn::Contract::RemoteArgument key, System::AddIn::Contract::RemoteArgument value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.AddIn.Contract</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="key" Type="System.AddIn.Contract.RemoteArgument" />
        <Parameter Name="value" Type="System.AddIn.Contract.RemoteArgument" />
      </Parameters>
      <Docs>
        <param name="key">The key of the value to replace.</param>
        <param name="value">The new value of the specified element.</param>
        <summary>Replaces the value of an element.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>