| Framework1ExternalPreviewException Class |
This exception is thrown by the TTX filter framework 1 preview writer adapter (TtxPreviewNativeWriter) when
a FF 1 filter has successfully generated an external preview, which it will manage itself
(as opposed to the preview that is managed by a preview application or preview control).
Inheritance HierarchySystemObject
SystemException
Sdl.FileTypeSupport.Framework.Core.Utilities.IntegrationApiFramework1ExternalPreviewException
SystemException
Sdl.FileTypeSupport.Framework.Core.Utilities.IntegrationApiFramework1ExternalPreviewException
Namespace: Sdl.FileTypeSupport.Framework.Core.Utilities.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core.Utilities (in Sdl.FileTypeSupport.Framework.Core.Utilities.dll) Version: 1.0.0.0 (1.0.2551.0)
SyntaxThe Framework1ExternalPreviewException type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Framework1ExternalPreviewException |
Create without message - default usage
|
| Framework1ExternalPreviewException(String) |
Create with an explicit message.
|
 | Framework1ExternalPreviewException(SerializationInfo, StreamingContext) |
Protected constructor used for de-serialization.
|
| Framework1ExternalPreviewException(String, Exception) |
Create with a message and related exception.
|
Properties| Name | Description | |
|---|---|---|
 | Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
| HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception.) |
| HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.) |
| InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception.) |
| Message | Gets a message that describes the current exception. (Inherited from Exception.) |
| Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.) |
| StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.) |
| TargetSite | Gets the method that throws the current exception. (Inherited from Exception.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBaseException | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData | When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.) |
| GetType | Gets the runtime type of the current instance. (Inherited from Exception.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Creates and returns a string representation of the current exception. (Inherited from Exception.) |
Events| Name | Description | |
|---|---|---|
 | SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.) |
RemarksExplicitly handling this exception allows a preview host application to be notified that the preview has been successfully generated, but should be treated as a "fire and forget" preview. The preview files typically are not the file names that are passed to the writer, and they will be automatically deleted when the external preview application is closed by the user.
Note that throwing an exception here is rather a hack, however for the moment no a better way of handling this situation is available.
See AlsoCommunityComments