Get and Set Dictionary Key-Value Pairs Example (C#)

This example shows how to access key-value pairs in a vault dictionary.

NOTE: If using the primary interop assembly provided with SOLIDWORKS PDM Professional, see Using .NET Framework 4.0 in Stand-alone Applications.

//----------------------------------------------------------------------------
// Preconditions:
// 1. Start Microsoft Visual Studio.
//    a. Click File > New > Project > Visual C# > Windows Forms Application.
//    b. Type TestDictionary_CSharp in Name.
//    c. Click Browse and navigate to the folder where to create 
//       the project.
//    d. Click OK. 
//    e. Click Show All Files in the Solution Explorer toolbar and expand 
//       Form1.cs in the Solution Explorer.
//    f. Replace the code in Form1.cs with this code.
//    g. To create the form, replace the code in Form1.Designer.cs with this code.
// 2. Add EPDM.Interop.epdm.dll as a reference (right-click the project
//    name in the Solution Explorer, click Add Reference, click 
//    Assemblies > Framework in the left-side panel, browse to the top folder of 
//    your SOLIDWORKS PDM Professional installation, locate and click 
//    EPDM.Interop.epdm.dll, click Open, and click Add).
// 3. Right-click EPDM.Interop.epdm in References, cick Properties, and set 
//    Embed Interop Types to False to handle methods that pass arrays of 
//    structures.
// 4. Click Debug > Start Debugging or press F5.
//
// Postconditions: 
//  1. Displays a dialog.
//  2. Select a vault view.
//  3. Click Substring in key.
//  4. Click Get key-value pairs.
//     a. Displays a message box with all key-value pairs in the dictionary where
//        string key contains "at".
//     b. Click OK.
//  5. Click Integer key range.
//  6. Click Get key-value pairs.
//     a. Displays a message box with all key-value pairs in the dictionary where
//        integer keys are in the range, 13-88.
//     b. Click OK.
//  7. Click Substring in values of all integer keys.
//  8. Click Get key-value pairs.
//     a. Displays a message box with all key-value pairs in the dictionary where
//        value contains "three".
//     b. Click OK.
//  9. Click Specific integer key.
// 10. Click Get key-value pairs.
//     a. Displays a message box with the value for key, 77.
//     b. Click OK.
// 11. Click Enumeration of all integer keys.
// 12. Click Get key-value pairs.
//     a. Displays a message box with all integer key-value pairs in the dictionary.
//     b. Click OK. 
// 13. Click Delete a key-value pair.
//     a. Displays a message box notifying that key, 2, is removed.
//     b. Click OK.
// 14. Click Create a key-value pair.
//     a. Displays a message box notifying that key, 2, is created.
//     b. Click OK.
// 15. Close the dialog.
//----------------------------------------------------------------------------

//Form1.cs

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using EPDM.Interop.epdm;
 
 
namespace TestDictionary_CSharp
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
 
        IEdmVault5 vault1;
        IEdmVault8 vault;
        
        EdmViewInfo[] Views = null;
        IEdmDictionary5 dic;
 
        public void Form1_Load(System.Object sender, System.EventArgs e)
        {
            try
            {
                vault1 = new EdmVault5();
                vault = (IEdmVault8)vault1;
                vault.GetVaultViews(out Views, false);
                VaultsComboBox.Items.Clear();
                foreach (EdmViewInfo View in Views)
                {
                    VaultsComboBox.Items.Add(View.mbsVaultName);
                }
                if (VaultsComboBox.Items.Count > 0)
                {
                    VaultsComboBox.Text = (string)VaultsComboBox.Items[0];
                }
            }
            catch (System.Runtime.InteropServices.COMException ex)
            {
                MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
 
        }
 
 
        private void Button5_Click(System.Object sender, System.EventArgs e)
        {
            //Delete key-value pair clicked
            try
            {
                IEdmVault7 vault2 = null;
                if (vault1 == null)
                {
                    vault1 = new EdmVault5();
                }
                vault2 = (IEdmVault7)vault1;
 
                if (!vault1.IsLoggedIn)
                {
                    vault1.LoginAuto(VaultsComboBox.Text, this.Handle.ToInt32());
                }
 
                dic = vault.GetDictionary("MyDictionary", true);
                //Add some values 
                dic.LongSetAt(2, "two");
                dic.LongSetAt(15, "fifteen");
                dic.LongSetAt(300, "three hundred");
                dic.LongSetAt(77, "seventy-seven");
 
                dic.LongRemoveAt(2);
                MessageBox.Show("Key <2> removed.");
                dic.RemoveDictionary();
 
            }
            catch (System.Runtime.InteropServices.COMException ex)
            {
                MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
 
        private void Button1_Click(System.Object sender, System.EventArgs e)
        {
            //Get key-value pairs clicked
            try
            {
                IEdmVault7 vault2 = null;
                if (vault1 == null)
                {
                    vault1 = new EdmVault5();
                }
                vault2 = (IEdmVault7)vault1;
 
                if (!vault1.IsLoggedIn)
                {
                    vault1.LoginAuto(VaultsComboBox.Text, this.Handle.ToInt32());
                }
 
                if (this.RadioButton1.Checked)
                {
                    //Get key-value pairs by substring in key
 
                    dic = vault.GetDictionary("MyDictionary", true);
 
                    //Add some values 
                    dic.StringSetAt("Cat", "Socks");
                    dic.StringSetAt("Dog", "Milou");
                    dic.StringSetAt("Human", "Attila");
                    dic.StringSetAt("At last", "Last value");
 
                    //Find all keys containing the text, "at" 
                    string key = "";
                    string value = "";
                    string message = null;
                    message = "Keys with 'at' in them:" + "\r\n";
                    IEdmPos5 pos = default(IEdmPos5);
                    pos = dic.StringFindKeys("at");
                    while (!pos.IsNull)
                    {
                        dic.StringGetNextAssoc(pos, out key, out value);
                        message = message + "<" + key + "> = <" + value + ">" + "\r\n";
                    }
 
                    //Show a message and delete the dictionary 
                    MessageBox.Show(message);
                    dic.RemoveDictionary();
 
                }
                else if (this.RadioButton2.Checked)
                {
                    //Get key-value pairs by integer key range
 
                    dic = vault.GetDictionary("MyDictionary", true);
 
                    //Add some values 
                    dic.LongSetAt(2, "two");
                    dic.LongSetAt(15, "fifteen");
                    dic.LongSetAt(300, "three hundred");
                    dic.LongSetAt(77, "seventy-seven");
 
                    //Find all keys in the range, 13-88 
                    int key = 0;
                    string value = "";
                    string message = null;
                    message = "Keys in range, 13-88:" + "\r\n";
                    IEdmPos5 pos = default(IEdmPos5);
                    pos = dic.LongFindKeys(13, 88);
                    while (!pos.IsNull)
                    {
                        dic.LongGetNextAssoc(pos, out key, out value);
                        message = message + "<" + key.ToString() + "> = <" + value + ">" + "\r\n";
                    }
 
                    //Show a message and delete the dictionary 
                    MessageBox.Show(message);
                    dic.RemoveDictionary();
 
                }
                else if (this.RadioButton3.Checked)
                {
                    //Get key-value pairs by substring in values of integer keys
 
                    dic = vault.GetDictionary("MyDictionary", true);
                    //Add some values 
                    dic.LongSetAt(2, "two");
                    dic.LongSetAt(15, "fifteen");
                    dic.LongSetAt(300, "three hundred");
                    dic.LongSetAt(77, "seventy-seven");
 
                    string bsValueSubString = "three";
                    IEdmPos5 aPos = default(IEdmPos5);
                    int plRetKey = 0;
                    string pbsRetValue = "";
                    aPos = dic.LongFindValues(bsValueSubString);
                    while (!aPos.IsNull)
                    {
                        dic.LongGetNextAssoc(aPos, out plRetKey, out pbsRetValue);
                        MessageBox.Show("Key-value pair with " + "\"" + bsValueSubString + "\"" + " in value: " + "\n" + "<" + plRetKey + "> = <" + pbsRetValue + ">");
                    }
                    dic.RemoveDictionary();
                }
                else if (this.RadioButton4.Checked)
                {
                    //Get key-value pairs by specific integer key
 
                    dic = vault.GetDictionary("MyDictionary", true);
                    //Add some values 
                    dic.LongSetAt(2, "two");
                    dic.LongSetAt(15, "fifteen");
                    dic.LongSetAt(300, "three hundred");
                    dic.LongSetAt(77, "seventy-seven");
 
                    string pbsRetValue = "";
                    dic.LongGetAt(77, out pbsRetValue);
                    MessageBox.Show("Value for key <77>: <" + pbsRetValue + ">");
                    dic.RemoveDictionary();
                }
                else if (this.RadioButton5.Checked)
                {
                    //Get key-value pairs by enumeration of all integer keys
 
                    dic = vault.GetDictionary("MyDictionary", true);
                    //Add some values
                    dic.LongSetAt(2, "two");
                    dic.LongSetAt(15, "fifteen");
                    dic.LongSetAt(300, "three hundred");
                    dic.LongSetAt(77, "seventy-seven");
 
                    string msg = null;
                    int key = 0;
                    string value = "";
 
                    msg = "Integer keys in dictionary:" + "\n";
 
                    IEdmPos5 pos = default(IEdmPos5);
                    pos = dic.LongGetFirstPosition();
                    while (!pos.IsNull)
                    {
                        dic.LongGetNextAssoc(pos, out key, out value);
                        msg = msg + "<" + Conversion.Str(key) + "> = <" + value + ">" + "\n";
                    }
                    MessageBox.Show(msg);
                    dic.RemoveDictionary();
 
                }
                else
                {
                    MessageBox.Show("Select how to get key-value pairs");
 
                }
 
            }
            catch (System.Runtime.InteropServices.COMException ex)
            {
                MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
 
        private void Button7_Click(System.Object sender, System.EventArgs e)
        {
            //Create key-value pair clicked
            try
            {
                IEdmVault7 vault2 = null;
                if (vault1 == null)
                {
                    vault1 = new EdmVault5();
                }
                vault2 = (IEdmVault7)vault1;
 
                if (!vault1.IsLoggedIn)
                {
                    vault1.LoginAuto(VaultsComboBox.Text, this.Handle.ToInt32());
                }
 
                string pbsRetValue = "";
 
                dic = vault.GetDictionary("MyDictionary", true);
                dic.LongTestAndSetAt(2, "Two");
                dic.LongGetAt(2, out pbsRetValue);
                MessageBox.Show("Created:" + "\n" + "<2> = <" + pbsRetValue + ">");
                dic.RemoveDictionary();
            }
            catch (System.Runtime.InteropServices.COMException ex)
            {
                MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
    }
}

Back to top

//Form1.Designer.cs

Back to top