WriteFileAsync Class

Namespace: devDept.Eyeshot.Translators
Assembly: devDept.Eyeshot.Control (in devDept.Eyeshot.Control.dll)
Base class for asynchronous file writing.
VB
C#
F#
C++
JScript
Copy 
Public MustInherit Class WriteFileAsync 
    Inherits WorkUnit
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
public abstract class WriteFileAsync : WorkUnit
This language is not supported or no code example is available.
Constructors
 
Name Description
Protected constructor WriteFileAsync(Environment, Stream, bool) Obsolete. Standard constructor with stream.
Protected constructor WriteFileAsync(Environment, string, bool) Obsolete. Standard constructor.
Protected constructor WriteFileAsync(IList<Entity>, IEnumerable<Layer>, IDictionary<StringBlock>, Stream) Obsolete. To stream with entity list constructor.
Protected constructor WriteFileAsync(IList<Entity>, IEnumerable<Layer>, IDictionary<StringBlock>, string) Obsolete. Entity list constructor.
Protected constructor WriteFileAsync(WriteParams, Stream) Standard constructor with Document and stream.
Protected constructor WriteFileAsync(WriteParams, string) Standard constructor with Document and filename.
Protected constructor WriteFileAsync(string, bool) For internal use only.
Top
Properties
 
Name Description
Public property Angle Gets or sets the maximum angular deflection in radians, ignored when zero.
Public property ComposingBlocksText Gets or sets the "Composing blocks..." text string.
Public property ComposingEntitiesText Gets or sets the "Composing entities..." text string.
Public property ComposingText Gets or sets the "Composing..." text string.
Public property Deviation Gets or sets the maximum deviation, zero for current tessellation.
Public property ExecutionTime Gets the (last) work execution time in milliseconds. (inherited from WorkUnit).
Public property FileName The name of the file that will be created.
Public property Log Gets the list of errors and warnings generated during execution. (inherited from WorkUnit).
Public property Status Gets the WorkUnit status. (inherited from WorkUnit).
Public property Stream The stream for writing.
Public property WritingText Gets or sets the "Writing..." text string.
Top
Methods
 
Name Description
Internal protected (Protected Friend) method Cancelled(BackgroundWorker, DoWorkEventArgs) Checks if the user has requested cancellation of the background operation. (inherited from WorkUnit).
Internal protected (Protected Friend) method CloseStream()
Protected method ComputeBoundingBox(out Point3D, out Point3D) Compute scene extents.
Internal protected (Protected Friend) method DoWork(BackgroundWorker, DoWorkEventArgs) Does the actual work allowing progress bar update and cancellation. (inherited from WorkUnit).
Public method DoWork() Executes the work synchronously. (inherited from WorkUnit).
Public method Equals(Object) Determines whether the specified object is equal to the current object. (inherited from Object).
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object).
Protected method GetEntities() For internal use only.
Public method GetHashCode Serves as the default hash function. (inherited from Object).
Public method GetType Gets the Type of the current instance. (inherited from Object).
Protected method InitLayers(LayerKeyedCollection) Initializes the layers collection with only the exportable ones.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object).
Protected method Static RemoveInvalidChars(string) Removes forbidden chars from a string representing a file path.
Internal protected (Protected Friend) method ResetProgressParallel(int) Resets the progress bar for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method SetWriter(IDisposable)
Internal protected (Protected Friend) method StartContinuousAnimation(string, BackgroundWorker, params string[]) Start the animation for the continuous progress bar. (inherited from WorkUnit).
Internal protected (Protected Friend) method StopContinuousAnimation(BackgroundWorker) Stop the animation for the continuous progress bar. (inherited from WorkUnit).
Protected method SynchronizeAttributeReference(BlockKeyedCollection, IList<Entity>) Helper method to synchronize all the attribute reference before writing the file.
Protected method SynchronizeAttributeReference(Environment) Helper method to synchronize all the attribute reference before writing the file.
Public method ToString Returns a string that represents the current object. (inherited from Object).
Internal protected (Protected Friend) method UpdateProgress(double, double, string, BackgroundWorker, bool, params string[]) Updates the progress bar value. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgress(int, int, string, BackgroundWorker, bool, params string[]) Updates the progress bar value. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressAndCheckCancelled(int, int, string, BackgroundWorker, DoWorkEventArgs, bool, params string[]) Updates the progress bar value and checks if the worker thread has been canceled. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressAndCheckCancelledParallel(int, string, BackgroundWorker, DoWorkEventArgs, params string[]) Updates the progress bar value and checks if the worker thread has been canceled, for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressParallel(double, string, BackgroundWorker, params string[]) Updates the progress bar value for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressTo100(string, BackgroundWorker, params string[]) Set the progress bar to 100% and forces screen update. (inherited from WorkUnit).
Internal protected (Protected Friend) method WorkCancelled(Environment) Called when the work is cancelled.
Internal protected (Protected Friend) method WorkCompleted(Environment) Called when the work has completed. In the case you are modeling something, the environment parameter allows you to easily add the model to the entities collection. (inherited from WorkUnit).
Internal protected (Protected Friend) method WorkFailed(Environment) Called when the work has failed. (inherited from WorkUnit).
Top
Events
 
Name Description
Public event ProgressChanged Occurs when the DoWork() is called synchronously and the progress has changed. (inherited from WorkUnit).
Top
Fields
 
Name Description
Protected field blocks
Protected field entities
Protected field layers
Internal protected (Protected Friend) field log (inherited from WorkUnit).
Protected field selectedOnly When true only the selected entities will be written.
Protected field writeFileCloseStream True when the constructors with filename is used, otherwise false.
Top
Inheritance Hierarchy
 
Applies to
 

.NET Framework

Supported in: 4.8
See Also
 

In this article

Definition