ExportErrorEventArgs Class

Article
11/24/2013

Represents the arguments for the ExportErrorEventArgs class.

Inheritance Hierarchy

System.Object
System.EventArgs
Microsoft.VisualStudio.Modeling.Shell.ExportErrorEventArgs

Namespace: Microsoft.VisualStudio.Modeling.Shell
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
Public Class ExportErrorEventArgs _
    Inherits EventArgs

public class ExportErrorEventArgs : EventArgs

public ref class ExportErrorEventArgs : public EventArgs

type ExportErrorEventArgs =  
    class 
        inherit EventArgs 
    end

public class ExportErrorEventArgs extends EventArgs

The ExportErrorEventArgs type exposes the following members.

Constructors

	Name	Description
	ExportErrorEventArgs(Int32, String)	Initializes a new instance of the ExportErrorEventArgs class.
	ExportErrorEventArgs(Int32, String, Exception)	Initializes a new instance of the ExportErrorEventArgs class.

Top

Properties

	Name	Description
	Continue	Gets and sets continueExporting, which determines whether the current operation should continue to export diagrams if an error occurs.
	ErrorMessage	Gets the error message for the error.
	Exception	Gets the error that occurred when the current diagram was being exported.
	ExportedDiagramsCount	Gets the number of diagrams that were exported before the error occurred.
	ProjectFile	Gets the file name of the diagram that was being exported when the error occurred.

Top

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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

You use this class with the DiagramExporter class, which exports diagrams to disk as images. ExportErrorEvent calls this class. You can provide an event callback to DiagramExporter so that when an error occurs, the event is raised with this ExportErrorEventArgs object.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via