/// <summary>
/// Get exception message based on associated settings
/// </summary>
/// <param name="throwedException">exception as any</param>
/// <param name="instance">caller instance</param>
/// <param name="name"></param>
/// <param name="type">name of invoke target</param>
/// <param name="versionHandler">optional version providers for application instances</param>
/// <param name="arguments">arguments as any</param>
/// <param name="valuePropertySet">additional value if its an indexed property set</param>
/// <returns>exception message</returns>
internal static string GetExceptionMessage(Exception throwedException, object instance, string name, CallType type, CoreServices.Internal.ApplicationVersionHandler versionHandler, object[] arguments = null, object valuePropertySet = null)
{
if (null == throwedException)
{
throw new ArgumentNullException("throwedException", "<Please report this error.>");
}
arguments = ValidateArgumentArray(arguments, valuePropertySet);
ICOMObject comObject = instance as ICOMObject;
if (null == comObject)
{
return(Settings.Default.ExceptionDefaultMessage);
}
Settings settings = comObject.Settings;
switch (comObject.Settings.ExceptionMessageBehavior)
{
case ExceptionMessageHandling.Diagnostics:
return(GetExceptionDiagnosticsMessage(comObject, name, type, versionHandler, arguments));
case ExceptionMessageHandling.Default:
return(settings.ExceptionDefaultMessage);
case ExceptionMessageHandling.CopyInnerExceptionMessageToTopLevelException:
return(GetExceptionInnerExceptionMessageToTopLevelMessage(throwedException));
case ExceptionMessageHandling.CopyAllInnerExceptionMessagesToTopLevelException:
return(GetExceptionAllInnerExceptionMessagesToTopLevelMessage(throwedException));
case ExceptionMessageHandling.DiagnosticsAndInnerMessage:
return(GetExceptionDiagnosticsInnerMessage(throwedException, comObject, name, type, versionHandler, arguments));
default:
throw new NetOfficeException("<Unexpected exception behavior. Please report this error.>");
}
}
/// <summary>
/// Get diagnostic exception message and most inner exception message
/// </summary>
/// <param name="throwedException">exception as any</param>
/// <param name="comObject">caller instance</param>
/// <param name="name">name of invoke target</param>
/// <param name="type">type of invoke target</param>
/// <param name="versionHandler">optional version providers for application instances</param>
/// <param name="arguments">arguments as any</param>
/// <returns>diagnostic exception message or error message if an exception occurs</returns>
private static string GetExceptionDiagnosticsInnerMessage(Exception throwedException, ICOMObject comObject, string name, CallType type, CoreServices.Internal.ApplicationVersionHandler versionHandler, object[] arguments = null)
{
string diagMessage = GetExceptionDiagnosticsMessage(comObject, name, type, versionHandler, arguments);
string message = throwedException.Message;
while (throwedException.InnerException != null)
{
message = throwedException.InnerException.Message;
throwedException = throwedException.InnerException;
}
return(diagMessage + "{" + message + "}");
}
/// <summary>
/// Get diagnostic exception message
/// </summary>
/// <param name="comObject">caller instance</param>
/// <param name="name">name of invoke target</param>
/// <param name="type">type of invoke target</param>
/// <param name="versionHandler">optional version providers for application instances</param>
/// <param name="arguments">arguments as any</param>
/// <returns>diagnostic exception message or error message if an exception occurs</returns>
private static string GetExceptionDiagnosticsMessage(ICOMObject comObject, string name, CallType type, CoreServices.Internal.ApplicationVersionHandler versionHandler, object[] arguments = null)
{
try
{
Settings settings = comObject.Settings;
string diagMessage = settings.ExceptionDiagnosticsMessage;
if (String.IsNullOrWhiteSpace(diagMessage))
{
return(diagMessage);
}
if (diagMessage.Contains("{ApplicationVersions}") || diagMessage.Contains("{NlApplicationVersions}"))
{
if (null != versionHandler)
{
string versionString = String.Empty;
foreach (var item in versionHandler.ThreadSafeEnumerable())
{
if (!item.VersionRequested)
{
item.TryRequestVersion();
}
object version = item.Version;
if (null != version)
{
versionString += item.Name + " " + version.ToString() + ";";
}
}
if (versionString != String.Empty)
{
if (diagMessage.Contains("{ApplicationVersions}"))
{
diagMessage = diagMessage.Replace("{ApplicationVersions}", "Application Versions:" + versionString);
}
else
{
diagMessage = diagMessage.Replace("{NlApplicationVersions}", Environment.NewLine + "Application Versions:" + versionString);
}
}
else
{
diagMessage = diagMessage.Replace("{ApplicationVersions}", String.Empty);
diagMessage = diagMessage.Replace("{NlApplicationVersions}", String.Empty);
}
}
else
{
diagMessage = diagMessage.Replace("{ApplicationVersions}", String.Empty);
diagMessage = diagMessage.Replace("{NlApplicationVersions}", String.Empty);
}
}
diagMessage = diagMessage.Replace("{CallType}", type.ToString());
diagMessage = diagMessage.Replace("{CallInstance}", comObject.InstanceFriendlyName);
diagMessage = diagMessage.Replace("{Name}", name);
if (diagMessage.IndexOf("{Args}") > -1 || diagMessage.IndexOf("{ParenthesizedArgs}") > -1)
{
string argsString = String.Empty;
if (null != arguments && arguments.Length > 0)
{
for (int i = 0; i < arguments.Length; i++)
{
object arg = arguments[i];
if (null != arg)
{
if (arg == Type.Missing)
{
argsString += "<Type.Missing>";
}
else
{
ICOMObject comObjectArg = arg as ICOMObject;
if (null != comObjectArg)
{
argsString += comObjectArg.InstanceFriendlyName;
}
else if (arg is MarshalByRefObject)
{
argsString += TryGetProxyClassName(arg);
}
else
{
argsString += arg.ToString();
}
}
}
else
{
argsString += "<null>";
}
if (i < arguments.Length - 1)
{
argsString += ", ";
}
}
}
diagMessage = diagMessage.Replace("{NewLine}", Environment.NewLine);
diagMessage = diagMessage.Replace("{Args}", argsString);
diagMessage = diagMessage.Replace("{ParenthesizedArgs}", argsString != String.Empty ? "(" + argsString + ")" : "");
}
return(diagMessage);
}
catch
{
return("<Failed to create exception message. Please report this error.>");
}
}
