---
title: "CustomFormatWriter Members"
canonical: https://www.graphicsmill.com/docs/gm5/AllMembers_T_Aurigma_GraphicsMill_Codecs_CustomFormatWriter.htm
product: "Graphics Mill 5.5 for .NET"
---
This documentation is for the old version. [Go to the latest Graphics Mill docs](https://www.graphicsmill.com/docs/gm/)
# CustomFormatWriter Members
The [CustomFormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_CustomFormatWriter.htm.md) type exposes the following members.
## Methods
| | Name | Description |
| --- | --- | --- |
|  | [{dtor}](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_%7Bdtor%7D.htm.md) | Enables using delete operator in C++ applications. It is strongly not recommended to use it directly. |
|  | [Abort](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_Abort.htm.md) | Aborts file writing operation.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [AddFrame](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_AddFrame_1_7fae152b.htm.md) | Appends specified frame to the end of file (or other media).
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [Close](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_Close.htm.md) | Closes format writer, flushes all unsaved data, and detaches the writer from previously opened file (or other media).
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [CloseWriter](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_CloseWriter.htm.md) | Closes the format writer, and detaches it from a previously opened file (or other media). |
|  | [Continue](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_Continue.htm.md) | Resumes execution of the operation previously paused with [Pause()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_Pause.htm.md) method.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [Dispose](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_Dispose.htm.md) | Releases all resources used by this [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [Equals](http://msdn2.microsoft.com/en-us/bsc2ak47) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [ExportEncoderOptions](https://www.graphicsmill.com/docs/gm5/O_T_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_ExportEncoderOptions.htm.md) | Overloaded.
Exports all writer settings into the encoder options object. |
|  | [GetClosestPixelFormat](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_GetClosestPixelFormat_1_3e209c07.htm.md) | Get a pixel format supported by this writer closest to the specified one. |
|  | [GetEmptyFrame](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_GetEmptyFrame.htm.md) | Returns [Frame](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_Frame.htm.md) descendant class of the format supported with this writer.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [GetHashCode](http://msdn2.microsoft.com/en-us/zdee4b3y) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [GetStream](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_GetStream.htm.md) | Returns the stream associated with the currently opened writer. |
|  | [GetSupportedPixelFormats](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_GetSupportedPixelFormats.htm.md) | Returns an array of supported pixel formats. |
|  | [GetType](http://msdn2.microsoft.com/en-us/dfwy45w9) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [GetWrittenFrameCount](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_GetWrittenFrameCount.htm.md) | Returns the number of frames that are already written to a file or stream. |
|  | [ImportEncoderOptions](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_ImportEncoderOptions_1_fae7ea50.htm.md) | Initialize the writer settings from the encoder options object.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [IsPixelFormatSupported](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_IsPixelFormatSupported_1_3e209c07.htm.md) | Checks if the provided pixel format is supported.
(Overrides [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).[IsPixelFormatSupported(PixelFormat)](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_IsPixelFormatSupported_1_3e209c07.htm.md).) |
|  | [Lock](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Lock.htm.md) | Locks the object.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [MemberwiseClone](http://msdn2.microsoft.com/en-us/57ctke0a) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [OnExportEncoderOptions](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_OnExportEncoderOptions_1_fae7ea50.htm.md) | Exports encoder options.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [OnImportEncoderOptions](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_OnImportEncoderOptions_1_fae7ea50.htm.md) | Imports encoder options.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [Open](https://www.graphicsmill.com/docs/gm5/O_T_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_Open.htm.md) | Overloaded.
Opens format writer. |
|  | [OpenWriter](https://www.graphicsmill.com/docs/gm5/O_T_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_OpenWriter.htm.md) | Overloaded.
Opens the writer. |
|  | [Pause](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatWriter_Pause.htm.md) | Pauses execution of the file writing operation.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [ResetEvents](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_ResetEvents_1_e1836fc4.htm.md) | Initializes a progress state while writing a bitmap. |
|  | [SaveFrameBitmap](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_SaveFrameBitmap_1_fd4033ef.htm.md) | Write the specified bitmap to a file at current position. |
|  | [SaveFrameParameters](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_SaveFrameParameters_1_f2ca33e0.htm.md) | Extracts the current frame settings before saving the bitmap into the file. |
|  | [SetDefaultExtension](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_SetDefaultExtension_1_bb3a7a4f.htm.md) | Sets the default extension of files opened using this codec. |
|  | [SetFilterString](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_SetFilterString_1_bb3a7a4f.htm.md) | Sets the filter string for the **Save file** dialog. |
|  | [SetFormatDescription](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_SetFormatDescription_1_bb3a7a4f.htm.md) | Sets the description of the codec. |
|  | [SetFormatName](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_SetFormatName_1_bb3a7a4f.htm.md) | Sets the name of the codec. |
|  | [SetMediaFormat](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_SetMediaFormat_1_5f4f955f.htm.md) | Sets the unique media format for the codec. |
|  | [SetMimeType](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_SetMimeType_1_bb3a7a4f.htm.md) | Sets the MIME type of the files that can be saved with the codec. |
|  | [ToString](http://msdn2.microsoft.com/en-us/7bxwbwt2) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [Unlock](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Unlock.htm.md) | Unlocks the object previously locked with method [Lock()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Lock.htm.md).
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [UpdateEvents](https://www.graphicsmill.com/docs/gm5/O_T_Aurigma_GraphicsMill_Codecs_CustomFormatWriter_UpdateEvents.htm.md) | Overloaded.
Updates the progress state while writing a bitmap. |
|  | [WaitForCompletion](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_WaitForCompletion.htm.md) | Suspends the calling thread until the operation currently run is completed.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
## Properties
| | Name | Description |
| --- | --- | --- |
|  | [CodecPriority](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_CodecPriority.htm.md) | Returns the priority of the codec.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [Completed](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_SyncHandler_Completed.htm.md) | Returns value indicating if the operation is currently running.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [DefaultExtension](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_DefaultExtension.htm.md) | Returns default extension for this format.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [ExceptionThrowEnabled](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_SyncHandler_ExceptionThrowEnabled.htm.md) | Gets/sets value that specifies if to throw exception in synchronous mode.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [FilterString](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_FilterString.htm.md) | Returns filter string for this format.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [FormatDescription](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_FormatDescription.htm.md) | Returns user-friendly format description.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [FormatName](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_FormatName.htm.md) | Returns format name.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [Locked](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_SyncHandler_Locked.htm.md) | Indicates if the object has been locked.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [MediaFormat](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_MediaFormat.htm.md) | Returns the ID of the media format this reader can write to.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [MimeType](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_MimeType.htm.md) | Returns mime type of the format.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [Opened](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_Opened.htm.md) | Returns value that specifies if the writer is opened.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [Priority](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_SyncHandler_Priority.htm.md) | Gets/sets a priority for the auxilary thread.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [SupportedPixelFormats](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_Codecs_FormatWriter_SupportedPixelFormats.htm.md) | Returns an array of pixel formats which are supported with this format writer.
(Inherited from [FormatWriter](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatWriter.htm.md).) |
|  | [SynchronizationMode](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_SyncHandler_SynchronizationMode.htm.md) | Gets/sets synchronization mode for the object.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Timeout](https://www.graphicsmill.com/docs/gm5/P_Aurigma_GraphicsMill_SyncHandler_Timeout.htm.md) | Gets/sets value specifying maximum time for which object can be locked.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
## Events
| | Name | Description |
| --- | --- | --- |
|  | [Aborted](https://www.graphicsmill.com/docs/gm5/E_Aurigma_GraphicsMill_SyncHandler_Aborted.htm.md) | Fires when operation has been aborted.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Continued](https://www.graphicsmill.com/docs/gm5/E_Aurigma_GraphicsMill_SyncHandler_Continued.htm.md) | Fires when operation has been resumed with [Continue()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Continue.htm.md) method.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Paused](https://www.graphicsmill.com/docs/gm5/E_Aurigma_GraphicsMill_SyncHandler_Paused.htm.md) | Fires when operation has been paused with [Pause()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Pause.htm.md) method.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Progress](https://www.graphicsmill.com/docs/gm5/E_Aurigma_GraphicsMill_SyncHandler_Progress.htm.md) | Fires on the operation progress notifications.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Started](https://www.graphicsmill.com/docs/gm5/E_Aurigma_GraphicsMill_SyncHandler_Started.htm.md) | Fires after operation has been started.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Starting](https://www.graphicsmill.com/docs/gm5/E_Aurigma_GraphicsMill_SyncHandler_Starting.htm.md) | Fires before operation is started.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Stopped](https://www.graphicsmill.com/docs/gm5/E_Aurigma_GraphicsMill_SyncHandler_Stopped.htm.md) | Fires after operation has been stopped.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Stopping](https://www.graphicsmill.com/docs/gm5/E_Aurigma_GraphicsMill_SyncHandler_Stopping.htm.md) | Fires before operation is stopped.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
## See Also
### Reference
- [CustomFormatWriter Class](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_CustomFormatWriter.htm.md)
- [Aurigma.GraphicsMill.Codecs Namespace](https://www.graphicsmill.com/docs/gm5/N_Aurigma_GraphicsMill_Codecs.htm.md)