This documentation is for the old version. Go to the latest Graphics Mill docs

CustomFormatWriter Members

The CustomFormatWriter type exposes the following members.


Name Description
Public method {dtor}

Enables using delete operator in C++ applications. It is strongly not recommended to use it directly.

Public method Abort

Aborts file writing operation.

(Inherited from FormatWriter.)
Public method AddFrame

Appends specified frame to the end of file (or other media).

(Inherited from FormatWriter.)
Public method Close

Closes format writer, flushes all unsaved data, and detaches the writer from previously opened file (or other media).

(Inherited from FormatWriter.)
Protected method CloseWriter

Closes the format writer, and detaches it from a previously opened file (or other media).

Public method Continue

Resumes execution of the operation previously paused with Pause() method.

(Inherited from FormatWriter.)
Public method Dispose

Releases all resources used by this FormatWriter.

(Inherited from FormatWriter.)
Public method Equals (Inherited from Object.)
Public method ExportEncoderOptions Overloaded.

Exports all writer settings into the encoder options object.

Protected method GetClosestPixelFormat

Get a pixel format supported by this writer closest to the specified one.

Public method GetEmptyFrame

Returns Frame descendant class of the format supported with this writer.

(Inherited from FormatWriter.)
Public method GetHashCode (Inherited from Object.)
Protected method GetStream

Returns the stream associated with the currently opened writer.

Protected method GetSupportedPixelFormats

Returns an array of supported pixel formats.

Public method GetType (Inherited from Object.)
Protected method GetWrittenFrameCount

Returns the number of frames that are already written to a file or stream.

Public method ImportEncoderOptions

Initialize the writer settings from the encoder options object.

(Inherited from FormatWriter.)
Public method IsPixelFormatSupported

Checks if the provided pixel format is supported.

(Overrides FormatWriter.IsPixelFormatSupported(PixelFormat).)
Public method Lock

Locks the object.

(Inherited from SyncHandler.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnExportEncoderOptions

Exports encoder options.

(Inherited from FormatWriter.)
Protected method OnImportEncoderOptions

Imports encoder options.

(Inherited from FormatWriter.)
Public method Open Overloaded.

Opens format writer.

Protected method OpenWriter Overloaded.

Opens the writer.

Public method Pause

Pauses execution of the file writing operation.

(Inherited from FormatWriter.)
Protected method ResetEvents

Initializes a progress state while writing a bitmap.

Protected method SaveFrameBitmap

Write the specified bitmap to a file at current position.

Protected method SaveFrameParameters

Extracts the current frame settings before saving the bitmap into the file.

Protected method SetDefaultExtension

Sets the default extension of files opened using this codec.

Protected method SetFilterString

Sets the filter string for the Save file dialog.

Protected method SetFormatDescription

Sets the description of the codec.

Protected method SetFormatName

Sets the name of the codec.

Protected method SetMediaFormat

Sets the unique media format for the codec.

Protected method SetMimeType

Sets the MIME type of the files that can be saved with the codec.

Public method ToString (Inherited from Object.)
Public method Unlock

Unlocks the object previously locked with method Lock().

(Inherited from SyncHandler.)
Protected method UpdateEvents Overloaded.

Updates the progress state while writing a bitmap.

Public method WaitForCompletion

Suspends the calling thread until the operation currently run is completed.

(Inherited from SyncHandler.)


Name Description
Public property CodecPriority

Returns the priority of the codec.

(Inherited from FormatWriter.)
Public property Completed

Returns value indicating if the operation is currently running.

(Inherited from SyncHandler.)
Public property DefaultExtension

Returns default extension for this format.

(Inherited from FormatWriter.)
Public property ExceptionThrowEnabled

Gets/sets value that specifies if to throw exception in synchronous mode.

(Inherited from SyncHandler.)
Public property FilterString

Returns filter string for this format.

(Inherited from FormatWriter.)
Public property FormatDescription

Returns user-friendly format description.

(Inherited from FormatWriter.)
Public property FormatName

Returns format name.

(Inherited from FormatWriter.)
Public property Locked

Indicates if the object has been locked.

(Inherited from SyncHandler.)
Public property MediaFormat

Returns the ID of the media format this reader can write to.

(Inherited from FormatWriter.)
Public property MimeType

Returns mime type of the format.

(Inherited from FormatWriter.)
Public property Opened

Returns value that specifies if the writer is opened.

(Inherited from FormatWriter.)
Public property Priority

Gets/sets a priority for the auxilary thread.

(Inherited from SyncHandler.)
Public property SupportedPixelFormats

Returns an array of pixel formats which are supported with this format writer.

(Inherited from FormatWriter.)
Public property SynchronizationMode

Gets/sets synchronization mode for the object.

(Inherited from SyncHandler.)
Public property Timeout

Gets/sets value specifying maximum time for which object can be locked.

(Inherited from SyncHandler.)


Name Description
Public event Aborted

Fires when operation has been aborted.

(Inherited from SyncHandler.)
Public event Continued

Fires when operation has been resumed with Continue() method.

(Inherited from SyncHandler.)
Public event Paused

Fires when operation has been paused with Pause() method.

(Inherited from SyncHandler.)
Protected event Progress

Fires on the operation progress notifications.

(Inherited from SyncHandler.)
Public event Started

Fires after operation has been started.

(Inherited from SyncHandler.)
Public event Starting

Fires before operation is started.

(Inherited from SyncHandler.)
Public event Stopped

Fires after operation has been stopped.

(Inherited from SyncHandler.)
Public event Stopping

Fires before operation is stopped.

(Inherited from SyncHandler.)

See Also