SOLIDWORKS PDM Professional API Help

Get Card Control Information Example (C#)

This example shows how to get information about the list and edit box controls in a selected file's data card.

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.
//  2. Click File > New > Project > Visual C# > Windows Forms Application.
//  3. Type CardControlInfo_CSharp in Name.
//  4. Click Browse to navigate to the folder where to create the project.
//  5. Click OK. 
//  6. Click Show All Files in the Solution Explorer toolbar and expand 
//     Form1.cs in the Solution Explorer.
//  7. Replace the code in Form1.cs with this code.
//  8. To create the form, replace the code in Form1.Designer.cs with this code.
//  9. Add EPDM.Interop.epdm.dll as a reference (right-click the project
//     name in the Solution Explorer, click Add Reference, click 
//     Framework in the left-side panel, browse to the top folder of your 
//     SOLIDWORKS PDM Professional installation, locate and select 
//     EPDM.Interop.epdm.dll, click Open, and click Add).
// 10. Right-click EPDM.Interop.epdm in References, click Properties, and set 
//     Embed Interop Types to False to handle methods that pass arrays of 
//     structures.
// 11. Ensure that there is a file in the vault whose extension has a
//     file data card in the vault.
// 12. Click Debug > Start Debugging or press F5.
//
// Postconditions: 
//  1. Displays a dialog.
//  2. Select a vault.
//  3. Click Select file.
//  4. In the Select File dialog:
//     a. Click a file whose extension has a file data card in the vault.
//     b. Click Open.
//  5. Click Get card information.
//  6. A message box displays information about the selected file's data card.
//  7. Click OK in the message box.
//  8. A message box displays the list items of any drop list controls.
//  9. Click OK in the message box.
// 10. A message box displays information about each edit box control in the
//     data card.
// 11. Click OK in the message box.
// 12. 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 CardControlInfo_CSharp
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
        private IEdmVault5 vault1 = null;
        IEdmFile5 aFile;
        IEdmFolder5 aFolder;
        IEdmFolder5 ppoRetParentFolder;
        IEdmCard6 aCard;
        IEdmCardControl7 aControl;
        IEdmPos5 aPos;
        int plWidth;
        int plHeight;
        int plX;
        int plY;
        int plParentCtrlID;
        int plPageNo;
        object poMin = null;
        object poMax = null;
        int varType;
        int contType;
        string fileExt;
        int cardID;
        string str;
 
        int k;
 
        public void Form1_Load(System.Object sender, System.EventArgs e)
        {
            try
            {
                IEdmVault5 vault1 = new EdmVault5();
                IEdmVault8 vault = (IEdmVault8)vault1;
                EdmViewInfo[] Views = null;
 
                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);
            }
        }
 
        public void SelectFiles_Click(System.Object sender, System.EventArgs e)
        {
            try
            {
                File1List.Items.Clear();
 
                IEdmVault7 vault2 = null;
                if (vault1 == null)
                {
                    vault1 = new EdmVault5();
                }

                vault2 = (IEdmVault7)vault1;
                if (!vault1.IsLoggedIn)
                {
                    vault1.LoginAuto(VaultsComboBox.Text, this.Handle.ToInt32());
                }
 
                //Set the initial directory in the Select File dialog
                OpenFileDialog1.InitialDirectory = vault1.RootFolderPath;
 
                //Show the Select File dialog
                System.Windows.Forms.DialogResult DialogResult;
                DialogResult = OpenFileDialog1.ShowDialog();
 
                if (!(DialogResult == System.Windows.Forms.DialogResult.OK))
                {
                    // do nothing
                }
                else
                {
                    foreach (string FileName in OpenFileDialog1.FileNames)
                    {
                        File1List.Items.Add(FileName);
                        aFile = vault1.GetFileFromPath(FileName, out ppoRetParentFolder);
                        k = FileName.LastIndexOf(".");
                        fileExt = FileName.Substring(k + 1, (FileName.Length) - k - 1);
                        aPos = aFile.GetFirstFolderPosition();
                        aFolder = aFile.GetNextFolder(aPos);
                    }
                }
 
            }
            catch (System.Runtime.InteropServices.COMException ex)
            {
                MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
 
        public void GetCardControls_Click(System.Object sender, System.EventArgs e)
        {
 
            try
            {
                IEdmVault7 vault2 = null;
                if (vault1 == null)
                {
                    vault1 = new EdmVault5();
                }

                vault2 = (IEdmVault9)vault1;
                if (!vault1.IsLoggedIn)
                {
                    vault1.LoginAuto(VaultsComboBox.Text, this.Handle.ToInt32());
                }
 
 
                if ((aFile != null))
                {
                    // Get the selected file's data card
                    aCard = (IEdmCard6)aFolder.GetCard(fileExt);
                    cardID = aFolder.GetCardID(fileExt);
 
                    aCard.GetSize(out plWidth, out plHeight);
                    str = "File: " + aFile.Name + "\r\n" + "Card ID: " + cardID + ", EdmCardType: " + aCard.CardType + ", Width: " + plWidth + ", Height: " + plHeight;
                    MessageBox.Show(str);
 
                    aPos = aCard.GetFirstControlPosition();
                    while (!(aPos.IsNull))
                    {
                        aControl = (IEdmCardControl6)aCard.GetNextControl(aPos);
                        contType = (int)aControl.ControlType;

 

                        bool ret = false;
                        string[] variableItemsList = null;
                        if (((contType == 7) | (contType == 8) | (contType == 9) | (contType == 10)))
                        {
                            str = "List values associated with drop-down card control: " + aControl.VariableID.ToString();
                            ret = aControl.GetControlVariableList(aFile.ID, out variableItemsList);
 
                            foreach (string listValue in variableItemsList)
                            {
                                str = str + "\r\n" + listValue;
                            }
                            MessageBox.Show(str);
                        }

 
                        // Get the edit box controls in the card
                        if (contType == 4)
                        {
                            str = "";
                            aControl.GetParentInfo(out plParentCtrlID, out plPageNo);
                            aControl.GetPosition(out plX, out plY, out plWidth, out plHeight);
                            varType = (int)aControl.GetValidation(out poMin, out poMax);
 
                            str = "Card control: " + aControl.Name;
                            str = str + "\r\n" + "Variable ID: " + aControl.VariableID + "\t\n" + "EdmCardControlType: " + contType + "\r\n" + "Is multi-line? " + aControl.IsMultiLine + "\r\n" + "Is read-only? " + aControl.IsReadOnly + "\r\n" + "Show in preview? " + aControl.ShowInPreview;
                            str = str + "\r\n" + "Location on card: [" + plX + ", " + plY + "], Width: " + plWidth + ", Height: " + plHeight;
                            str = str + "\r\n" + "Parent control ID (0, if none): " + plParentCtrlID;
                            str = str + "\r\n" + "Tab index: " + plPageNo;
                            str = str + "\r\n" + "EdmVariableType: " + varType;

                            str = str + "\r\n" + "Updates all configurations? " + aControl.UpdatesAllConfigurations.ToString();
 

                            MessageBox.Show(str);
                        }
                    }
                }
            }
            catch (System.Runtime.InteropServices.COMException ex)
            {
                MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
 
        }
    }
}