Melody's VSTA Blog - All Comments

re: Supporting the “new” Operator in VSTA Add-Ins

WOW Gold — Tue, 07 Jun 2011 09:36:42 GMT

That's helpful.

Thanks!

re: Using a MessageFilter to avoid IDE threading and timing issues.

adamtarshis — Wed, 23 Mar 2011 06:23:48 GMT

So this code works great in .net 3.5 targeted projects - but not in .net 4. The Retry method is never called - it seems like the CoRegister method is not registering the filter. Anyone run into this issue?

re: Using a MessageFilter to avoid IDE threading and timing issues.

cphilpot — Thu, 10 Feb 2011 14:54:18 GMT

I've recently implemented this solution and it seems to work. At first it did not work properly because the register was not being called on a STA thread. Although on a quick glance that doesn't appear to be a problem with Dhananjay's code.

I've implemented a couple changes that I would recommend reviewing. These are based on the use case of a user having a dialog open in the editor (e.g. filedialog is open).

1. Change the return value from 99 to 100 in IMessageFilter.RetryRejectedCall

- This prevents 100% CPU usage

2. Timeout after a period of time in IMessageFilter.RetryRejectedCall - e.g. if dwTickCount > 10000 //10 seconds then return -1

- If after 10 seconds of retrying an operation it's probably best to inform the user with a suitable message (maybe suggest closing any open dialogs)

re: Binding Redirects

max cleanse pro — Fri, 04 Feb 2011 11:03:59 GMT

The site is a custom ASP.net site (not bound to any particular cart) and I'd like to integrate seamlessly without having to redirect the user to a page off of my site.

http://maxcleansepro.net/

re: Using a MessageFilter to avoid IDE threading and timing issues.

Dhananjay — Thu, 02 Dec 2010 10:43:29 GMT

I have done same changes in my code, I mean implemented same 'IMessageFilter ' interface but still it gives the same error message 'The message filter indicated that the application is busy'.

I am not sure what is the exactly issue, Can you please help me to resolve the issue?

Here is my code

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web;

using System.Collections;

using Word = Microsoft.Office.Interop.Word;

using System.IO;

using System.Diagnostics;

using System.Configuration;

using System.Runtime.InteropServices;

using System.Threading;

namespace PsLiveDocX.WsHandler

{

public class AppendDocument

{

public AppendDocument()

{

}

string _FileExtension = ".doc";

[STAThread]

public AppendWordDocumentResult AppendWordDocument(AppendDocumentRequest requestCriteria)

{

AppendWordDocumentResult _result = new AppendWordDocumentResult();

try

{

MessageFilter.Register();

if (null != requestCriteria && null != requestCriteria.Documents)

{

PsDocument document = new PsDocument();

for (int i = 0; i < requestCriteria.Documents.Count; i++ )

{

document = requestCriteria.Documents[i];

if ("DOCX" == document.extension.ToUpper())

_FileExtension = ".docx";

document.binaryDataInBytes = Convert.FromBase64String(document.binaryData);

}

else

throw new Exception("Binary files are required.");

bool insertPageBreaks = requestCriteria.InsertPageBreaks;

string _no = DateTime.Now.ToString("s").Replace("-", "").Replace(":", "").Replace("T", "");

Random randon = new Random();

_no += randon.Next().ToString();

string outputFilename = string.Empty;

string _path = AppDomain.CurrentDomain.BaseDirectory + @"Documents\\";

if (!System.IO.Directory.Exists(_path))

System.IO.Directory.CreateDirectory(_path);

string _outputFile = "OutputFile_" + _no + _FileExtension;

outputFilename = _path + _outputFile;

byte[] _outputFileByteArray;

if (!AppendWordDoc(requestCriteria.Documents, outputFilename, insertPageBreaks, _path, out _outputFileByteArray, _result))

throw new Exception("Error while merging documents.");

else

{

_result.ResultInfo.IsSuccessful = true;

_result.OutputFileByteArray = Convert.ToBase64String(_outputFileByteArray);

}

catch (Exception ex)

{

MessageFilter.Revoke();

if (null == _result.ResultInfo)

_result.ResultInfo = new ResultStatus();

if (null == _result.ResultInfo.Messages)

_result.ResultInfo.Messages = new List<string>();

_result.ResultInfo.Messages.Add(ex.Message);

_result.ResultInfo.IsSuccessful = false;

}

MessageFilter.Revoke();

return _result;

}

private bool AppendWordDoc(List<PsDocument> psDocuments, string outputFilename, bool insertPageBreaks, string filePath, out byte[] outputFileByteArray, AppendWordDocumentResult _result)

{

List<string> filesToMerge = CreateFilesFromBinnaryData(psDocuments, filePath);

object _defaultTemplate = filePath + "DefaultTemplate.doc";

object _missing = System.Type.Missing;

object _pageBreak = Word.WdBreakType.wdPageBreak;

object _outputFile = outputFilename;

object _format = Microsoft.Office.Interop.Word.WdSaveFormat.wdFormatDocumentDefault;

foreach (System.Diagnostics.Process process in System.Diagnostics.Process.GetProcessesByName("WINWORD"))

{

if (process.StartTime.AddMinutes(Convert.ToInt32(System.Configuration.ConfigurationManager.AppSettings["WinWordExeDeleteTime"])) < DateTime.Now)

{

process.Kill();

}

// Create a new Word application

Word._Application _wordApplication = new Word.Application();

// Create a new file based on our template

Word._Document _wordDocument = _wordApplication.Documents.Add(ref _defaultTemplate

, ref _missing

, ref _missing);

_result.ResultInfo.Messages.Add("1");

try

{

// Make a Word selection object.

Word.Selection selection = _wordApplication.Selection;

// Loop thru each of the Word documents

foreach (string file in filesToMerge)

{

//_result.ResultInfo.Messages.Add(filePath + file);//

// Insert the files to our template

selection.InsertFile(filePath + file

, ref _missing

, ref _missing);

_result.ResultInfo.Messages.Add("2");

//Do we want page breaks added after each documents?

if (insertPageBreaks)

{

selection.InsertBreak(ref _pageBreak);

}

_result.ResultInfo.Messages.Add("3");

// Save the document to it's output file.

_wordDocument.SaveAs(ref _outputFile

, ref _format

, ref _missing

, ref _missing);

_result.ResultInfo.Messages.Add("4");

// Clean up!

_wordDocument.Close(ref _missing, ref _missing, ref _missing);

_result.ResultInfo.Messages.Add("5");

FileStream _fls = new FileStream(outputFilename, FileMode.Open, FileAccess.Read);

byte[] _blobDoc = new byte[_fls.Length];

_fls.Read(_blobDoc, 0, System.Convert.ToInt32(_fls.Length));

_fls.Close();

outputFileByteArray = _blobDoc;

_result.ResultInfo.Messages.Add("6");

}

catch (Exception ex)

{

MessageFilter.Revoke();

_result.ResultInfo.Messages.Add("7");

_result.ResultInfo.Messages.Add(ex.Message + ex.StackTrace);

throw ex;

}

finally

{

_result.ResultInfo.Messages.Add("8");

// Finally, Close our Word application

_wordApplication.Quit(ref _missing, ref _missing, ref _missing);

_wordDocument = null;

_wordApplication = null;

System.Threading.Thread.Sleep(500);

//Delete Temp files

//foreach (string file in filesToMerge)

//{

// if (File.Exists(filePath + file))

// File.Delete(filePath + file);

//}

//if (File.Exists(outputFilename))

// File.Delete(outputFilename);

_result.ResultInfo.Messages.Add("9");

}

return true;

}

private List<string> CreateFilesFromBinnaryData(List<PsDocument> psDocuments, string filePath)

{

List<string> _filesToMerge = new List<string>();

try

{

if (psDocuments != null && psDocuments.Count > 0)

{

for (int i = 0; i < psDocuments.Count; i++)

{

string _number = DateTime.Now.ToString("s").Replace("-", "").Replace(":", "").Replace("T", "");

Random randon = new Random();

_number += randon.Next().ToString();

string _fileName = _number + i.ToString() + "." + psDocuments[i].extension;

FileStream _streamWriter = new FileStream(filePath + _fileName, FileMode.Create);

_streamWriter.Write(psDocuments[i].binaryDataInBytes, 0, psDocuments[i].binaryDataInBytes.Length);

_streamWriter.Close();

_filesToMerge.Add(_fileName);

}

catch(Exception ex)

{

throw ex;

}

finally

{

}

return _filesToMerge;

}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web;

using System.Runtime.InteropServices;

using System.Runtime.CompilerServices;

namespace PsLiveDocX.WsHandler

{

[ComImport(), Guid("00000016-0000-0000-C000-000000000046"),

InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)]

public interface IMessageFilter

{

[PreserveSig]

int HandleInComingCall(int dwCallType, IntPtr hTaskCaller, int dwTickCount, IntPtr lpInterfaceInfo);

[PreserveSig]

int RetryRejectedCall(IntPtr hTaskCallee, int dwTickCount, int dwRejectType);

[PreserveSig]

int MessagePending(IntPtr hTaskCallee, int dwTickCount, int dwPendingType);

}

public class MessageFilter : IMessageFilter

{

// Class containing the IMessageFilter

// thread error-handling functions.

// Start the filter.

public static void Register()

{

IMessageFilter oldFilter = null;

IMessageFilter newFilter = new MessageFilter();

CoRegisterMessageFilter(newFilter, out oldFilter);

System.Threading.Thread.Sleep(2000);

}

// Done with the filter, close it.

public static void Revoke()

{

IMessageFilter oldFilter = null;

CoRegisterMessageFilter(null, out oldFilter);

}

// IMessageFilter functions.

// Handle incoming thread requests.

int IMessageFilter.HandleInComingCall(int dwCallType, System.IntPtr hTaskCaller, int dwTickCount, System.IntPtr lpInterfaceInfo)

{

//Return the flag SERVERCALL_ISHANDLED.

return 0;

}

// Thread call was rejected, so try again.

int IMessageFilter.RetryRejectedCall(System.IntPtr hTaskCallee, int dwTickCount, int dwRejectType)

{

if (dwRejectType == 2)

// flag = SERVERCALL_RETRYLATER.

{

// Retry the thread call immediately if return >=0 &

// <100.

return 99;

}

// Too busy; cancel call.

return -1;

}

int IMessageFilter.MessagePending(System.IntPtr hTaskCallee, int dwTickCount, int dwPendingType)

{

//Return the flag PENDINGMSG_WAITDEFPROCESS.

return 2;

}

// Implement the IMessageFilter interface.

[DllImport("Ole32.dll")]

private static extern int CoRegisterMessageFilter(IMessageFilter newFilter, out IMessageFilter oldFilter);

}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web;

using System.Xml.Serialization;

using Microsoft.Office.Interop.Word;

namespace PsLiveDocX.WsHandler

{

[Serializable]

public class ResultStatus

{

public ResultStatus()

{

this.Messages = new List<string>();

this.IsSuccessful = false;

}

public bool IsSuccessful;

public List<String> Messages;

public string TimeTakenInSecs;

}

public class Authentication

{

[XmlElement(IsNullable = true)]

public string Username;

[XmlElement(IsNullable = true)]

public string Password;

[XmlElement(IsNullable = false)]

public string IsSecure;

}

public class AppendDocumentRequest

{

public AppendDocumentRequest()

{

AuthInfo = new Authentication();

Documents = new List<PsDocument>();

InsertPageBreaks = false;

}

public Authentication AuthInfo;

public List<PsDocument> Documents;

public Boolean InsertPageBreaks;

}

public class PsDocument

{

public string binaryData;

public string extension;

internal byte[] binaryDataInBytes;

}

public class AppendWordDocumentResult

{

public AppendWordDocumentResult()

{

ResultInfo = new ResultStatus();

}

public ResultStatus ResultInfo;

public string OutputFileByteArray;

}

re: Application, HostID, Proxy, and EntryPoint Associations

Melody — Tue, 18 Nov 2008 21:31:19 GMT

Check out the sample that goes with this blog at www.summsoft.com/.../1470.aspx

re: Registering templates with the host application.

Gary — Tue, 04 Nov 2008 16:34:17 GMT

In step 3, make sure that only compressed project templates (.zip files) are in the sub directories.

To clean the slate, delete these registry hives before step 5:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VSTAHost\ShapeAppCSharp\9.0 (when vsta hostid setup by admin)

HKEY_CURRENT_USER\SOFTWARE\Microsoft\VSTAHost\ShapeAppCSharp\9.0 (when vsta hostid initial run by admin)

Here are the places afffected by 1. admin -- install and then by 2. admin -- vsta setup, then 3. by any user --vsta /host id initial run:

====

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VSTA\9.0 (when vsta installed by admin)

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VSTAHostConfig (when vsta integrated app installed by admin)

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VSTAHost\ShapeAppCSharp\9.0 (when vsta hostid setup by admin)

**HKEY_CURRENT_USER\SOFTWARE\Microsoft\VSTAHost\ShapeAppCSharp\9.0 (when vsta hostid initial run by admin)

C:\Documents and Settings\All Users\Application Data\Microsoft\VSTAHost\ShapeAppCSharp\9.0 (when vsta host id setup by admin)

C:\Documents and Settings\All Users\Application Data\Microsoft\VSTA\9.0 (when vsta host id setup by admin)

C:\Documents and Settings\<Name>\Application Data\Microsoft\VSTA\9.0 (when vsta host id initial run by <name>)

C:\Documents and Settings\<Name>\Application Data\Microsoft\VSTAHost\ShapeAppCSharp\9.0 (when vsta host id initial run by <name>)

re: HostItemProvider Item Templates Available

burakd — Fri, 28 Mar 2008 10:17:29 GMT

this is great thanks!!!

re: Non-proxiable Types: A Deeper Look

Gary — Fri, 11 Jan 2008 17:40:55 GMT

UI Extensibility across AppDomain is now possible with WinForms (http://blogs.msdn.com/clraddins/archive/2008/01/03/support-for-windows-forms-in-hosts-and-add-ins.aspx)

If, … you use the WindowsFormsHost and ElementHost classes to host WindowsForms controls in WPF you can logically pass them across the AppDomain boundary without actually doing so.

Stay tuned for a sample to show how this is done in VSTA 2.0

Frustrations with command-line add-ins for Visual Studio

Carlos Quintero's blog — Thu, 11 Oct 2007 15:52:25 GMT

Here is another frustration when working with the automation model of Visual Studio: suppose that you