This documentation is archived and is not being maintained.

NameObjectCollectionBase.BaseGetAllKeys Method

Returns a String array that contains all the keys in the NameObjectCollectionBase instance.

Namespace: System.Collections.Specialized
Assembly: System (in system.dll)

'Declaration
Protected Function BaseGetAllKeys As String()
'Usage
Dim returnValue As String()

returnValue = Me.BaseGetAllKeys
protected String[] BaseGetAllKeys ()
protected function BaseGetAllKeys () : String[]
Not applicable.

Return Value

A String array that contains all the keys in the NameObjectCollectionBase instance.

This method is an O(n) operation, where n is Count.

The following code example uses BaseGetAllKeys and BaseGetAllValues to get an array of the keys or an array of the values.

Imports System
Imports System.Collections
Imports System.Collections.Specialized

Public Class MyCollection
   Inherits NameObjectCollectionBase

   Private _de As New DictionaryEntry()

   ' Gets a key-and-value pair (DictionaryEntry) using an index.
   Default Public ReadOnly Property Item(index As Integer) As DictionaryEntry
      Get
         _de.Key = Me.BaseGetKey(index)
         _de.Value = Me.BaseGet(index)
         Return _de
      End Get
   End Property

   ' Adds elements from an IDictionary into the new collection.
   Public Sub New(d As IDictionary)
      Dim de As DictionaryEntry
      For Each de In  d
         Me.BaseAdd(CType(de.Key, String), de.Value)
      Next de
   End Sub 'New

   ' Gets a String array that contains all the keys in the collection.
   Public ReadOnly Property AllKeys() As String()
      Get
         Return Me.BaseGetAllKeys()
      End Get
   End Property

   ' Gets an Object array that contains all the values in the collection.
   Public ReadOnly Property AllValues() As Array
      Get
         Return Me.BaseGetAllValues()
      End Get
   End Property

   ' Gets a String array that contains all the values in the collection.
   Public ReadOnly Property AllStringValues() As String()
      Get
         Return CType(Me.BaseGetAllValues(GetType(String)), String())
      End Get
   End Property

End Class 'MyCollection


Public Class SamplesNameObjectCollectionBase   

   Public Shared Sub Main()

      ' Creates and initializes a new MyCollection instance.
      Dim d As New ListDictionary()
      d.Add("red", "apple")
      d.Add("yellow", "banana")
      d.Add("green", "pear")
      Dim myCol As New MyCollection(d)
      Console.WriteLine("Initial state of the collection (Count = {0}):", myCol.Count)
      PrintKeysAndValues(myCol)

      ' Displays the list of keys.
      Console.WriteLine("The list of keys:")
      Dim s As String
      For Each s In  myCol.AllKeys
         Console.WriteLine("   {0}", s)
      Next s

      ' Displays the list of values of type Object.
      Console.WriteLine("The list of values (Object):")
      Dim o As Object
      For Each o In  myCol.AllValues
         Console.WriteLine("   {0}", o.ToString())
      Next o

      ' Displays the list of values of type String.
      Console.WriteLine("The list of values (String):")
      For Each s In  myCol.AllValues
         Console.WriteLine("   {0}", s)
      Next s

   End Sub 'Main

   Public Shared Sub PrintKeysAndValues(myCol As MyCollection)
      Dim i As Integer
      For i = 0 To myCol.Count - 1
         Console.WriteLine("[{0}] : {1}, {2}", i, myCol(i).Key, myCol(i).Value)
      Next i
   End Sub 'PrintKeysAndValues

End Class 'SamplesNameObjectCollectionBase 


'This code produces the following output.
'
'Initial state of the collection (Count = 3):
'[0] : red, apple
'[1] : yellow, banana
'[2] : green, pear
'The list of keys:
'   red
'   yellow
'   green
'The list of values (Object):
'   apple
'   banana
'   pear
'The list of values (String):
'   apple
'   banana
'   pear


import System.* ;
import System.Collections.* ;
import System.Collections.Specialized.* ;

public class MyCollection extends NameObjectCollectionBase
{
    private DictionaryEntry _de =  new DictionaryEntry();

    // Gets a key-and-value pair (DictionaryEntry) using an index.
    /** @property 
     */
    public DictionaryEntry get_Item(int index)
    {
        _de.set_Key(this.BaseGetKey(index));
        _de.set_Value(this.BaseGet(index));
        return _de ;
    } //get_Item

    // Adds elements from an IDictionary into the new collection.
    public MyCollection(IDictionary d)
    {        
        IDictionaryEnumerator objEnum = d.GetEnumerator();

        while (objEnum.MoveNext()) {        
            DictionaryEntry de = (DictionaryEntry)objEnum.get_Current();
            this.BaseAdd(((String)(de.get_Key())), de.get_Value());
            
        }
    } //MyCollection

    // Gets a String array that contains all the keys in the collection.
    /** @property 
     */
    public String[] get_AllKeys()
    {
        return this.BaseGetAllKeys() ;
    } //get_AllKeys

    // Gets an Object array that contains all the values in the collection.
    /** @property 
     */
    public Array get_AllValues()
    {
        return this.BaseGetAllValues() ;
    } //get_AllValues

    // Gets a String array that contains all the values in the collection.
    /** @property
     */
    public String[] get_AllStringValues()
    {
        return ((String[])(this.BaseGetAllValues(Type.GetType("System.String"))));
    } //get_AllStringValues
} //MyCollection


public class SamplesNameObjectCollectionBase
{
    public static void main(String[] args)
    {        
        // Creates and initializes a new MyCollection instance.
        IDictionary d = new ListDictionary();
        d.Add("red", "apple");
        d.Add("yellow", "banana");
        d.Add("green", "pear");
        MyCollection myCol =  new MyCollection(d);
        Console.WriteLine("Initial state of the collection (Count = {0}):",
            System.Convert.ToString(myCol.get_Count()));
        PrintKeysAndValues(myCol);
        
        // Displays the list of keys.
        Console.WriteLine("The list of keys:");
        
        String str = new String();

        for (int iCtr = 0; iCtr < myCol.get_Count(); iCtr++) {        
            str = myCol.get_AllKeys()[iCtr];
            Console.WriteLine("   {0}", str);
        }
        
        // Displays the list of values of type Object.
        Console.WriteLine("The list of values (Object):");

        Object obj = new Object();

        for (int iCtr=0; iCtr < myCol.get_Count(); iCtr++) {        
            obj = System.Convert.ToString(myCol.get_AllValues().get_Item(iCtr));
            Console.WriteLine("   {0}", System.Convert.ToString(obj));
        }
        
        // Displays the list of values of type String.
        Console.WriteLine("The list of values (String):");
        
        for (int iCtr =0; iCtr < myCol.get_AllValues().get_Count(); iCtr++) {        
            str = System.Convert.ToString(myCol.get_AllValues().get_Item(iCtr));
            Console.WriteLine("   {0}", str);
        }
    } //main

    public static void PrintKeysAndValues(MyCollection myCol)
    {
        for (int i = 0; i < myCol.get_Count(); i++) {        
            Console.WriteLine("[{0}] : {1}, {2}",System.Convert.ToString(i),
                myCol.get_Item(i).get_Key(), myCol.get_Item(i).get_Value());
        } 
    } //PrintKeysAndValues
} //SamplesNameObjectCollectionBase

/*
This code produces the following output.

Initial state of the collection (Count = 3):
[0] : red, apple
[1] : yellow, banana
[2] : green, pear
The list of keys:
   red
   yellow
   green
The list of values (Object):
   apple
   banana
   pear
The list of values (String):
   apple
   banana
   pear

*/

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: