# SOLIDWORKS PDM Professional API Help

# Notify User When File Changes State Example (C#)

This example shows how to create an add-in that pops up a message box when a file is approved.

//--------------------------------------------------------------------------------------
// Preconditions:
// 1. Start Microsoft Visual Studio.
// 2. Click File > New > Project > Visual C# > Class Library (.NET Framework).
// 3. Select .NET Framework 4.5 or later in the dropdown.
// 4. Type StateChangeNotificationAddin in Name.
// 5. Click Browse and navigate to the folder where to create the project.
// 6. Click OK.
// 7. Right-click the project name in the Solution Explorer and click Add Reference.
// 8. In the Add Reference dialog:
// a. Add the SOLIDWORKS PDM Professional interop assembly as a reference (click Browse in the
// left-side panel, navigate to and select EPDM.Interop.epdm.dll,
// and click OK).
// b. Add System.Windows.Forms as a reference (click Assemblies > Framework in the
// left-side panel, click System.Windows.Forms, and click OK).
// c. Click Close.
// 9. Right-click the project name in the Solution Explorer and click Properties.
//10. In the Properties window:
// a. On the Application tab, click Assembly Information.
// b. De-select Make assembly COM-Visible.
// c. On the Build tab, select Any CPU, de-select Prefer 32-bit, and select Register for COM interop.
//11. Save the project.
//12. Copy the code below to Class1.cs.
//13. To populate the GUID attribute, click Tools > Create GUID in the IDE,
// select GUID Format 5, click Copy, and click Exit. Populate [Guid("")...] with
// the copied string.
//14. Click Build > Build Solution.
//
// Postconditions:
// 1. Open the SOLIDWORKS PDM Professional Administration tool, expand a vault_name node,
// and log in as Admin.
// 2. Ensure that Default Workflow exists under vault_name > Workflows.
// a. Ensure that the workflow has an Approved state.
// b. Ensure that the workflow has a Change Approved transition.
// 3. Under vault_name, right-click Add-ins and click New Add-in.
// a. Navigate to the bin\Debug directory of your built project.
// b. Click EPDM.Interop.epdm.dll and StateChangeNotificationAddin.dll.
// c. Click Open.
// d. Click OK.
// 4. Click OK after reading the SOLIDWORKS PDM Professional warning dialog.
// 5. Open File Explorer on a view of vault_name.
// a. Log in as Admin.
// b. Create a new file in the root directory of vault_name and check it in.
// c. Right-click the file and click Change State > transition.
// d. Click OK in the Do Transition dialog.
// e. Repeat steps c and d until the file is in a state that it can be Approved.
// g. Right-click the file and click Change State > Change Approved.
// h. Click OK in the Do Transition dialog.
// 6. A message box pops up notifying the user whether the file changing state is a top
// node. Click OK.
// 7. A message box pops up notifying the user that the file has been approved. Click OK.
//---------------------------------------------------------------------------------------
using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using System.Diagnostics;
using System.Windows.Forms;
using EPDM.Interop.epdm;
using System.Runtime.InteropServices;

[Guid(""), ComVisible(true)]
public class ChangeStateNotification : IEdmAddIn5
{
public void GetAddInInfo(ref EdmAddInInfo poInfo, IEdmVault5 poVault, IEdmCmdMgr5 poCmdMgr)
{
try
{
poInfo.mbsAddInName = "C# Add-In";
poInfo.mbsCompany = "Dassault Systemes";
poInfo.mbsDescription = "Exercise demonstrating responding to a change state event.";
poInfo.mlAddInVersion = 1;
//Minimum SOLIDWORKS PDM Professional version
//needed for C# Add-Ins is 6.4
poInfo.mlRequiredVersionMajor = 6;
poInfo.mlRequiredVersionMinor = 4;
//Register to receive a notification when
//a file has changed state
poCmdMgr.AddHook(EdmCmdType.EdmCmd_PostState);
}
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 OnCmd(ref EdmCmd poCmd, ref EdmCmdData[] ppoData)
{
try {
string AffectedFileNames = "";
Boolean topNode;
IEdmCmdNode cmdNode;

switch (poCmd.meCmdType) {
//A file has changed state
case EdmCmdType.EdmCmd_PostState:
foreach ( EdmCmdData AffectedFile in ppoData) {
if (AffectedFile.mbsStrData2 == "Approved") {
AffectedFileNames += AffectedFile.mbsStrData1 + "";
}

cmdNode = (IEdmCmdNode)AffectedFile.mpoExtra;
topNode = (Boolean)cmdNode.GetProperty(EdmCmdNodeProp.EdmCmdNode_IsTopNode);
((EdmVault5)(poCmd.mpoVault)).MsgBox(poCmd.mlParentWnd, "File changing state is a top node? " + topNode);
}
if (AffectedFileNames.Length > 0) {
((EdmVault5)(poCmd.mpoVault)).MsgBox(poCmd.mlParentWnd, AffectedFileNames + " has been approved.");
}
break;
//The event isn't registered
default:
((EdmVault5)(poCmd.mpoVault)).MsgBox(poCmd.mlParentWnd, "An unknown command type was issued.");
break;
}
} catch (System.Runtime.InteropServices.COMException ex) {
MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + ex.Message);
} catch (Exception ex) {
MessageBox.Show(ex.Message);
}
}
}